| This CKAN Extension customises a CKAN instance for the hosting of data.gov.au. | This CKAN Extension customises a CKAN instance for the hosting of data.gov.au. |
| It comprises: | It comprises: |
| * A CKAN Extension "plugin" at ``ckanext/datagovau/plugin.py`` which, when | * A custom Package edit form that defaults to cc-by licence |
| loaded, overrides various settings in the core ``ini``-file to provide: | * Replaces links with http/https protocol independent versions |
| * A path to local customisations of the core templates and available licenses database | * Provides HTML to users to embed data previews on their own website |
| * A custom Package edit form | * A cut down licenses.json file |
| * A custom n3/rdf output format | |
| This extension is complemented by ckanext-agls for AGLS metadata, ckanext-googleanalytics for Google Analytics tracking of API usage and ckanext-dga-stats for the customised site statistics page. | |
| Installation | Installation |
| ============ | ============ |
| To install this package, from your CKAN virtualenv, run the following from your CKAN base folder (e.g. ``pyenv/``):: | To install this package, from your CKAN virtualenv, run the following from your CKAN base folder (e.g. ``pyenv/``):: |
| pip install -e git+https://github.com/okfn/ckanext-datagovau#egg=ckanext-datagovau | pip install -e git+https://github.com/okfn/ckanext-datagovau#egg=ckanext-datagovau |
| Then activate it by setting ``ckan.plugins = datagovau`` in your main ``ini``-file. | Then activate it by setting ``ckan.plugins = datagovau`` in your main ``ini``-file. |
| To add the cut down licenses.json set ``licenses_group_url = http://%(ckan.site_url)/licenses.json`` | |
| or copy ``ckanext/datagovau/theme/public/licenses.json`` to the same folder as your CKAN config ini file | |
| and set ``licenses_group_url = file://%(here)s/licenses.json`` | |