Move API google analytics and AGLS metadata to seperate extensions
[ckanext-datagovau.git] / README.rst
Alex Sadleir 1 This CKAN Extension customises a CKAN instance for the hosting of data.gov.au.
2
3 It comprises:
4
Alex Sadleir 5 * A CKAN Extension "plugin" at ``ckanext/datagovau/plugin.py`` which, when
6 loaded, overrides various settings in the core ``ini``-file to provide:
7 * A path to local customisations of the core templates to include AGLS/Dublin Core minimum metadata
Alex Sadleir 8 * A custom Package edit form that defaults to cc-by licence
9 * A custom n3/rdf output format
Alex Sadleir 10 * Replaces links with http/https protocol independent versions
11 * Provides HTML to users to embed data previews on their own website
Seb Bacon 12
13 * A cut down licenses.json file
14
15 Installation
16 ============
Alex Sadleir 17
John Glover 18 To install this package, from your CKAN virtualenv, run the following from your CKAN base folder (e.g. ``pyenv/``)::
Alex Sadleir 19
John Glover 20 pip install -e git+https://github.com/okfn/ckanext-datagovau#egg=ckanext-datagovau
Alex Sadleir 21
22 Then activate it by setting ``ckan.plugins = datagovau`` in your main ``ini``-file.
23
24 To add the cut down licenses.json set ``licenses_group_url = http://%(ckan.site_url)/licenses.json``
John Glover 25 or copy ``ckanext/datagovau/theme/public/licenses.json`` to the same folder as your CKAN config ini file
26 and set ``licenses_group_url = file://%(here)s/licenses.json``
27
28
29