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

This repository has the configuration required to run the CreativeCommons.org website in a local Docker development environment.

The CreativeCommons.org website is comprised of five components that are split into two categories:

• dynamic component:
  • WordPress (Vocabulary Theme)
• static components:
  • Chooser
  • FAQ
  • Legal Tools (licenses and public domain)
  • Platform Toolkit

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 [email protected] per our reporting guidelines.

See CONTRIBUTING.md.

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

1. index-composer - A Dependency Manager for PHP
   • This container does not have a persistent service. Expect the following message when you start the services: index-composer exited with code 0
2. index-phpmyadmin - Database administration
   • localhost:8003
3. index-wpcli - The command line interface for WordPress
4. index-web - Web server (WordPress and static HTML components)
   • localhost:8080
5. index-wpdb - Database server for WordPress

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
   • creativecommons/chooser
   • creativecommons/faq
   • creativecommons/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 in 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.