73
edits
Difference between revisions of "CKAN Administration"
Jump to navigation
Jump to search
Add URL for fetching CKAN version and installed extensions
(Add notes about CKAN's description support for Markdown) |
(Add URL for fetching CKAN version and installed extensions) |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
More information on deploying/administering CKAN (like adding/removing extensions and editing the theme), may be found in [https://github.com/WPRDC/ckan-docker/wiki the wiki of the GitHub repo for our fork of the CKAN Docker repo]. | |||
== Checking CKAN configuration == | |||
* Check CKAN version and installed extensions: [https://data.wprdc.org/api/3/action/status_show https://data.wprdc.org/api/3/action/status_show] | |||
== Changes that can be made through the frontend == | == Changes that can be made through the frontend == | ||
There's a lot of documentation on publishing data on our CKAN portal [https://github.com/WPRDC/data-guide/tree/master/docs here]. | There's a lot of documentation on publishing data on our CKAN portal [https://github.com/WPRDC/data-guide/tree/master/docs here]. | ||
| Line 7: | Line 13: | ||
* [https://github.com/WPRDC/data-guide/blob/master/docs/metadata_extras.md Some of our standard extra metadata fields] | * [https://github.com/WPRDC/data-guide/blob/master/docs/metadata_extras.md Some of our standard extra metadata fields] | ||
== Writing dataset descriptions == | === Canonical Views === | ||
If you want to set a map or data table to be on the dataset landing page, you create a corresponding "view" under one of the resources in the dataset and then click the "Canonical View" button for that view. The catch is that CKAN does not enforce that only one view may be canonical, so if multiple views have their "Canonical View" button depressed, one of them will be chosen by CKAN to be the displayed one, and you will have to unclick others in order to get the one you want to display on the dataset landing page. | |||
=== Writing dataset descriptions === | |||
The description field supports some limited markup, which appears to be a subset of Markdown. | The description field supports some limited markup, which appears to be a subset of Markdown. | ||
| Line 47: | Line 56: | ||
* Activate the virtual environment that lets you run <code>paster</code> commands: <code>> . /usr/lib/ckan/default/bin/activate</code> | * Activate the virtual environment that lets you run <code>paster</code> commands: <code>> . /usr/lib/ckan/default/bin/activate</code> | ||
=== Managing the Docker containers === | |||
<code> > cd docker-ckan | |||
> docker ps | |||
</code> | |||
should return a list of running containers, which should include the following container names: <code>datapusher-plus</code>, <code>ckan</code>, <code>solr</code>, and <code>redis</code>. | |||
Use | |||
<code>> sudo docker-compose logs --tail=100 ckan</code> | |||
to show the last 100 lines of the log for the <code>ckan</code> Docker instance. | |||
=== Adding/changing departments of publishers === | === Adding/changing departments of publishers === | ||
| Line 54: | Line 76: | ||
The extra tricky part about this one is that [https://github.com/WPRDC/ckanext-wprdctheme our GitHub repository that includes this JSON file] is installed in a different directory: <code>/usr/lib/ckan/default/src/ckanext-wprdctheme/</code> but changes to the files in that directory (and subdirectories) do nothing. | The extra tricky part about this one is that [https://github.com/WPRDC/ckanext-wprdctheme our GitHub repository that includes this JSON file] is installed in a different directory: <code>/usr/lib/ckan/default/src/ckanext-wprdctheme/</code> but changes to the files in that directory (and subdirectories) do nothing. | ||
=== Dealing with inadequate disk space === | |||
Once, we were seeing OSError: write error in the CKAN Docker logs and had to increase disk space to make CKAN function again. | |||
Steve on increasing volume size on AWS: | |||
> if you ever have to increase a volume, here’s what i followed to make the filesystem use the new space: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recognize-expanded-volume-linux.html | |||
that server was a <code>Xen</code> instance | |||
== Other changes == | == Other changes == | ||
| Line 62: | Line 91: | ||
In additional to adding the users to the organizations through the CKAN front-end, you also have to add them to groups, using this URL: [http://wprdc.org/group-adder/] | In additional to adding the users to the organizations through the CKAN front-end, you also have to add them to groups, using this URL: [http://wprdc.org/group-adder/] | ||
[[Category:Onboarding]] | [[Category:Onboarding]] [[Category:CKAN]] | ||