Add documentation about OAuth2 client id configuration

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=161571961
This commit is contained in:
mountford 2017-07-11 13:19:54 -07:00 committed by jianglai
parent 944d7a91d1
commit 3372ed718a
2 changed files with 57 additions and 15 deletions

View file

@ -1,18 +1,9 @@
# Adding Client Secrets
To use the nomulus tool to administer a nomulus instance, you will need to
obtain OAuth client ids for each of your environment. There's no reason you
can't use the same client id for all of your environments.
To obtain a client id, go to your project's ["credentials"
page](https://console.developers.google.com/apis/credentials) in the Developer's
Console. Click "Create credentials" and select "OAuth client Id" from the
dropdown. In the create credentials window, select an application type of
"Other."
When you return to the main credentials page, click the download icon to the
right of the client id that you just created. This will download a json file
that you should copy to this directory for all of the environments that you
want to use. Don't copy over the "UNITTEST" secret, otherwise your unit tests
will break.
This directory contains the client secret files needed by the `nomulus` tool to
connect to the Nomulus backend via OAuth2. Adding client secret files to this
directory is one of two steps you need to perform; the other is adding the
client id contained in the client secret file to the list of allowed ids in the
Nomulus configuration file. See the configuration documentation for more
information.