farmos-docker-site

An example repository for maintaining a farmOS docker image of a custom site.

• Builds custom farmOS codebase into a docker image using Composer.
  • Example configuration to authenticate composer with private repository.
  • Deploy the custom-built farmOS site from a docker image!
• Demonstrates a method of config management.
• TODO: include example/script to export and import from DB.
• TODO: include Tugboat config.yml, demo workflow.
• Includes automated GitHub Actions:
  • Run phpcs on web/modules/custom
  • TODO: run phpunit on web/modules/custom.
  • Builds and pushes docker images:
    • Pushes to the 2.x branch creates images tagged with 2.x-dev and the commit sha.
    • Pushed tags creates images tagged with 2.x, the tag and the commit sha.
    • Images are pushed to the GitHub Container Registry here
    • Example for pushing to other Docker container registries.

Development

• Bring up the development containers. This will build the development image if it doesn't exist.

docker-compose up -d

• The web/modules/custom directory is bind mounted into the container which will override all the codebase that was built inside the image. We need to build the code base again with composer. TODO: Can this be improved?

docker-compose exec -u www-data www composer install

• With the codebase built locally you can begin developing custom modules in the web/modules/custom directory. Commit any changes made to these files.

Configuration

Site configuration can be exported and imported between different environments. This example assumes that configuration is checked into this repository after being exported from a development environment. The configuration is then built into docker images that can be deployed to production where configuration can then be imported.

NOTE: This example saves configuration outside the web root in the config directory. This is the preferred method, but requires changing the $settings['CONFIG_SYNC_DIRECTORY'] variable in settings.php. For more information see changing the storage location of the sync directory

Also see managing your site's configuration and management using Drush.