Updated documentation for Auth
This commit is contained in:
parent
01e59b698b
commit
2de8fa49e3
15
README.md
15
README.md
|
@ -137,21 +137,20 @@ Gitea supports OAuth2 authentication so it is possible to have buildbot communic
|
|||
`./master.cfg`
|
||||
|
||||
```py
|
||||
from buildbot_gitea.auth import GiteaAuth
|
||||
c['www']['auth'] = GiteaAuth(
|
||||
from buildbot.plugins import util
|
||||
c['www']['auth'] = util.GiteaAuth(
|
||||
endpoint="https://your-gitea-host",
|
||||
client_id 'oauth2-client-id',
|
||||
client_id='oauth2-client-id',
|
||||
client_secret='oauth2-client-secret')
|
||||
```
|
||||
|
||||
| Parameter | Value |
|
||||
| --- | --- |
|
||||
| `endpoint` | The URL to your Gitea app. |
|
||||
| `client_id` | The OAuth2 Client ID |
|
||||
| `client_secret` | The OAuth2 Client Secret |
|
||||
| `endpoint` | The URL to your Gitea app. Something like `https://gitea.example.com/` |
|
||||
| `client_id` | The OAuth2 Client ID `GUID`, can be a `Secret`. |
|
||||
| `client_secret` | The OAuth2 Client Secret provided, when creating the OAuth application in gitea. Can be a `Secret`. |
|
||||
|
||||
Resources:
|
||||
|
||||
+ [Gitea OAuth2 Provider documentation](https://docs.gitea.io/en-us/oauth2-provider/)
|
||||
+ [Buildbot OAuth2 documentation](https://docs.buildbot.net/current/developer/cls-auth.html?highlight=oauth2#buildbot.www.oauth2.OAuth2Auth)
|
||||
+ [Buildbot OAuth2 source](https://github.com/buildbot/buildbot/blob/master/master/buildbot/www/oauth2.py)
|
||||
+ [Buildbot OAuth2 documentation](https://docs.buildbot.net/current/developer/cls-auth.html?highlight=oauth2#buildbot.www.oauth2.OAuth2Auth)
|
Loading…
Reference in New Issue
Block a user