CKAN Administration - Revision history

DRW: Add URL for fetching CKAN version and installed extensions

2024-01-04T17:07:20Z

Add URL for fetching CKAN version and installed extensions

← Older revision		Revision as of 17:07, 4 January 2024
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].		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 ==

DRW: Fix markup

2023-11-21T18:27:30Z

Fix markup

← Older revision		Revision as of 18:27, 21 November 2023
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).		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].

	== Changes that can be made through the frontend ==		== Changes that can be made through the frontend ==

DRW: Add link to WPRDC wiki on CKAN Docker deployment/administration

2023-11-21T18:26:55Z

Add link to WPRDC wiki on CKAN Docker deployment/administration

← Older revision		Revision as of 18:26, 21 November 2023
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).

	== 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].

DRW: Add "CKAN" as an additional category for this page

2023-11-21T18:22:02Z

Add "CKAN" as an additional category for this page

← Older revision		Revision as of 18:22, 21 November 2023
Line 85:		Line 85:
	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]]

DRW: Add tips on managing Docker containers and increasing disk space under AWS

2023-09-05T16:40:09Z

Add tips on managing Docker containers and increasing disk space under AWS

← Older revision		Revision as of 16:40, 5 September 2023
Line 51:		Line 51:
	* 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		=== Managing the Docker containers ===

			<code> > cd docker-ckan

	~~```> cd docker-ckan~~
	> docker ps		> docker ps
	~~```~~		</code>
	should return a list of running containers, which should include the following container names: "datapusher-plus", "ckan", "solr", and "redis".
			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		Use
	`> sudo docker-compose logs --tail=100 ckan`		<code>> sudo docker-compose logs --tail=100 ckan</code>
	to show the last 100 lines of the log for the `ckan` Docker instance.		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 69:		Line 71:
	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 ===		=== 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.		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:		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		> 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 Xen instance		that server was a <code>Xen</code> instance

	== Other changes ==		== Other changes ==

DRW: Add tips on managing Docker containers and increasing disk space under AWS

2023-09-05T16:36:59Z

Add tips on managing Docker containers and increasing disk space under AWS

← Older revision		Revision as of 16:36, 5 September 2023
Line 50:		Line 50:

	* 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

			```> cd docker-ckan
			> docker ps
			```
			should return a list of running containers, which should include the following container names: "datapusher-plus", "ckan", "solr", and "redis".

			Use
			`> sudo docker-compose logs --tail=100 ckan`
			to show the last 100 lines of the log for the `ckan` Docker instance.

	=== Adding/changing departments of publishers ===		=== Adding/changing departments of publishers ===
Line 57:		Line 68:

	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 Xen instance

	== Other changes ==		== Other changes ==

DRW: Add Canonical Views section

2023-03-20T18:40:27Z

Add Canonical Views section

← Older revision		Revision as of 18:40, 20 March 2023
Line 7:		Line 7:
	* [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.

DRW: Add notes about CKAN's description support for Markdown

2022-10-06T19:48:07Z

Add notes about CKAN's description support for Markdown

← Older revision		Revision as of 19:48, 6 October 2022
Line 6:		Line 6:
	* [https://github.com/WPRDC/data-guide/blob/master/docs/data_dictionaries.md How to create data dictionaries] ==> [[Data Dictionaries]]		* [https://github.com/WPRDC/data-guide/blob/master/docs/data_dictionaries.md How to create data dictionaries] ==> [[Data Dictionaries]]
	* [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 ==
			The description field supports some limited markup, which appears to be a subset of Markdown.

			* Starting a line with a single pound sign (#) indicates that the line should be in bigger, title text, but two pound signs (##) do not give a different font size, as they do in standard Markdown.

			* Dashes can be used to denote elements in an unordered list (though I haven't been able to get nested lists to work).

			* Use backticks to indicate that a sans serif font should be use to represent code, like `this`.

			Images, links, bold and italic text all work.

			It seems like it's limited to the original [https://www.markdownguide.org/cheat-sheet/#basic-syntax](very basic specification of Markdown).

	== Changes that can be made through the backend ==		== Changes that can be made through the backend ==

DRW: Add link to Data Dictionaries page

2022-03-08T20:41:31Z

Add link to Data Dictionaries page

← Older revision		Revision as of 20:41, 8 March 2022
Line 4:		Line 4:
	A few samples (to eventually migrate over):		A few samples (to eventually migrate over):
	* [https://github.com/WPRDC/data-guide/blob/master/docs/PublishingCKAN.md Our documentation for publishers on publishing data on the WPRDC]		* [https://github.com/WPRDC/data-guide/blob/master/docs/PublishingCKAN.md Our documentation for publishers on publishing data on the WPRDC]
	* [https://github.com/WPRDC/data-guide/blob/master/docs/data_dictionaries.md How to create data dictionaries]		* [https://github.com/WPRDC/data-guide/blob/master/docs/data_dictionaries.md How to create data dictionaries] ==> [[Data Dictionaries]]
	* [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]

DRW: Fix instructions for changing number of background workers

2022-03-07T19:28:44Z

Fix instructions for changing number of background workers

← Older revision		Revision as of 19:28, 7 March 2022
Line 28:		Line 28:
	* To restart the Express Loader: <code>> sudo supervisorctl restart ckan-worker:*</code>		* To restart the Express Loader: <code>> sudo supervisorctl restart ckan-worker:*</code>

	* To edit the background worker configuration (including increasing the number of background workers), ~~edit~~ the config file:		* To edit the background worker configuration (including increasing the number of background workers),
	<code>> vi /etc/supervisor/conf.d/supervisor-ckan-worker.conf</code>		*# Edit the config file: <code>> vi /etc/supervisor/conf.d/supervisor-ckan-worker.conf</code>
	~~and then restart~~ the workers:		*# Tell Supervisor to use the new configuration: <code>> sudo supervisorctl reread</code>
	<code>> sudo supervisorctl restart ckan-worker:*</code>		*# Update the deployed configuration to start the desired number of workers: <code>> sudo supervisorctl update</code>

	* 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>