Skip to content

Latest commit

 

History

History
162 lines (108 loc) · 6.03 KB

THIRD_PARTY_SETUP.md

File metadata and controls

162 lines (108 loc) · 6.03 KB
Raw

Third party integrations

Setup Github OAuth2 App Integration (Recommended)

Navigate to: Github - New Application and enter similar values to:

  • Enter Application Name: MyGitcoinApp
  • Homepage URL: http://localhost
  • Application description: My Gitcoin App
  • Authorization callback URL: http://localhost:8000/ (required)

The authorization callback URL should match your BASE_URL value in web/app/app/.env

Update the web/app/app/.env file to include the values provided by Github:

GITHUB_CLIENT_ID=xxxx
GITHUB_CLIENT_SECRET=xxx
GITHUB_APP_NAME=MyGitcoinApp

Please docker-compose down; docker-compose up -d to have the environment variable changes reflect in your local Gitcoin environment.

Setup Github User Integration (Recommended)

Navigate to: Github - New Token At minimum, select user scope.

Update the web/app/app/.env file to include the values provided by Github:

GITHUB_API_TOKEN=xxx
GITHUB_API_USER=xxx

Make sure you disable gitcoinbot notifications on your local, unless you are specifically testing that feature By default, we disable outbound GitHub notifications to any repository that isn't under the GITHUB_API_USER repositories.

For example, if settings.GITHUB_API_USER == gitcoinco only github.com/gitcoinco/<repos> bounties and associated tips will post Github comments.

Setup Google Verification Integration

Navigate to: Google - New Project and enter similar values to:

  • Enter Project Name: MyGitcoinApp

Navigate to: Google - OAuth consent screen and create an external OAuth consent screen:

  • Application name: MyGitcoinApp
  • Support email: Select your email

Navigate to: Google - Credentials and create OAth Client ID:

  • Application Type: Web Application
  • Name: MyGitcoinApp
  • Authorized JavaScript origins: http://localhost:8000
  • Authorized redirect URIs: http://localhost:8000/api/v0.1/profile/verify_user_google

Update the web/app/app/.env file to include the values provided by Google:

GOOGLE_CLIENT_ID=xxx
GOOGLE_CLIENT_SECRET=xxx

Please docker-compose down; docker-compose up -d to have the environment variable changes reflect in your local Google environment.

Note: Update the OAUTHLIB_INSECURE_TRANSPORT in web/app/app/.env to 0 for production.

Setup Facebook Integration

Navigate to: Facebook - Create App, select Build Connected Experiences and continue with similar values to:

  • App Display Name: MyGitcoinApp
  • App Contact Email: Your email address

Set Up Facebook Login in Add Products to Your App.

On the page: Facebook Login > Settings:

  • Valid OAuth Redirect URIs: http://localhost:8000

Update the web/app/app/.env file to include the values provided by Facebook on your created app Settings > Basic:

FACEBOOK_CLIENT_ID=xxx
FACEBOOK_CLIENT_SECRET=xxx

Please docker-compose down; docker-compose up -d to have the environment variable changes reflect in your local Gitcoin environment.

Setup SendGrid to Send Emails (Recommended)

  1. Create a new SendGrid Account at https://sendgrid.com
  2. Go to https://app.sendgrid.com/settings/api_keys and create a new Sendgrid API key:

Update the web/app/app/.env file to include the values provided by SendGrid:

SENDGRID_API_KEY=xxx
CONTACT_EMAIL=xxx
# Be VERY CAREFUL when changing this setting.  You don't want to accidently
# send a bunch of github notifications :)
ENABLE_NOTIFICATIONS_ON_NETWORK=None

Setup Fortmatic Integration

  1. Sign up/Login to Fortmatic dashboard at https://dashboard.fortmatic.com
  2. Update the web/app/app/.env file to include the values provided by Fortmatic:
FORTMATIC_LIVE_KEY=xxx
FORTMATIC_TEST_KEY=xxx

Gitcoinbot Installation Instructions

This integration requires the Github OAuth2 App Integration

Navigate to: Gitcoinbot Github App Copy the application ID found on the page as the GITCOINBOT_APP_ID environment variable.

Make sure you disable gitcoinbot notifications on your local, unless you are specifically testing that feature

# Be VERY CAREFUL when changing this setting.  You don't want to accidentally
# send a bunch of github notifications :)
ENABLE_NOTIFICATIONS_ON_NETWORK=None

The following environment variables must be set for gitcoinbot to work correctly:

GITHUB_API_USER=gitcoinbot  # Github Profile name of the bot. Defaults to: gitcoinbot
GITCOINBOT_APP_ID=APP_ID_FROM_ABOVE  # Defaults to empty.
GITCOIN_BOT_CERT_PATH=RELATIVE_PATH_TO_CERT_FILE  # Defaults to empty.

Example

GITHUB_API_USER=gitcoinbot  # Github Profile name of the bot. Defaults to: gitcoinbot
GITCOINBOT_APP_ID=7735  # Gitcoin Bot App ID
GITCOIN_BOT_CERT_PATH=app/gitcoin_bot_secret.pem  # If pem file is located at web/app/app/gitcoin_bot_secret.pem

Aside from these environment variables, the settings page of the gitcoin bot application must have the correct url for webhook events to post to. It should be set to https://gitcoin.co/payload based on urls.py line 131.

After running the migrations and deploying the gitcoin.co website, gitcoinbot will begin to receive webhook events from any repository that it is installed into. This application will then parse through the comments and respond if it is called with @gitcoinbot + registered action call.

Sentry Integration

Error tracking is entirely optional and primarily for internal staging and production tracking. If you would like to track errors of your local environment, setup an account at: Sentry.io

Once you have access to your project secrets, you can enable Sentry error tracking for both the backend and frontend by adding the following environment variables to web/app/app/.env:

SENTRY_DSN=xxx