Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .cc-metadata.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Whether this GitHub repo is engineering related
engineering_project: false
engineering_project: true
# Name of the repository/project in English
english_name: Creative Commons Public Wiki
english_name: Creative Commons (CC) Public Wiki
# All technologies used
technologies: MediaWiki, Debian, Docker
# Whether this repository should be featured on the CC Open Source site
Expand Down
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,3 @@ Thumbs.db
# Local configuration
.env
.railway_token

# Caches
cache/
98 changes: 45 additions & 53 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
# public-wiki

_Development_ Creative Commons (CC) Public Wiki
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](https://wiki.creativecommons.org).
The goals of this project are to:
1. Maintain the [Package public-wiki][public-wiki-pkg] 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](https://wiki.creativecommons.org/)

[public-wiki-pkg]: https://github.com/creativecommons/public-wiki/pkgs/container/public-wiki


## Code of Conduct
Expand All @@ -33,7 +38,10 @@ section, below.
[org-contrib]: https://github.com/creativecommons/.github/blob/main/CONTRIBUTING.md


## Docker containers
## Development


### Docker containers

The [`docker-compose.yml`](docker-compose.yml) file defines the following
containers:
Expand All @@ -42,48 +50,6 @@ containers:
- **db** - Database server (MySQL)


## Dev configuration


### Apache2

See [`config/web-sites-available/000-default.conf`][dev-webconfig].

[dev-webconfig]: 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`](.env.example).
- [`config/configure_mediawiki.sh`](config/configure_mediawiki.sh)


### Migration from legacy server

- [`migrate/`](migrate/)
- [`README.md`](migrate/README.md)
- Includes related Debian, Docker, and MediaWiki documentation links


### Related development links

- [creativecommons/index-dev-env][index-dev-env]: _Local development
environment for CreativeCommons.org (product name: index)_
- [creativecommons/sre-salt-prime][sre-salt-prime]: _Site Reliability
Engineering / DevOps SaltStack configuration files_

[index-dev-env]: https://github.com/creativecommons/index-dev-env
[sre-salt-prime]: https://github.com/creativecommons/sre-salt-prime


## Development


### Dependencies

1. Install dependencies
Expand All @@ -98,10 +64,6 @@ Also see:
5. Install Rsync ([rsync download][rsync-install])
6. Install shellcheck ([Installing -
koalaman/shellcheck][shellcheck-install])
2. Prepare and install prek Git hooks:
```shell
prek install --prepare-hooks
```

[docker-install]: https://docs.docker.com/get-started/get-docker/
[hadolint-install]: https://github.com/hadolint/hadolint#install
Expand All @@ -113,7 +75,11 @@ Also see:

## Setup

1. Create the enviornment `.env` file by copying
1. Prepare and install prek Git hooks:
```shell
prek install --prepare-hooks
```
2. Create the enviornment `.env` file by copying
[`.env.example`](.env.example):
```shell
cp .env.example .env
Expand All @@ -126,6 +92,32 @@ Also see:
4. 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`](.env.example).
- [`config/configure_mediawiki.sh`](config/configure_mediawiki.sh)


## Migration from legacy server

The legacy migration directory has been deleted. Links below are to commit `e1ea34af3cc8151df8e73d80b2d0c2e7dff2d5e8`.
- [`migrate/`][migrate-dir]
- [`README.md`][migrate-readme]
- Includes related Debian, Docker, and MediaWiki documentation links

[migrate-dir]: https://github.com/creativecommons/public-wiki/tree/e1ea34af3cc8151df8e73d80b2d0c2e7dff2d5e8/migrate
[migrate-readme]: https://github.com/creativecommons/public-wiki/blob/e1ea34af3cc8151df8e73d80b2d0c2e7dff2d5e8/migrate/README.md


## License

Expand Down
File renamed without changes.
File renamed without changes.
4 changes: 4 additions & 0 deletions cache/pull/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Ignore everything in this directory
*
# Except this file
!.gitignore
69 changes: 0 additions & 69 deletions migrate/Dockerfile.bullseye

This file was deleted.

Loading
Loading