denyskon/teabag
1
0
Fork 0
mirror of https://github.com/denyskon/teabag synced 2024-11-24 23:10:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs simplifications

Browse Source
This commit is contained in:
Denys Konovalov 2023-05-07 11:25:11 +02:00
parent 9fdbbce5ea
commit a4052850a1
3 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -34,12 +34,14 @@ services:
- TEABAG_GITEA_BASE_URL=https://gitea.company.com - TEABAG_GITEA_BASE_URL=https://gitea.company.com
- TEABAG_GITEA_AUTH_URI=login/oauth/authorize - TEABAG_GITEA_AUTH_URI=login/oauth/authorize
- TEABAG_GITEA_TOKEN_URI=login/oauth/access_token - TEABAG_GITEA_TOKEN_URI=login/oauth/access_token
- TEABAG_GITEA_USER_URI=api/v1/user - TEABAG_GITEA_USER_URI=login/oauth/userinfo
- TEABAG_CALLBACK_URI=http://oauth.example.com:3000/callback - TEABAG_CALLBACK_URI=https://oauth.example.com/callback
ports: ports:
- "3000:3000" - "3000:3000"
``` ```
**It is stronly recommended not to transfer credentials over http. Please use a reverse proxy infront of teabag.**
## Config ## Config
The service needs some minimal configuration set before it can run. The service needs some minimal configuration set before it can run.
@ -72,7 +74,7 @@ GITEA_BASE_URL=https://gitea.example.com
# endpoint URIs (see https://docs.gitea.com/development/oauth2-provider/) # endpoint URIs (see https://docs.gitea.com/development/oauth2-provider/)
GITEA_AUTH_URI=login/oauth/authorize GITEA_AUTH_URI=login/oauth/authorize
GITEA_TOKEN_URI=login/oauth/access_token GITEA_TOKEN_URI=login/oauth/access_token
GITEA_USER_URI=api/v1/user GITEA_USER_URI=login/oauth/userinfo
# callback URL, where users will be redirected after they authorise. Must contain the public URL of your teabag instance. This needs to match what was given when creating the OAuth application in Gitea. # callback URL, where users will be redirected after they authorise. Must contain the public URL of your teabag instance. This needs to match what was given when creating the OAuth application in Gitea.
CALLBACK_URI=http://localhost:3000/callback CALLBACK_URI=http://localhost:3000/callback
``` ```

4
docker-compose.yml
View File

@ -11,7 +11,7 @@ services:
- TEABAG_GITEA_BASE_URL=https://gitea.company.com - TEABAG_GITEA_BASE_URL=https://gitea.company.com
- TEABAG_GITEA_AUTH_URI=login/oauth/authorize - TEABAG_GITEA_AUTH_URI=login/oauth/authorize
- TEABAG_GITEA_TOKEN_URI=login/oauth/access_token - TEABAG_GITEA_TOKEN_URI=login/oauth/access_token
- TEABAG_GITEA_USER_URI=api/v1/user - TEABAG_GITEA_USER_URI=login/oauth/userinfo
- TEABAG_CALLBACK_URI=http://oauth.example.com:3000/callback - TEABAG_CALLBACK_URI=https://oauth.example.com/callback
ports: ports:
- "3000:3000" - "3000:3000"

2
env/teabag.env.example vendored
View File

@ -4,7 +4,7 @@ SESSION_SECRET=super-secret
GITEA_KEY= GITEA_KEY=
GITEA_SECRET= GITEA_SECRET=
GITEA_BASE_URL=https://gitea.yourcompany.com GITEA_BASE_URL=https://gitea.example.com
GITEA_AUTH_URI= GITEA_AUTH_URI=
GITEA_TOKEN_URI= GITEA_TOKEN_URI=
GITEA_USER_URI= GITEA_USER_URI=