index-dev-env

Local development environment for CreativeCommons.org (project name: index).

This repository manages the local development environment for CreativeCommons.org (project name: index). It relies on Docker and requires the component repositories.

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.

See CONTRIBUTING.md.

The CreativeCommons.org website (project name: index) is comprised of five components that are split into two categories:

1. Static components

• CC Legal Tools ("licenses")
• Chooser
• FAQ
• Platform Toolkit

2. Dynamic component

• WordPress (Vocabulary Theme)

The following URIs and their children/subpaths mustn't be used by WordPress. They are reserved for the static components:

These URIs are controlled by Apache2 configurations:

• Dev: config/web-sites-available/000-default.conf
• Prod: sre-salt-prime: states/apache2/files/index.conf
  • (Also see Stage and Prod configuration, below)
• shared: cc-legal-tools-data: config/language-redirects

WordPress is the default handler for URIs. WordPress handles all URIs except the Static component URIs, listed above.

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

1. index-db - Database server for WordPress
2. index-phpmyadmin - Database administration
   • localhost:8003
3. index-web - Web server (WordPress and static HTML components)
   • localhost:8080

1. Ensure the following repositories are cloned adjacent to this repository:

   PARENT_DIR
   ├── cc-legal-tools-data
   ├── chooser
   ├── dev-index-env
   ├── faq
   └── mp
   

   • [creativecommons/cc-legal-tools-data][gh-data]
   • [creativecommons/chooser][gh-chooser]
   • [creativecommons/faq][gh-faq]
   • [creativecommons/mp][gh-mp]
2. Create the .env file:

   cp .env.example .env

3. Update .env to set desired values for variables (WP_VERSION, WP_MOD_TYPE, WP_MOD_NAME, etc.)
4. Build/start Docker:

   docker compose up

5. Wait for build and initialization to complete
6. Setup WordPress:

   ./setup-wordpress.sh

7. Optional (CC staff only): import production data
   1. Ensure you have access to the production server and your local machine is properly configured to access it
   2. Pull production data

      ./staff_migrate.sh pull

   3. Import production data

      ./staff_migrate.sh import

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

Also see .env.example.

Also see config/composer/composer.json.

Also see config/composer/composer.json.

The staging server and production server are configured via Salt managed in the creativecommons/sre-salt-prime repository. The list below include the specifics (is non-exhaustive):

• pillars/
  • 3_HST/index/
  • 5_HST__POD/index__stage
• states/
  • apache2/files/index.conf
  • wordpress/files/index-composer.json
  • wordpress/index.sls

COPYING: All the content within this repository is dedicated to the public domain under the CC0 1.0 Universal (CC0 1.0) Public Domain Dedication.