A lightweight, backend-free open data portal, powered by Jekyll
Open-source data portals can be really hard to install and maintain. But their basic purpose of providing links to download data really isn't that complicated. JKAN is a proof-of-concept that allows a small, resource-strapped government agency to stand-up an open data portal by simply clicking the fork button.
Please note this is still a work in progress! Check out the issues to help out or give feedback.
- See Get Started on jkan.io for an installation wizard,
- follow the manual installation instructions yourself.
- Do a manual fork and do not install gatekeeper at all (login bits won't work, but Heroku is no longer free)
For configuration details, see the wiki
The recommended to build the site for development or making changes is docker compose. Just run docker compose up
$ docker compose up
[+] Running 1/0
⠿ Container jkan-jekyll-1 Created 0.0s
Attaching to jkan-jekyll-1
jkan-jekyll-1 | ruby 2.6.3p62 (2019-04-16 revision 67580) [x86_64-linux-musl]
jkan-jekyll-1 | Configuration file: /srv/jekyll/_config.yml
jkan-jekyll-1 | Source: /srv/jekyll
jkan-jekyll-1 | Destination: /srv/jekyll/_site
jkan-jekyll-1 | Incremental build: enabled
jkan-jekyll-1 | Generating...
jkan-jekyll-1 | done in 0.025 seconds.
jkan-jekyll-1 | Auto-regeneration: enabled for '/srv/jekyll'
jkan-jekyll-1 | Server address: https://0.0.0.0:4000/jkan/
jkan-jekyll-1 | Server running... press ctrl-c to stop.Then connect to https://0.0.0.0:4000/jkan/ via a web browser.
Read more about the Architecture on the Wiki.