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

Update README.md

Browse Source
This commit is contained in:
Denys Konovalov 2023-05-07 11:15:47 +02:00 committed by GitHub
parent 213ace7f97
commit 9fdbbce5ea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,4 +1,4 @@
# Teabag - [Static CMS](https://github.com/StaticJsCMS/static-cms)/[Decap](https://github.com/decaporg/decap-cms) OAuth Provider for Gitea # teabag - [Static CMS](https://github.com/StaticJsCMS/static-cms)/[Decap](https://github.com/decaporg/decap-cms) OAuth provider for Gitea
This is a lightweight Go server for handling OAuth flows with Gitea. This is a lightweight Go server for handling OAuth flows with Gitea.
@ -61,19 +61,19 @@ PORT=3000 # The port to serve on
SESSION_SECRET=super-secret # Used with OAuth provider sessions SESSION_SECRET=super-secret # Used with OAuth provider sessions
``` ```
For the Gitea connector, there are some required settings: There are some required settings to connect to Gitea:
```bash ```bash
# OAuth Key and Secret generated on Gitea # OAuth key and Ssecret generated on Gitea
GITEA_KEY=<KEY> GITEA_KEY=<KEY>
GITEA_SECRET=<SECRET> GITEA_SECRET=<SECRET>
# URL of the Gitea instance # URL of Gitea instance
GITEA_BASE_URL=https://gitea.company.com GITEA_BASE_URL=https://gitea.example.com
# endpoint URIs (for Gitea, see https://docs.gitea.io/en-us/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=api/v1/user
# Callback URL for the SCM, where it will redirect the user after they authorise. This needs to match what was given when creating the OAuth application. # 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
``` ```
@ -82,5 +82,3 @@ You can also provide the config using environment variables. For that you need t
### Credits ### Credits
Fork of https://github.com/donskifarrell/scm-oauth-provider Fork of https://github.com/donskifarrell/scm-oauth-provider
Inspiration taken from https://github.com/igk1972/netlify-cms-oauth-provider-go