Sorting out the tokens and keys
andycox opened this issue · comments
I'm trying to sort out what each of the various tokens and keys set in the environment variables are for. This is my understanding. Please correct where I'm wrong.
GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET
Used only to limit access to the Resque dashboard.
Generate a new one under Developer Applications at https://github.com/settings/applications. I'm unclear what to enter for the callback URL.
Required if you want to view the Resque dashboard. Optional otherwise.
GITHUB_TEAM_ID
ID of the GitHub organization team to which you want to limit access to the Resque dashboard.
Required if you want to view the Resque dashboard and limit access to a specific GitHub organization team. Optional otherwise.
GITHUB_DEPLOY_TOKEN
Used to authorize access to clone a GitHub repository when deploying an application. Applies to your personal user, not any organization or team. This user must have pull access to the repository you want to clone.
Generate a new one under Personal access tokens at https://github.com/settings/applications.
Required
HEROKU_DEPLOY_PRIVATE_KEY
Private SSH key that is allowed to push to the application you want to deploy via Heaven. Add the corresponding public SSH key at https://dashboard.heroku.com/account.
Required
RAILS_SECRET_KEY_BASE
Required by Rails. Instructions in the README
I'm unclear what to enter for the callback URL.
I normally leave the callback URL blank. warden-github-rails just works and I don't really consider the callback urls much anymore.
GITHUB_TEAM_ID
ID of the GitHub organization team to which you want to limit access to the Resque dashboard.
Required if you want to view the Resque dashboard and limit access to a specific GitHub organization team. Optional otherwise.
This is kind of a shitty default because it might be on a personal account. I generally deploy from orgs though.
GITHUB_DEPLOY_TOKEN
Used to authorize access to clone a GitHub repository when deploying an application. Applies to your personal user, not any organization or team. This user must have pull access to the repository you want to clone.
Generate a new one under Personal access tokens at https://github.com/settings/applications.
Required
Exactly.
HEROKU_DEPLOY_PRIVATE_KEY
Private SSH key that is allowed to push to the application you want to deploy via Heaven. Add the corresponding public SSH key at https://dashboard.heroku.com/account.
Required
I don't think this is used anymore. I believe it's leftover from when I was doing things outside of dpl. I actually hate the way dpl is being used/works right now with adding keys every deploy. I'm open to removing it or using it smarter.
This token should actually go though.
RAILS_SECRET_KEY_BASE
Required by Rails. Instructions in the README
Yup, definitely required though.