DevOps:Doc/Open CSP/2.0/Quickstart with Docker
No edit summary
m Updated script to suppress PHP warning
 
(4 intermediate revisions by the same user not shown)
Line 3: Line 3:


# Place the script below in an empty folder as <code>setup-opencsp.sh</code>.
# Place the script below in an empty folder as <code>setup-opencsp.sh</code>.
# Make sure the '''Docker Daemon''' (e.g., Docker Desktop) is running and '''Composer''' is installed locally.
# Make sure the '''Docker Daemon''' (e.g., Docker Desktop) is running.
# Make the script executable and run it (this is a one-time setup):
# Make the script executable and run it (this is a one-time setup):
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
Line 21: Line 21:
#!/bin/bash
#!/bin/bash
# setup-opencsp.sh - Zero-touch MediaWiki 1.43 + Open CSP 3.0 + OpenSearch Docker setup
# setup-opencsp.sh - Zero-touch MediaWiki 1.43 + Open CSP 3.0 + OpenSearch Docker setup
# Exit immediately if a command fails
set -e
# Prevent Git Bash on Windows from converting Linux paths
export MSYS_NO_PATHCONV=1


MW_VERSION="1.43.0"
MW_VERSION="1.43.0"
Line 34: Line 40:
mkdir -p mediawiki
mkdir -p mediawiki


# 2. Create Dockerfile (including Chromium and PHP extensions zip, exif, sockets)
# 2. Create Dockerfile (including Composer, Git, Chromium, PHP extensions, and suppressed warnings)
echo "🐳 Creating Dockerfile..."
echo "🐳 Creating Dockerfile..."
cat << 'EOF' > Dockerfile
cat << 'EOF' > Dockerfile
FROM mediawiki:1.43
FROM mediawiki:1.43
# Add Composer directly into the container
COPY --from=composer:2 /usr/bin/composer /usr/bin/composer
ENV COMPOSER_ALLOW_SUPERUSER=1
ENV COMPOSER_ROOT_VERSION=1.43.0


