Revision as of 12:40, 12 November 2026 by Admin (talk | contribs)

DevOps:Doc/Open CSP/2.0/Quickstart with Docker

Local Open CSP 3.0 Development Environment

Want to test Open CSP 3.0 (MediaWiki 1.43 + OpenSearch) or develop extensions locally with instant code updates in your IDE?

  1. Place the script below in an empty folder as setup-opencsp.sh.
  2. Make sure the Docker Daemon (e.g., Docker Desktop) is running and Composer is installed locally.
  3. Make the script executable and run it (this is a one-time setup):
chmod +x setup-opencsp.sh
./setup-opencsp.sh

The script automatically generates your Dockerfile and docker-compose.yml, downloads MediaWiki 1.43 and Open CSP 3.0 into a local ./mediawiki folder, initializes the database, and configures OpenSearch and PageSync. Because the entire codebase is mounted locally, all changes you make in your IDE (such as PHPStorm or VS Code) are instantly live in the container.

Default Login Credentials:

  • URL: http://localhost:8080
  • Username: Admin
  • Password: OpenCSP123!

Daily usage: The next day, simply open your terminal in the root folder and run:

docker compose up -d

Created with a little help from Gemini Argon.

#!/bin/bash
# setup-opencsp.sh - Zero-touch MediaWiki 1.43 + Open CSP 3.0 + OpenSearch Docker setup

MW_VERSION="1.43.0"
MW_MAJOR="1.43"
WIKI_NAME="Open CSP"
ADMIN_USER="Admin"
ADMIN_PASS="OpenCSP123!"

echo "๐Ÿš€ Starting Automated Open CSP Docker Development Setup..."

# 1. Prepare directory structure
echo "๐Ÿ“ Preparing directory structure..."
mkdir -p mediawiki

# 2. Create Dockerfile (including Chromium and PHP extensions zip, exif, sockets)
echo "๐Ÿณ Creating Dockerfile..."
cat << 'EOF' > Dockerfile
FROM mediawiki:1.43

RUN apt-get update && apt-get install -y \
    libzip-dev \
    unzip \
    chromium \
    && docker-php-ext-install zip exif sockets \
    && apt-get clean && rm -rf /var/lib/apt/lists/*
EOF

# 3. Generate docker-compose.yml (Using OpenSearch instead of ElasticSearch)
echo "๐Ÿณ Creating docker-compose.yml..."
cat << 'EOF' > docker-compose.yml
services:
  mediawiki:
    build: .
    ports:
      - "8080:80"
    volumes:
      - ./mediawiki:/var/www/html
    depends_on:
      - db
      - opensearch

  db:
    image: mariadb:10.11
    environment:
      MYSQL_ROOT_PASSWORD: root
      MYSQL_DATABASE: opencsp_wiki
      MYSQL_USER: wikiuser
      MYSQL_PASSWORD: wikipassword
    volumes:
      - db_data:/var/lib/mysql

  opensearch:
    image: opensearchproject/opensearch:latest
    environment:
      - discovery.type=single-node
      - DISABLE_SECURITY_PLUGIN=true
      - "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m"
    ports:
      - "9200:9200"
    volumes:
      - opensearch_data:/usr/share/opensearch/data

volumes:
  db_data:
  opensearch_data:
EOF

# 4. Download MediaWiki if the directory is still empty
if [ ! -f "mediawiki/index.php" ]; then
    echo "๐Ÿ“ฅ Downloading MediaWiki $MW_VERSION..."
    curl -O https://releases.wikimedia.org/mediawiki/${MW_MAJOR}/mediawiki-${MW_VERSION}.tar.gz
    tar -xzf mediawiki-${MW_VERSION}.tar.gz
    mv mediawiki-${MW_VERSION}/* mediawiki/
    rm -rf mediawiki-${MW_VERSION} mediawiki-${MW_VERSION}.tar.gz
fi

# 5. Build and start Docker containers
echo "๐Ÿณ Building and starting Docker containers..."
docker compose up -d --build

# 6. Wait for MariaDB to be ready before running the CLI installer
echo "โณ Waiting for MariaDB database to initialize..."
until docker compose exec -T db mariadb -uwikiuser -pwikipassword -e "SELECT 1;" >/dev/null 2>&1; do
    sleep 2
done

# 7. Run automated MediaWiki CLI installation
if [ ! -f "mediawiki/LocalSettings.php" ]; then
    echo "โš™๏ธ  Running MediaWiki CLI installer..."
    docker compose exec mediawiki php maintenance/run.php install \
        --dbname=opencsp_wiki \
        --dbuser=wikiuser \
        --dbpass=wikipassword \
        --dbserver=db \
        --server="http://localhost:8080" \
        --scriptpath="" \
        --lang=en \
        --pass="$ADMIN_PASS" \
        "$WIKI_NAME" \
        "$ADMIN_USER"
fi

# 8. Create temp directory with write permissions for UUID generation
echo "๐Ÿ“ Creating images/temp directory..."
mkdir -p mediawiki/images/temp
chmod 777 mediawiki/images/temp

# 9. Download Open CSP codebase
echo "๐Ÿ“ฅ Downloading Open CSP (REL1_43) from Git..."
git clone https://github.com/Open-CSP/open-csp.git --branch REL1_43 --single-branch temp-opencsp
cp -f temp-opencsp/composer.local.json ./mediawiki/
cp -rf temp-opencsp/settings ./mediawiki/
cp -rf temp-opencsp/skin ./mediawiki/
cp -rf temp-opencsp/wsps ./mediawiki/
rm -rf temp-opencsp

# 10. Automatically patch CSPSettings.php and LocalSettings.php
echo "โš™๏ธ  Configuring CSPSettings.php and LocalSettings.php for Open CSP and OpenSearch..."

# Update endpoint in CSPSettings.php (cross-platform compatible for macOS & Linux)
sed "s/\$smwgElasticsearchEndpoints.*/\$smwgElasticsearchEndpoints = [ 'opensearch:9200' ];/" mediawiki/settings/CSPSettings.php > mediawiki/settings/CSPSettings.php.tmp \
    && mv mediawiki/settings/CSPSettings.php.tmp mediawiki/settings/CSPSettings.php

