DevOps:Doc/Open CSP/2.0/open-csp-on-canasta - Revision history

81d56153-9868-4094-90a0-df1700ff7090: Text replacement - "{{Doc properties" to "{{Csp class properties"

2025-07-15T09:00:38Z

Text replacement - "{{Doc properties" to "{{Csp class properties"

ws-class-props
← Older revision		Revision as of 11:00, 15 July 2025
Line 1:		Line 1:
	{{~~Doc~~ properties		{{Csp class properties
	\|Doc synopsis=How to install Open CSP on Canasta		\|Doc synopsis=How to install Open CSP on Canasta
	\|Doc subject=DevOps:Doc/Open CSP		\|Doc subject=DevOps:Doc/Open CSP

Fd4138e7-8b46-4c8f-99bf-d4b738ebc295: User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295

2025-04-25T10:18:25Z

Charlot Cobben

ws-seo
← Older revision	Revision as of 12:18, 25 April 2025
Line 1:	Line 1:
		{{SEO
		\|Title=Open CSP on Canasta
		\|Description=This projects aims to integrate Open-CSP 2.0 into CanastaWiki.
		\|Section=open-csp
		\|Published time=2025-04-24
		}}

Fd4138e7-8b46-4c8f-99bf-d4b738ebc295 at 10:16, 25 April 2025

2025-04-25T10:16:15Z

← Older revision		Revision as of 12:16, 25 April 2025
Line 2:		Line 2:
	This projects aims to integrate Open-CSP 2.0 into CanastaWiki.		This projects aims to integrate Open-CSP 2.0 into CanastaWiki.

	## Getting started		== Getting started ==

	~~###~~ Clone the project and the Docker Compose companion project		=== Clone the project and the Docker Compose companion project ===

	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
Line 15:		Line 15:


	~~###~~ Go to the project directory		=== Go to the project directory ===

	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
Line 22:		Line 22:


	~~###~~ Build the image		=== Build the image ===

	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
Line 29:		Line 29:


	~~###~~ Change to the other project folder		=== Change to the other project folder ===

	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
Line 36:		Line 36:


	~~###~~ Start the Canasta stack		=== Start the Canasta stack ===

	<mark>NOTE: If, in the build step, you tagged the image differently from how I specified it above, you will need to alter this docker-compose.override.yml file as well at before you try to spin up Canasta.</mark>		<mark>NOTE: If, in the build step, you tagged the image differently from how I specified it above, you will need to alter this docker-compose.override.yml file as well at before you try to spin up Canasta.</mark>
Line 45:		Line 45:


	~~###~~ Install a wiki		=== Install a wiki ===

	Navigate to https://localhost and follow the installation steps		Navigate to https://localhost and follow the installation steps
Line 55:		Line 55:
	</syntaxhighlight>		</syntaxhighlight>

	~~###~~ Restart the stack		=== Restart the stack ===

	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
Line 62:		Line 62:
	</syntaxhighlight>		</syntaxhighlight>

	## OPTIONAL:		== OPTIONAL: ==
	Follow the Open-CSP installation progress		Follow the Open-CSP installation progress

Fd4138e7-8b46-4c8f-99bf-d4b738ebc295 at 10:13, 25 April 2025

2025-04-25T10:13:28Z

← Older revision		Revision as of 12:13, 25 April 2025
Line 4:		Line 4:
	## Getting started		## Getting started

	Clone the project and the Docker Compose companion project		### Clone the project and the Docker Compose companion project

	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
Line 14:		Line 14:
	</syntaxhighlight>		</syntaxhighlight>

	~~---~~

	Go to the project directory		### Go to the project directory

	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
Line 22:		Line 21:
	</syntaxhighlight>		</syntaxhighlight>

	~~---~~

	Build the image		### Build the image

	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
Line 30:		Line 28:
	</syntaxhighlight>		</syntaxhighlight>

	~~---~~

	Change to the other project folder		### Change to the other project folder

	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
Line 38:		Line 35:
	</syntaxhighlight>		</syntaxhighlight>

	~~---~~

	Start the Canasta stack		### Start the Canasta stack

	<mark>NOTE: If, in the build step, you tagged the image differently from how I specified it above, you will need to alter this docker-compose.override.yml file as well at before you try to spin up Canasta.</mark>		<mark>NOTE: If, in the build step, you tagged the image differently from how I specified it above, you will need to alter this docker-compose.override.yml file as well at before you try to spin up Canasta.</mark>
Line 47:		Line 43:
	docker-compose up -d		docker-compose up -d
	</syntaxhighlight>		</syntaxhighlight>
	~~---~~

	~~Install a wiki~~

	~~`Navigate to https://localhost and follow the installation steps`~~		### Install a wiki

	~~---~~		Navigate to https://localhost and follow the installation steps

	Copy the now downloaded LocalSettings.php to the config subdir		Copy the now downloaded LocalSettings.php to the config subdir
Line 61:		Line 55:
	</syntaxhighlight>		</syntaxhighlight>

	~~---~~		### Restart the stack

	Restart the stack

	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
Line 70:		Line 62:
	</syntaxhighlight>		</syntaxhighlight>

	~~---~~		## OPTIONAL:

	OPTIONAL:
	Follow the Open-CSP installation progress		Follow the Open-CSP installation progress

Line 80:		Line 70:
	<mark>If you're just running the one Canasta instance it'll be canasta-dockercompose_web_1. Otherwise you can use 'docker ps' to find it.</mark>		<mark>If you're just running the one Canasta instance it'll be canasta-dockercompose_web_1. Otherwise you can use 'docker ps' to find it.</mark>

	~~---~~

	You're done. 🥳		You're done. 🥳
	Visit your site.		Visit your site.

Fd4138e7-8b46-4c8f-99bf-d4b738ebc295 at 10:09, 25 April 2025

2025-04-25T10:09:11Z

← Older revision		Revision as of 12:09, 25 April 2025
Line 5:		Line 5:

	Clone the project and the Docker Compose companion project		Clone the project and the Docker Compose companion project
	~~```~~bash
			<syntaxhighlight lang="bash">
	git clone https://github.com/LarsS88/Canasta_OpenCSP.git		git clone https://github.com/LarsS88/Canasta_OpenCSP.git
	~~```~~		</syntaxhighlight>

	~~```~~bash		<syntaxhighlight lang="bash">
	git clone https://github.com/LarsS88/Canasta-DockerCompose.git		git clone https://github.com/LarsS88/Canasta-DockerCompose.git
	~~```~~		</syntaxhighlight>

	---		---
Line 17:		Line 18:
	Go to the project directory		Go to the project directory

	~~```~~bash		<syntaxhighlight lang="bash">
	cd Canasta_OpenCSP		cd Canasta_OpenCSP
	~~```~~		</syntaxhighlight>

	---		---
Line 25:		Line 26:
	Build the image		Build the image

	~~```~~bash		<syntaxhighlight lang="bash">
	docker build . -t canasta-opencsp:2.0		docker build . -t canasta-opencsp:2.0
	~~```~~		</syntaxhighlight>

	---		---
Line 33:		Line 34:
	Change to the other project folder		Change to the other project folder

	~~```~~bash		<syntaxhighlight lang="bash">
	cd ../Canasta-DockerCompose		cd ../Canasta-DockerCompose
	~~```~~		</syntaxhighlight>

	---		---
Line 43:		Line 44:
	<mark>NOTE: If, in the build step, you tagged the image differently from how I specified it above, you will need to alter this docker-compose.override.yml file as well at before you try to spin up Canasta.</mark>		<mark>NOTE: If, in the build step, you tagged the image differently from how I specified it above, you will need to alter this docker-compose.override.yml file as well at before you try to spin up Canasta.</mark>

	~~```~~bash		<syntaxhighlight lang="bash">
	docker-compose up -d		docker-compose up -d
	~~```~~		</syntaxhighlight>
	---		---

Line 56:		Line 57:
	Copy the now downloaded LocalSettings.php to the config subdir		Copy the now downloaded LocalSettings.php to the config subdir

	~~```~~bash		<syntaxhighlight lang="bash">
	cp <browser download folder>/LocalSettings.php config/		cp <browser download folder>/LocalSettings.php config/
	~~```~~		</syntaxhighlight>

	---		---
Line 64:		Line 65:
	Restart the stack		Restart the stack

	~~```~~bash		<syntaxhighlight lang="bash">
	docker-compose down		docker-compose down
	docker-compose up -d		docker-compose up -d
	~~```~~		</syntaxhighlight>

	---		---
Line 74:		Line 75:
	Follow the Open-CSP installation progress		Follow the Open-CSP installation progress

	~~```~~bash		<syntaxhighlight lang="bash">
	docker logs <web container name> --follow		docker logs <web container name> --follow
	~~```~~		</syntaxhighlight>
	<mark>If you're just running the one Canasta instance it'll be canasta-dockercompose_web_1. Otherwise you can use 'docker ps' to find it.</mark>		<mark>If you're just running the one Canasta instance it'll be canasta-dockercompose_web_1. Otherwise you can use 'docker ps' to find it.</mark>

Fd4138e7-8b46-4c8f-99bf-d4b738ebc295 at 10:02, 25 April 2025

2025-04-25T10:02:30Z

← Older revision		Revision as of 12:02, 25 April 2025
Line 5:		Line 5:

	Clone the project and the Docker Compose companion project		Clone the project and the Docker Compose companion project
			```bash
	~~[[User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|Fd4138e7-8b46-4c8f-99bf-d4b738ebc295]] ([[User talk:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|talk]])~~bash
	git clone https://github.com/LarsS88/Canasta_OpenCSP.git		git clone https://github.com/LarsS88/Canasta_OpenCSP.git
	~~[[User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|Fd4138e7-8b46-4c8f-99bf-d4b738ebc295]] ([[User talk:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|talk]])~~		```

	~~[[User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|Fd4138e7-8b46-4c8f-99bf-d4b738ebc295]] ([[User talk:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|talk]])~~bash		```bash
	git clone https://github.com/LarsS88/Canasta-DockerCompose.git		git clone https://github.com/LarsS88/Canasta-DockerCompose.git
	~~[[User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|Fd4138e7-8b46-4c8f-99bf-d4b738ebc295]] ([[User talk:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|talk]])~~		```

	---		---
Line 18:		Line 17:
	Go to the project directory		Go to the project directory

	~~[[User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|Fd4138e7-8b46-4c8f-99bf-d4b738ebc295]] ([[User talk:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|talk]])~~bash		```bash
	cd Canasta_OpenCSP		cd Canasta_OpenCSP
	~~[[User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|Fd4138e7-8b46-4c8f-99bf-d4b738ebc295]] ([[User talk:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|talk]])~~		```

	---		---
Line 26:		Line 25:
	Build the image		Build the image

	~~[[User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|Fd4138e7-8b46-4c8f-99bf-d4b738ebc295]] ([[User talk:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|talk]])~~bash		```bash
	docker build . -t canasta-opencsp:2.0		docker build . -t canasta-opencsp:2.0
	~~[[User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|Fd4138e7-8b46-4c8f-99bf-d4b738ebc295]] ([[User talk:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|talk]])~~		```

	---		---
Line 34:		Line 33:
	Change to the other project folder		Change to the other project folder

	~~[[User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|Fd4138e7-8b46-4c8f-99bf-d4b738ebc295]] ([[User talk:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|talk]])~~bash		```bash
	cd ../Canasta-DockerCompose		cd ../Canasta-DockerCompose
	~~[[User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|Fd4138e7-8b46-4c8f-99bf-d4b738ebc295]] ([[User talk:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|talk]])~~		```

	---		---
Line 44:		Line 43:
	<mark>NOTE: If, in the build step, you tagged the image differently from how I specified it above, you will need to alter this docker-compose.override.yml file as well at before you try to spin up Canasta.</mark>		<mark>NOTE: If, in the build step, you tagged the image differently from how I specified it above, you will need to alter this docker-compose.override.yml file as well at before you try to spin up Canasta.</mark>

	~~[[User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|Fd4138e7-8b46-4c8f-99bf-d4b738ebc295]] ([[User talk:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|talk]])~~bash		```bash
	docker-compose up -d		docker-compose up -d
	~~[[User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|Fd4138e7-8b46-4c8f-99bf-d4b738ebc295]] ([[User talk:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|talk]])~~		```

	---		---

Line 58:		Line 56:
	Copy the now downloaded LocalSettings.php to the config subdir		Copy the now downloaded LocalSettings.php to the config subdir

	~~[[User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|Fd4138e7-8b46-4c8f-99bf-d4b738ebc295]] ([[User talk:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|talk]])~~bash		```bash
	cp <browser download folder>/LocalSettings.php config/		cp <browser download folder>/LocalSettings.php config/
	~~[[User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|Fd4138e7-8b46-4c8f-99bf-d4b738ebc295]] ([[User talk:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|talk]])~~		```

	---		---
Line 66:		Line 64:
	Restart the stack		Restart the stack

	~~[[User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|Fd4138e7-8b46-4c8f-99bf-d4b738ebc295]] ([[User talk:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|talk]])~~bash		```bash
	docker-compose down		docker-compose down
	docker-compose up -d		docker-compose up -d
	~~[[User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|Fd4138e7-8b46-4c8f-99bf-d4b738ebc295]] ([[User talk:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|talk]])~~		```

	---		---
Line 76:		Line 74:
	Follow the Open-CSP installation progress		Follow the Open-CSP installation progress

	~~[[User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|Fd4138e7-8b46-4c8f-99bf-d4b738ebc295]] ([[User talk:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|talk]])~~bash		```bash
	docker logs <web container name> --follow		docker logs <web container name> --follow
	~~[[User:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|Fd4138e7-8b46-4c8f-99bf-d4b738ebc295]] ([[User talk:Fd4138e7-8b46-4c8f-99bf-d4b738ebc295\|talk]])~~		```
	<mark>If you're just running the one Canasta instance it'll be canasta-dockercompose_web_1. Otherwise you can use 'docker ps' to find it.</mark>		<mark>If you're just running the one Canasta instance it'll be canasta-dockercompose_web_1. Otherwise you can use 'docker ps' to find it.</mark>

Fd4138e7-8b46-4c8f-99bf-d4b738ebc295 at 09:58, 25 April 2025

2025-04-25T09:58:44Z

Show changes

Bryan Hilderbrand: Removed spelling error for "likeg"

2024-11-21T20:47:10Z

Removed spelling error for "likeg"

← Older revision		Revision as of 22:47, 21 November 2024
Line 25:		Line 25:
	Under services → web → volumes, at the top, add: - ./mediawiki:/mediawiki		Under services → web → volumes, at the top, add: - ./mediawiki:/mediawiki

	It should then look something ~~likeg~~:		It should then look something like:

	web:		web:

Fd4138e7-8b46-4c8f-99bf-d4b738ebc295 at 20:37, 20 November 2024

2024-11-20T20:37:02Z

← Older revision		Revision as of 22:37, 20 November 2024
Line 19:		Line 19:

	The shutdown and restart is needed to make the previously configured (either implicitly by defaults or explicitly through .env) MySQL root password become active.		The shutdown and restart is needed to make the previously configured (either implicitly by defaults or explicitly through .env) MySQL root password become active.
	You may encounter an issue like I did initially where the site will never ~~initially~~ come online.		You may encounter an issue like I did initially where the site will never come online.
	In this case use ‘docker logs <container>’ to inspect your MediaWiki container’s goings-on.		In this case use ‘docker logs <container>’ to inspect your MediaWiki container’s goings-on.
	It may report that it cannot access files directly under the “/mediawiki/”, in which case shut it down and edit docker-compose.yml as follows:		It may report that it cannot access files directly under the “/mediawiki/”, in which case shut it down and edit docker-compose.yml as follows:
Line 25:		Line 25:
	Under services → web → volumes, at the top, add: - ./mediawiki:/mediawiki		Under services → web → volumes, at the top, add: - ./mediawiki:/mediawiki

	It should then look something ~~like~~ :		It should then look something likeg:

	web:		web:

Fd4138e7-8b46-4c8f-99bf-d4b738ebc295 at 20:36, 20 November 2024

2024-11-20T20:36:02Z

← Older revision	Revision as of 22:36, 20 November 2024
Line 1:	Line 1:
		Getting this running is a two-step process, not including preparation of a docker host with all the prereqs that come with that.

		=== First of all we’ll create a new Canasta wiki, and then upgrade it to Open CSP. ===

		===== Creation of a new Canasta wiki: =====
		For this we’ll use Canasta-DockerCompose.

		# Clone the Canasta-DockerCompose repo, master branch. It can be found here : https://github.com/CanastaWiki/Canasta-DockerCompose
		# Copy the .env.example file to .env (optional; to override default values)
		# Alter .env as needed (refer to https://canasta.wiki/other-maintenance/#configuration )
		# Launch instance ( In your console you to the downloaded files and inside the main folder run : '''''docker-compose up -d''''' )
		# Wait for the database container to become responsive
		# Restart everything ( run '''''docker-compose down''''', then '''''docker-compose up -d''''' again )
		# Navigate to your webpage (localhost in your web browser on the docker host)
		# Follow the MediaWiki installation steps to install your version of MediaWiki
		# Copy the downloaded LocalSettings.php to <where you installed the download rep in step 1>/config/ on the host
		# Shut down Canasta instance ( run '''''docker-compose down''''' )


		The shutdown and restart is needed to make the previously configured (either implicitly by defaults or explicitly through .env) MySQL root password become active.
		You may encounter an issue like I did initially where the site will never initially come online.
		In this case use ‘docker logs <container>’ to inspect your MediaWiki container’s goings-on.
		It may report that it cannot access files directly under the “/mediawiki/”, in which case shut it down and edit docker-compose.yml as follows:

		Under services → web → volumes, at the top, add: - ./mediawiki:/mediawiki

		It should then look something like :

		web:
		image: ghcr.io/canastawiki/canasta:latest
		restart: unless-stopped
		extra_hosts:
		- "gateway.docker.internal:host-gateway"
		depends_on:
		- db
		- elasticsearch
		environment:
		# Sourced from .env
		- MW_SITE_SERVER=${MW_SITE_SERVER:-<nowiki>https://localhost}</nowiki>
		- PHP_UPLOAD_MAX_FILESIZE=${PHP_UPLOAD_MAX_FILESIZE:-10M}
		- PHP_POST_MAX_SIZE=${PHP_UPLOAD_MAX_FILESIZE:-10M}
		- PHP_MAX_INPUT_VARS=${PHP_MAX_INPUT_VARS:-1000}
		- MW_SITEMAP_SUBDIR
		- MW_SITEMAP_IDENTIFIER
		volumes:
		'''- ./mediawiki:/mediawiki'''
		- ./extensions:/var/www/mediawiki/w/user-extensions
		- ./skins:/var/www/mediawiki/w/user-skins
		- ./config:/mediawiki/config
		- ./images:/mediawiki/images
		- sitemap:/mediawiki/sitemap

		Then spin the farm up again.

		==== Upgrading to Open CSP: ====

		# Clone the Canasta-OpenCSP fork, master branch. ( this can be found here : https://github.com/LarsS88/opencsp2-canasta, you can simply download and unzip )
		# Build the image with a tag such as ‘open-csp:2.0’ for instance. ( inside the main folder that you have just downloaded, type '''''docker build --tag open-csp:2.0 .''''' ( do not forget the . at the end )
		# Go back to your Canasta-DockerCompose repo and edit ''docker-compose.override.yml''
		# Uncomment “web” and its “image” property.
		# Set the image to your locally built Canasta-OpenCSP tag. It should look something like this :

		services:
		#db:
		web:
		image: open-csp:2.0
		#elasticsearch:
		caddy:
		ports:
		- "${PORT:-80}:80"
		- "${HTTPS_PORT:-443}:443"
		#varnish:
		Launch the farm again.