fix: small improvements to local dev (#2699)
* dont commit pem files to git * update readme ngrok instructions * quote the OIDC scope string
This commit is contained in:
parent
9a1c5c187e
commit
61d56922d5
|
@ -94,10 +94,10 @@ OIDC_USERINFO_URI=
|
||||||
OIDC_USERNAME_CLAIM=preferred_username
|
OIDC_USERNAME_CLAIM=preferred_username
|
||||||
|
|
||||||
# Display name for OIDC authentication
|
# Display name for OIDC authentication
|
||||||
OIDC_DISPLAY_NAME=OpenID Connect
|
OIDC_DISPLAY_NAME=OpenID
|
||||||
|
|
||||||
# Space separated auth scopes.
|
# Space separated auth scopes.
|
||||||
OIDC_SCOPES=openid profile email
|
OIDC_SCOPES="openid profile email"
|
||||||
|
|
||||||
|
|
||||||
# –––––––––––––––– OPTIONAL ––––––––––––––––
|
# –––––––––––––––– OPTIONAL ––––––––––––––––
|
||||||
|
|
|
@ -8,3 +8,4 @@ stats.json
|
||||||
.DS_Store
|
.DS_Store
|
||||||
fakes3/*
|
fakes3/*
|
||||||
.idea
|
.idea
|
||||||
|
*.pem
|
||||||
|
|
|
@ -97,7 +97,7 @@ For contributing features and fixes you can quickly get an environment running u
|
||||||
1. `SLACK_SECRET` (this is called "Client Secret" in Slack admin)
|
1. `SLACK_SECRET` (this is called "Client Secret" in Slack admin)
|
||||||
1. Configure your Slack app's Oauth & Permissions settings
|
1. Configure your Slack app's Oauth & Permissions settings
|
||||||
1. Slack recently prevented the use of `http` protocol for localhost. For local development, you can use a tool like [ngrok](https://ngrok.com) or a package like `mkcert`. ([How to use HTTPS for local development](https://web.dev/how-to-use-local-https/))
|
1. Slack recently prevented the use of `http` protocol for localhost. For local development, you can use a tool like [ngrok](https://ngrok.com) or a package like `mkcert`. ([How to use HTTPS for local development](https://web.dev/how-to-use-local-https/))
|
||||||
1. Add `https://my_ngrok_address/auth/slack.callback` as an Oauth redirect URL
|
1. Add `https://my_ngrok_address/auth/slack.callback` as an Oauth redirect URL and update the `URL` env var to match
|
||||||
1. Ensure that the bot token scope contains at least `users:read`
|
1. Ensure that the bot token scope contains at least `users:read`
|
||||||
1. Run `make up`. This will download dependencies, build and launch a development version of Outline
|
1. Run `make up`. This will download dependencies, build and launch a development version of Outline
|
||||||
|
|
||||||
|
|
Reference in New Issue