RUN apt-get update && apt-get install -y \
RUN apt-get update && apt-get install -y \
    git \
     libzip-dev \
     libzip-dev \
    libpng-dev \
    libjpeg62-turbo-dev \
    libfreetype6-dev \
     unzip \
     unzip \
     chromium \
     chromium \
     && docker-php-ext-install zip exif sockets \
    && docker-php-ext-configure gd --with-freetype --with-jpeg \
     && docker-php-ext-install zip exif sockets gd \
    && composer config --global policy.advisories.block false \
    && printf "display_errors = Off\nerror_reporting = E_ALL & ~E_WARNING & ~E_DEPRECATED & ~E_NOTICE\n" > /usr/local/etc/php/conf.d/zzz-opencsp-errors.ini \
     && apt-get clean && rm -rf /var/lib/apt/lists/*
     && apt-get clean && rm -rf /var/lib/apt/lists/*
EOF
EOF
Line 87: Line 105:
EOF
EOF


# 4. Download MediaWiki if the directory is still empty
# 4. Download and extract MediaWiki directly into ./mediawiki
if [ ! -f "mediawiki/index.php" ]; then
if [ ! -f "mediawiki/index.php" ]; then
     echo "📥 Downloading MediaWiki $MW_VERSION..."
     echo "📥 Downloading MediaWiki $MW_VERSION..."
     curl -O https://releases.wikimedia.org/mediawiki/${MW_MAJOR}/mediawiki-${MW_VERSION}.tar.gz
     curl -fSL -O "https://releases.wikimedia.org/mediawiki/${MW_MAJOR}/mediawiki-${MW_VERSION}.tar.gz"
     tar -xzf mediawiki-${MW_VERSION}.tar.gz
    echo "📦 Extracting MediaWiki directly into ./mediawiki..."
    mv mediawiki-${MW_VERSION}/* mediawiki/
     tar -xzf "mediawiki-${MW_VERSION}.tar.gz" -C mediawiki --strip-components=1
     rm -rf mediawiki-${MW_VERSION} mediawiki-${MW_VERSION}.tar.gz
     rm -f "mediawiki-${MW_VERSION}.tar.gz"
fi
fi


Line 102: Line 120:
# 6. Wait for MariaDB to be ready before running the CLI installer
# 6. Wait for MariaDB to be ready before running the CLI installer
echo "⏳ Waiting for MariaDB database to initialize..."
echo "⏳ Waiting for MariaDB database to initialize..."
until docker compose exec -T db mariadb -uwikiuser -pwikipassword -e "SELECT 1;" >/dev/null 2>&1; do
until docker compose exec -T db mariadb -uwikiuser -pwikipassword -e "SELECT 1;" < /dev/null >/dev/null 2>&1; do
     sleep 2
     sleep 2
done
done
Line 109: Line 127:
if [ ! -f "mediawiki/LocalSettings.php" ]; then
if [ ! -f "mediawiki/LocalSettings.php" ]; then
     echo "⚙️  Running MediaWiki CLI installer..."
     echo "⚙️  Running MediaWiki CLI installer..."
     docker compose exec mediawiki php maintenance/run.php install \
     docker compose exec -T mediawiki php maintenance/run.php install \
         --dbname=opencsp_wiki \
         --dbname=opencsp_wiki \
         --dbuser=wikiuser \
         --dbuser=wikiuser \
Line 119: Line 137:
         --pass="$ADMIN_PASS" \
         --pass="$ADMIN_PASS" \
         "$WIKI_NAME" \
         "$WIKI_NAME" \
         "$ADMIN_USER"
         "$ADMIN_USER" < /dev/null
fi
fi


# 8. Create temp directory with write permissions for UUID generation
# 8. Download Open CSP codebase
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..."
echo "📥 Downloading Open CSP (REL1_43) from Git..."
rm -rf temp-opencsp
git clone https://github.com/Open-CSP/open-csp.git --branch REL1_43 --single-branch temp-opencsp
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 -f temp-opencsp/composer.local.json ./mediawiki/
Line 134: Line 148:
cp -rf temp-opencsp/skin ./mediawiki/
cp -rf temp-opencsp/skin ./mediawiki/
cp -rf temp-opencsp/wsps ./mediawiki/
cp -rf temp-opencsp/wsps ./mediawiki/
if [ ! -d "mediawiki/logo" ]; then
    cp -rf temp-opencsp/logo ./mediawiki/
else
    echo "Skipping copying logo folder (already exists)."
fi
rm -rf temp-opencsp
rm -rf temp-opencsp


# 10. Automatically patch CSPSettings.php and LocalSettings.php
# 9. Automatically patch CSPSettings.php and LocalSettings.php
echo "⚙️  Configuring CSPSettings.php and LocalSettings.php for Open CSP and OpenSearch..."
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 \
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
     && 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
if ! grep -q "wfLoadExtension( 'Bootstrap' )" mediawiki/settings/CSPSettings.php; then
     printf "\nwfLoadExtension( 'Bootstrap' );\n" >> mediawiki/settings/CSPSettings.php
     printf "\nwfLoadExtension( 'Bootstrap' );\n" >> mediawiki/settings/CSPSettings.php
fi
fi


# Append Open CSP configuration to LocalSettings.php
if ! grep -q "CSPSettings.php" mediawiki/LocalSettings.php; then
cat << 'EOF' >> mediawiki/LocalSettings.php
cat << 'EOF' >> mediawiki/LocalSettings.php


Line 160: Line 177:
require_once( __DIR__ . '/settings/CSPSettings.php' );
require_once( __DIR__ . '/settings/CSPSettings.php' );
$smwgElasticsearchEndpoints = [ 'opensearch:9200' ];
$smwgElasticsearchEndpoints = [ 'opensearch:9200' ];
# Suppress PHP warnings, notices, and deprecation messages
error_reporting( E_ALL & ~E_WARNING & ~E_DEPRECATED & ~E_NOTICE );
ini_set( 'display_errors', '0' );
EOF
EOF
fi


# 11. Install Composer Dependencies
# 10. Install Composer Dependencies inside the Docker container
echo "📦 Installing Composer packages (requires local Composer)..."
echo "📦 Installing Composer packages inside Docker..."
cd mediawiki
docker compose exec -T mediawiki composer config repositories.38 composer https://gitlab.wikibase.nl/api/v4/group/38/-/packages/composer/ < /dev/null
composer config repositories.38 composer https://gitlab.wikibase.nl/api/v4/group/38/-/packages/composer/
docker compose exec -T mediawiki composer config policy.advisories.block false < /dev/null
composer update --no-dev --ignore-platform-reqs
docker compose exec -T mediawiki composer update --no-dev --ansi < /dev/null
composer update -d extensions/Widgets --no-dev --ignore-platform-reqs
docker compose exec -T mediawiki composer update -d extensions/Widgets --no-dev --ansi < /dev/null
cd ..
 
# 11. Pre-create temp directories before running maintenance scripts
echo "📁 Preparing required temp directories..."
docker compose exec -T mediawiki bash -c "mkdir -p /var/www/html/images/temp /var/www/html/wsps /var/www/html/extensions/Widgets/compiled_templates /var/www/html/extensions/PageSync/Temp /var/www/html/extensions/FlexForm/temp /var/www/html/extensions/FlexForm/Temp" < /dev/null


# 12. Run Maintenance Scripts
# 12. Run Maintenance Scripts
echo "🛠️  Updating database and creating tables..."
echo "🛠️  Updating database and creating tables..."
docker compose exec mediawiki php maintenance/update.php --quick
docker compose exec -T mediawiki php maintenance/update.php --quick < /dev/null


echo "🛠️  Setting up Semantic MediaWiki..."
echo "🛠️  Setting up Semantic MediaWiki..."
docker compose exec mediawiki php extensions/SemanticMediaWiki/maintenance/updateEntityCountMap.php
docker compose exec -T mediawiki php extensions/SemanticMediaWiki/maintenance/updateEntityCountMap.php < /dev/null
docker compose exec mediawiki php extensions/SemanticMediaWiki/maintenance/setupStore.php
docker compose exec -T mediawiki php extensions/SemanticMediaWiki/maintenance/setupStore.php < /dev/null
docker compose exec mediawiki php extensions/SemanticMediaWiki/maintenance/rebuildElasticIndex.php
docker compose exec -T mediawiki php extensions/SemanticMediaWiki/maintenance/rebuildElasticIndex.php < /dev/null


echo "📄 Running PageSync..."
echo "📄 Running PageSync..."
docker compose exec mediawiki php extensions/PageSync/maintenance/WspsMaintenance.php --user="$ADMIN_USER"
docker compose exec -T mediawiki php extensions/PageSync/maintenance/WspsMaintenance.php --user="$ADMIN_USER" < /dev/null
 
# 13. Set write permissions across all extensions, uploads, cache, and PageSync folders
echo "🔒 Setting final permissions for Apache (www-data) across all extensions..."
docker compose exec -T mediawiki bash -c "chown -R www-data:www-data /var/www/html && chmod -R 777 /var/www/html/images /var/www/html/wsps /var/www/html/cache /var/www/html/extensions" < /dev/null


echo ""
echo ""
echo "✅ Setup complete! Your Open CSP development environment is running at http://localhost:8080"
echo "✅ Setup complete! Your Open CSP development environment is running at http://localhost:8080"
echo "🔑 Login with user: $ADMIN_USER and password: $ADMIN_PASS"
echo "🔑 Login with user: $ADMIN_USER and password: $ADMIN_PASS"
</syntaxhighlight>
echo ""
read -p "Press Enter to exit..."
</syntaxhighlight>When you are done. Go to this page for installing additional content: [[DevOps:Doc/Open CSP/2.0/Additional content]]

Latest revision as of 14:16, 12 November 2026

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

# Exit immediately if a command fails
set -e

# Prevent Git Bash on Windows from converting Linux paths
export MSYS_NO_PATHCONV=1

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 Composer, Git, Chromium, PHP extensions, and suppressed warnings)
echo "🐳 Creating Dockerfile..."
cat << 'EOF' > Dockerfile
FROM mediawiki:1.43

# Add Composer directly into the container
COPY --from=composer:2 /usr/bin/composer /usr/bin/composer
ENV COMPOSER_ALLOW_SUPERUSER=1
ENV COMPOSER_ROOT_VERSION=1.43.0

RUN apt-get update && apt-get install -y \
    git \
    libzip-dev \
    libpng-dev \
    libjpeg62-turbo-dev \
    libfreetype6-dev \
    unzip \
    chromium \
    && docker-php-ext-configure gd --with-freetype --with-jpeg \
    && docker-php-ext-install zip exif sockets gd \
    && composer config --global policy.advisories.block false \
    && printf "display_errors = Off\nerror_reporting = E_ALL & ~E_WARNING & ~E_DEPRECATED & ~E_NOTICE\n" > /usr/local/etc/php/conf.d/zzz-opencsp-errors.ini \
    && 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 and extract MediaWiki directly into ./mediawiki
if [ ! -f "mediawiki/index.php" ]; then
    echo "📥 Downloading MediaWiki $MW_VERSION..."
    curl -fSL -O "https://releases.wikimedia.org/mediawiki/${MW_MAJOR}/mediawiki-${MW_VERSION}.tar.gz"
    echo "📦 Extracting MediaWiki directly into ./mediawiki..."
    tar -xzf "mediawiki-${MW_VERSION}.tar.gz" -C mediawiki --strip-components=1
    rm -f "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 >/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 -T 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" < /dev/null
fi

# 8. Download Open CSP codebase
echo "📥 Downloading Open CSP (REL1_43) from Git..."
rm -rf temp-opencsp
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/
if [ ! -d "mediawiki/logo" ]; then
    cp -rf temp-opencsp/logo ./mediawiki/
else
    echo "Skipping copying logo folder (already exists)."
fi
rm -rf temp-opencsp

# 9. Automatically patch CSPSettings.php and LocalSettings.php
echo "⚙️  Configuring CSPSettings.php and LocalSettings.php for Open CSP and OpenSearch..."

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

if ! grep -q "wfLoadExtension( 'Bootstrap' )" mediawiki/settings/CSPSettings.php; then
    printf "\nwfLoadExtension( 'Bootstrap' );\n" >> mediawiki/settings/CSPSettings.php
fi

if ! grep -q "CSPSettings.php" mediawiki/LocalSettings.php; then
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' ];

# Suppress PHP warnings, notices, and deprecation messages
error_reporting( E_ALL & ~E_WARNING & ~E_DEPRECATED & ~E_NOTICE );
ini_set( 'display_errors', '0' );
EOF
fi

# 10. Install Composer Dependencies inside the Docker container
echo "📦 Installing Composer packages inside Docker..."
docker compose exec -T mediawiki composer config repositories.38 composer https://gitlab.wikibase.nl/api/v4/group/38/-/packages/composer/ < /dev/null
docker compose exec -T mediawiki composer config policy.advisories.block false < /dev/null
docker compose exec -T mediawiki composer update --no-dev --ansi < /dev/null
docker compose exec -T mediawiki composer update -d extensions/Widgets --no-dev --ansi < /dev/null

# 11. Pre-create temp directories before running maintenance scripts
echo "📁 Preparing required temp directories..."
docker compose exec -T mediawiki bash -c "mkdir -p /var/www/html/images/temp /var/www/html/wsps /var/www/html/extensions/Widgets/compiled_templates /var/www/html/extensions/PageSync/Temp /var/www/html/extensions/FlexForm/temp /var/www/html/extensions/FlexForm/Temp" < /dev/null

# 12. Run Maintenance Scripts
echo "🛠️  Updating database and creating tables..."
docker compose exec -T mediawiki php maintenance/update.php --quick < /dev/null

echo "🛠️  Setting up Semantic MediaWiki..."
docker compose exec -T mediawiki php extensions/SemanticMediaWiki/maintenance/updateEntityCountMap.php < /dev/null
docker compose exec -T mediawiki php extensions/SemanticMediaWiki/maintenance/setupStore.php < /dev/null
docker compose exec -T mediawiki php extensions/SemanticMediaWiki/maintenance/rebuildElasticIndex.php < /dev/null

echo "📄 Running PageSync..."
docker compose exec -T mediawiki php extensions/PageSync/maintenance/WspsMaintenance.php --user="$ADMIN_USER" < /dev/null

# 13. Set write permissions across all extensions, uploads, cache, and PageSync folders
echo "🔒 Setting final permissions for Apache (www-data) across all extensions..."
docker compose exec -T mediawiki bash -c "chown -R www-data:www-data /var/www/html && chmod -R 777 /var/www/html/images /var/www/html/wsps /var/www/html/cache /var/www/html/extensions" < /dev/null

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"
echo ""
read -p "Press Enter to exit..."

When you are done. Go to this page for installing additional content: Additional content