Manual Installation

Tim Wisniewski edited this page Apr 11, 2016 · 1 revision

Manual Installation

If you'd prefer to manually install JKAN over the guided wizard, use these steps.

  1. Fork the JKAN code repository

  2. 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: http://<you-github-username>.github.io/jkan/
  • 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.

  1. 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 Name and use the Client ID and Client Secret from Step 2.

Deploy Gatekeeper to Heroku

  1. Edit the _config.yml file in your JKAN fork using GitHub's built-in editing. Put your Client ID from Step 2 under github_client_id and the URL of your Gatekeeper instance in the under gatekeeper_host (if you used Heroku, it will be https://<app-name-you-picked>.herokuapp.com).

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 _config.yml manually.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.