Commit 9101924f authored by Willem ter Berg's avatar Willem ter Berg

Merge branch 'installation' into 'master'

- Installatie van CKAN plug-ins gebeurd door middel van pip.

See merge request !1
parents 79592074 2ff48513
......@@ -3,21 +3,28 @@ Installation
Follow the steps listed below to install and activate the ckanext-dcatdonl extension into CKAN.
1. Download the plugin from `github.com/dataoverheid/ckanext-dcatdonl`_
2. Place the ckanext-dcatdonl folder in your ckan extension folder. On linux this is likely the​ :code:`/usr/lib/ckan/default/src` directory.
3. Edit your CKAN configuration file and add the following
1. With your CKAN virtual environment activated:
.. code-block:: bash
. /usr/lib/ckan/default/bin/activate
pip install -e git+https://gitlab.textinfo.nl/opensource/ckanext-dcatdonl.git#egg=ckanext-dcatdonl
2. Edit your CKAN .ini configuration file and add the following
.. code-block:: ini
ckan.plugins = ... dcatdonl
4. In the same file, change the licenses_group_url property to
3. In the same file, add (or change) the `licenses_group_url` property in the `[app:main]` section to
.. code-block:: ini
licenses_group_url = file:///path/to/plugin/ckanext/dcatdonl/resources/overheid_license.json
5. Restart CKAN
licenses_group_url = file:///usr/lib/ckan/default/src/ckanext-dcatdonl/ckanext/dcatdonl/resources/overheid_license.json
4. Restart apache2
You have now successfully installed the ckanext-dcatdonl plugin
You have now successfully installed the `ckanext-dcatdonl` plugin
Background process
--------------------------------------------
......@@ -28,13 +35,13 @@ executing the following command once a day via a CRON job for example.
.. code-block:: bash
python /path/to/plugin/ckanext/dcatdonl/ValuelistUpdater.py
python /usr/lib/ckan/default/src/ckanext-dcatdonl/ckanext/dcatdonl/ValuelistUpdater.py
Ensure that the python script has ​READ​ and WRITE​ access to the following directory and its contents
Ensure that the python script has READ and WRITE access to the following directory and its contents
.. code-block:: bash
/path/to/plugin/ckanext/dcatdonl/resources
/usr/lib/ckan/default/src/ckanext-dcatdonl/ckanext/dcatdonl/resources
The extension can function without the background process running, however this means that the valuelists that are used
as part of the DCAT-AP-DONL metadata standard will never be updated.
......@@ -55,4 +62,4 @@ earlier versions, no guarantees can be given for such use cases.
| Python | 2.7 |
+------------+---------+
.. _github.com/dataoverheid/ckanext-dcatdonl: https://github.com/dataoverheid/ckanext-dcatdonl
\ No newline at end of file
.. _github.com/dataoverheid/ckanext-dcatdonl: https://github.com/dataoverheid/ckanext-dcatdonl
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment