paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 05:53:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

auth: Document setting social_auth_github_key in dev-secrets.

Browse Source 
This is a simpler configuration method for development, because
dev_settings.py isn't something the developer can edit.
This commit is contained in:
Vishnu Ks
2019-06-07 16:56:04 +05:30
committed by Tim Abbott
parent 5a4f7d9ade
commit 16a345a766
4 changed files with 29 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/subsystems/auth.md
View File

@@ -18,7 +18,13 @@ environment is to set up the real Google and GitHub to process auth
requests for your development environment.
The steps to do this are a variation of the steps documented in
`prod_settings_template.py`. Here are the full procedures for dev:
`prod_settings_template.py`. The main differences here are driven by
the fact that `dev_settings.py` is in Git, so it can be inconvenient
to put secrets there. In development, we allow providing those values
in the untracked file `zproject/dev-secrets.conf`, using the standard
lower-case naming convention for that file.
Here are the full procedures for dev:
### Google
@@ -47,9 +53,9 @@ The steps to do this are a variation of the steps documented in
Specify `http://zulipdev.com:9991/complete/github/` as the callback URL.
* You should get a page with settings for your new application,
showing a client ID and a client secret. In `dev_settings.py`, set
`SOCIAL_AUTH_GITHUB_KEY` to the client ID, and in
`dev-secrets.conf`, set `social_auth_github_secret` to the client secret.
showing a client ID and a client secret. In `dev-secrets.conf`, set
`social_auth_github_key` to the client ID and `social_auth_github_secret`
to the client secret.
### When SSL is required