public-wiki

Creative Commons (CC) Public Wiki

Overview

The goals of this project are to:

1. Maintain the Package public-wiki in support of the CC Public Wiki remote production Railway environment
2. Maintain the CC Public Wiki local Docker development environment
3. Maintain parity between production and development environments

Production website: CC Public Wiki

Code of Conduct

CODE_OF_CONDUCT.md:

The Creative Commons team is committed to fostering a welcoming community. This project and all other Creative Commons open source projects are governed by our Code of Conduct. Please report unacceptable behavior to conduct@creativecommons.org per our reporting guidelines.

Contributing

See CONTRIBUTING.md and the Development section, below.

Development

Docker containers

The docker-compose.yml file defines the following containers:

• web - Web server (Apache2/MediaWiki)
  • localhost:8080
• db - Database server (MySQL)

Dependencies

1. Install dependencies macOS installation example:

   brew install hadolint prek railway rsync shellcheck

   1. Docker (Get Docker | Docker Docs)
   2. Install hadolint (Install - hadolint/hadolint)
   3. Install prek (Installation - j178/prek)
   4. Install Railway CLI (Installing - CLI | Railway Docs)
   5. Install Rsync (rsync download)
   6. Install shellcheck (Installing - koalaman/shellcheck)

Setup

1. Prepare and install prek Git hooks:

   prek install --prepare-hooks

2. Create the enviornment .env file by copying .env.example:

   cp .env.example .env

3. Update .env to ensure all variable have appropriate values.
4. Build and start Docker:

   docker-compose up

5. Wait for the build and initialization to complete

Web container configuration

See the config/configure_* configuration scripts called from [config/startupservice.sh][config/startupservice.sh].

MediaWiki configuration

Name	Version	Notes
MediaWiki	1.43.6	Packaged for Debian 13 (trixie)

Also see:

• .env.example.
• config/configure_mediawiki.sh

Migration from legacy server

The legacy migration directory has been deleted. Links below are to commit e1ea34af3cc8151df8e73d80b2d0c2e7dff2d5e8.

• migrate/
  • README.md
    • Includes related Debian, Docker, and MediaWiki documentation links

License

• LICENSE (Expat/MIT License)