# Ensure Bootstrap is loaded in CSPSettings.php if not already present
if ! grep -q "wfLoadExtension( 'Bootstrap' )" mediawiki/settings/CSPSettings.php; then
    printf "\nwfLoadExtension( 'Bootstrap' );\n" >> mediawiki/settings/CSPSettings.php
fi

# Append Open CSP configuration to LocalSettings.php
cat << 'EOF' >> mediawiki/LocalSettings.php

# --- Added by Automated Open CSP Setup ---
$wgEnableUploads = true;
$wgFileExtensions = [
    'png', 'gif', 'jpg', 'jpeg', 'doc', 'xls', 'mpp', 'pdf', 'ppt', 'tiff',
    'bmp', 'docx', 'xlsx', 'pptx', 'ps', 'odt', 'ods', 'odp', 'odg', 'zip'
];
wfLoadExtension( 'Bootstrap' );
require_once( __DIR__ . '/settings/CSPSettings.php' );
$smwgElasticsearchEndpoints = [ 'opensearch:9200' ];
EOF

# 11. Install Composer Dependencies
echo "๐Ÿ“ฆ Installing Composer packages (requires local Composer)..."
cd mediawiki
composer config repositories.38 composer https://gitlab.wikibase.nl/api/v4/group/38/-/packages/composer/
composer update --no-dev --ignore-platform-reqs
composer update -d extensions/Widgets --no-dev --ignore-platform-reqs
cd ..

# 12. Run Maintenance Scripts
echo "๐Ÿ› ๏ธ  Updating database and creating tables..."
docker compose exec mediawiki php maintenance/update.php --quick

echo "๐Ÿ› ๏ธ  Setting up Semantic MediaWiki..."
docker compose exec mediawiki php extensions/SemanticMediaWiki/maintenance/updateEntityCountMap.php
docker compose exec mediawiki php extensions/SemanticMediaWiki/maintenance/setupStore.php
docker compose exec mediawiki php extensions/SemanticMediaWiki/maintenance/rebuildElasticIndex.php

echo "๐Ÿ“„ Running PageSync..."
docker compose exec mediawiki php extensions/PageSync/maintenance/WspsMaintenance.php --user="$ADMIN_USER"

echo ""
echo "โœ… Setup complete! Your Open CSP development environment is running at http://localhost:8080"
echo "๐Ÿ”‘ Login with user: $ADMIN_USER and password: $ADMIN_PASS"