public-wiki

Development Creative Commons (CC) Public Wiki

Overview

The aim of the project is to establish a robust and localized development environment for MediaWiki using Docker. This repository should represent the most advanced and closest implementation of the 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.

Docker containers

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

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

Dev configuration

Apache2

See config/web-sites-available/000-default.conf.

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

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

Related development links

• creativecommons/index-dev-env: Local development environment for CreativeCommons.org (product name: index)
• creativecommons/sre-salt-prime: Site Reliability Engineering / DevOps SaltStack configuration files

Development

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)
2. Prepare and install prek Git hooks:

   prek install --prepare-hooks

Setup

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

   cp .env.example .env

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

   docker-compose up

4. Wait for the build and initialization to complete

License

• LICENSE (Expat/MIT License)