Skip to content

github-README.md

Latest commit

 

History

History
20 lines (15 loc) · 804 Bytes

github-README.md

File metadata and controls

20 lines (15 loc) · 804 Bytes

OSF Github Addon

Enabling the addon for development

Setup up on Github

  1. On your Github user settings, under "Developer settings" go to “OAuth Apps”
  2. Click on "Register a new application"
  3. Enter any name for the application name, e.g. "OSF Github Addon (local)"
  4. In the "Homepage URL" field, enter http://localhost:5000/
  5. In the Authorization Callback URL field, enter http://localhost:5000/oauth/callback/github/.
  6. Submit the form.
  7. Make a note of your Client ID and Client Secret, and fill them into GV admin.

Testing webhooks (not supported by GV yet)

To test Github webhooks, your development server must be exposed to the web using a service like ngrok:

  • brew install ngrok
  • ngrok 5000
  • Copy forwarding address to addons/github/settings/local.py:HOOK_DOMAIN