From 2de8fa49e3e03282f48cfb0ae664341ac2471a49 Mon Sep 17 00:00:00 2001 From: Marvin Pohl Date: Fri, 20 Dec 2019 11:37:56 +0100 Subject: [PATCH] Updated documentation for Auth --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8332867..cdafbeb 100644 --- a/README.md +++ b/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) \ No newline at end of file ++ [Buildbot OAuth2 documentation](https://docs.buildbot.net/current/developer/cls-auth.html?highlight=oauth2#buildbot.www.oauth2.OAuth2Auth) \ No newline at end of file