initial commit
[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
5 * A custom Package edit form that defaults to cc-by licence
rgrp 6 * Replaces links with http/https protocol independent versions
Alex Sadleir 7 * Provides HTML to users to embed data previews on their own website
8 * A cut down licenses.json file
9
10 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.
Seb Bacon 11
12 Installation
13 ============
14
15 To install this package, from your CKAN virtualenv, run the following from your CKAN base folder (e.g. ``pyenv/``)::
Alex Sadleir 16
John Glover 17 pip install -e git+https://github.com/okfn/ckanext-datagovau#egg=ckanext-datagovau
Alex Sadleir 18
John Glover 19 Then activate it by setting ``ckan.plugins = datagovau`` in your main ``ini``-file.
20
21 To add the cut down licenses.json set ``licenses_group_url = http://%(ckan.site_url)/licenses.json``
22 or copy ``ckanext/datagovau/theme/public/licenses.json`` to the same folder as your CKAN config ini file
23 and set ``licenses_group_url = file://%(here)s/licenses.json``
24
25
26