Skip to content

Commit bd15c43

Browse files
committed
Minor doc update
1 parent f22d68e commit bd15c43

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/consume.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,23 @@ This server runs on port 8002 and does two main things:
1717
2. Hosts an endpoint, `/introspect`, that takes the cookies in the request and
1818
returns a 200 code if the tokens are good, and a 401 if they are bad.
1919

20+
Configuration
21+
-------------
22+
23+
You will need to [create an app](create.md) at the main `soauth` server site. Then, you will
24+
need the following environment variables set:
25+
26+
- `SOAUTH_APP_BASE_URL` - the base URL for your consumer app, e.g.
27+
`https://nersc.simonsobs.org/auth`.
28+
- `SOAUTH_AUTHENTICATION_BASE_URL` - the base URL for the auth service, e.g.
29+
`https://identity.simonsobservatory.org`
30+
- `SOAUTH_APP_ID` - the APP ID from the `soauth` UI.
31+
- `SOAUTH_CLIENT_SECRET` - the client secret from the `soauth` UI.
32+
- `SOAUTH_PUBLIC_KEY` - the public key from the `soauth` UI.
33+
- `SOAUTH_KEY_PAIR_TYPE` - the key pair type from the `soauth` UI.
34+
- `SOAUTH_REQUIRED_GRANT` - the grant from `soauth` that you require to have access to this
35+
service.
36+
2037
Using with Nginx
2138
----------------
2239

0 commit comments

Comments
 (0)