BradBot_1/GiteaForwarder
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

CHORE: update readme to reflect changes

Browse source
This commit is contained in:
BradBot_1 2023-02-23 23:10:06 +00:00
parent b1facb1cba
commit 27ec51a3ee
1 changed files with 16 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -36,6 +36,15 @@ The password for the SSL certification, no default
Environment version of [data.json](https://git.bb1.fun/BradBot_1/GiteaForwarder/src/branch/master/data.json), no default Environment version of [data.json](https://git.bb1.fun/BradBot_1/GiteaForwarder/src/branch/master/data.json), no default
### `README_NAME`
The name of the user that will commit the readme changes (if enabled), defaults to GiteaForwarder
### `README_EMAIL`
The email of the user that will commit the readme changes (if enabled), defaults to donotreply@bb1.fun
## Examples ## Examples
### Docker run ### Docker run
@ -43,13 +52,13 @@ Environment version of [data.json](https://git.bb1.fun/BradBot_1/GiteaForwarder/
#### With an environment variable #### With an environment variable
```shell ```shell
docker run --name forwarder -e PORT=80 -e DATA='[{"origin":"https://git.example.com/user/repo","recipients":[{"modifyReadme":true,"url":"https://gitlab.com/user/repo","authors":[{"old":"user@example.com","email":"00000000+user@users.noreply.github.com","name":"user"}]}]}]' -p 80:80 -d bradbot1/gitea-forwarder docker run --name forwarder -e PORT=80 -e README_NAME=GiteaForwarder -e README_EMAIL=donotreply@bb1.fun -e DATA='[{"origin":"https://git.example.com/user/repo","recipients":[{"modifyReadme":true,"url":"https://gitlab.com/user/repo","authors":[{"old":"user@example.com","email":"00000000+user@users.noreply.github.com","name":"user"}]}]}]' -p 80:80 -d bradbot1/gitea-forwarder
``` ```
#### With a volume mount (preffered) #### With a volume mount (preffered)
```shell ```shell
docker run --name forwarder -e PORT=80 -v ./data.json:./data.json -p 80:80 -d bradbot1/gitea-forwarder docker run --name forwarder -e PORT=80 -e README_NAME=GiteaForwarder -e README_EMAIL=donotreply@bb1.fun -v ./data.json:./data.json -p 80:80 -d bradbot1/gitea-forwarder
``` ```
You can find an example of [data.json here](https://git.bb1.fun/BradBot_1/GiteaForwarder/src/branch/master/data.json) You can find an example of [data.json here](https://git.bb1.fun/BradBot_1/GiteaForwarder/src/branch/master/data.json)
@ -69,6 +78,8 @@ services:
environment: environment:
PORT: 80 PORT: 80
DATA: '[{"origin":"https://git.example.com/user/repo","recipients":[{"url":"https://gitlab.com/user/repo","authors":[{"old":"user@example.com","email":"00000000+user@users.noreply.github.com","name":"user"}]}]}]' DATA: '[{"origin":"https://git.example.com/user/repo","recipients":[{"url":"https://gitlab.com/user/repo","authors":[{"old":"user@example.com","email":"00000000+user@users.noreply.github.com","name":"user"}]}]}]'
README_NAME: GiteaForwarder
README_EMAIL: donotreply@bb1.fun
``` ```
#### With a volume mount (preffered) #### With a volume mount (preffered)
@ -78,11 +89,14 @@ version: '3'
services: services:
forwarder: forwarder:
build: .
image: bradbot1/gitea-forwarder image: bradbot1/gitea-forwarder
ports: ports:
- '80:80' - '80:80'
environment: environment:
PORT: 80 PORT: 80
README_NAME: GiteaForwarder
README_EMAIL: donotreply@bb1.fun
volumes: volumes:
- ./data.json:./data.json - ./data.json:./data.json
``` ```