Join GitHub today
If you'd prefer to manually install JKAN over the guided wizard, use these steps.
Register an application with GitHub to allow your users to sign in using their GitHub credentials.
- Application name: Whatever your site will be called (ie. JKAN)
Homepage URL and Authorization callback URL:
- Application description: Whatever you like - users will see this when signing in to your JKAN site
After clicking Register, you'll be given a
Client ID and a
Client Secret. Hang on to them for the next steps.
- In order to authenticate with GitHub securely, you'll need to setup a tiny authentication server called Gatekeeper. You can run it yourself using the documentation on its repository or use the Deploy button below to run it on Heroku for free. Pick an
App Nameand use the
Client Secretfrom Step 2.
- Edit the
_config.ymlfile in your JKAN fork using GitHub's built-in editing. Put your
Client IDfrom Step 2 under
github_client_idand the URL of your Gatekeeper instance in the under
gatekeeper_host(if you used Heroku, it will be
You should be able to view your site momentarily at
http://<your-github-username>.github.io/jkan/. From there you can sign in and visit the
/admin/ page for more configuration (optional) or modify the other settings in