[doc] add info about create-example-vocabs paster command to readme
[ckanext-datagovau.git] / README.rst
1 This CKAN Extension customises a CKAN instance for the hosting of data.gov.au.
2
3 It comprises:
4
rgrp 5 * A custom Package edit form that defaults to cc-by licence
6 * Replaces links with http/https protocol independent versions
7 * Provides HTML to users to embed data previews on their own website
rgrp 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.
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/``)::
Ross Jones 16
17 pip install -e git+https://github.com/okfn/ckanext-datagovau#egg=ckanext-datagovau
Ross Jones 18
19 Then activate it by setting ``ckan.plugins = datagovau`` in your main ``ini``-file.
20
Ian Murray 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
rgrp 23 and set ``licenses_group_url = file://%(here)s/licenses.json``
24
Seb Bacon 25
26