Skip to content

Latest commit

 

History

History
125 lines (104 loc) · 7.09 KB

README.md

File metadata and controls

125 lines (104 loc) · 7.09 KB

wordpress-docker

Shellcheck

Easy to use docker-compose managed multi-container setup for running wordpress

  1. Features
  2. Requirements
  3. docker-compose modes
    1. Production
    2. Development
  4. Administration
  5. Install
    1. Production
    2. Development
  6. Setup wordpress
  7. Misc
    1. Email
    2. Updating wordpress
    3. Backup/Restore

Features

This repository contains files for running wordpress within a docker-compose managed multi-container setup, based on the official docker community image To enable non-tech savy people to use this repository, there are administration scripts for tasks like starting, stopping and backups included. Two docker-compose modes are available: production and develop. Check below for further information.

Requirements

  • Ubuntu > 18.04
  • Docker Engine > 20.10
  • docker-compose > 1.27.4

Software architecture

docker-compose modes

Production

  • This mode is intended for running wordpress in a production environment with a standalone caddy reverse proxy.
  • Beside listed requirements you need:
    • Domain
    • A/AAAA records pointing to your serverip
  • TLS certificates will be provided from Lets Encrypt

Development

  • This mode runs a local wordpress instance to test this project or develop plugins.
  • Beside listed requirements you need:
    • Modified hostsfile with wordpress.lan pointing to 127.0.0.1
  • TLS certificate will be a self-signed caddy-internal

Administration

  • There are two docker-compose wrapper scripts included:
    • production.sh is a wrapper for docker-compose -f docker-compose-prod.yml --env=.env.prod
    • develop.sh is a wrapper for docker-compose -f docker-compose-dev.yml --env=.env.dev
  • The wrapper scripts pass every argument to docker-compose, just with modified docker-compose file location and .env file location. Run the script without arguments to display help and available commands
  • Available commands
    • backup: creates a backup of the mysql database and container volumes
    • restore: restores mysql database and container volumes from a provided backup
    • support-zip: creates a file containing application and service logs
    • up -d: start docker containers
    • stop: stop running docker containers
    • down: stop and remove docker containers
    • down -v: remove docker containers and volumes including application data. Use with care
    • logs -f: display logs for running containers
    • ps: display status of docker containers
    • --help: display docker-compose help
  • Planned functions are
    • Viewing application/webserver logs from volumes instead of docker-compose logs -f

Install

Production

  1. Clone this repo and change directory
  2. Copy the example .env.sample file to .env.prod
  3. Copy the example config/Caddyfile.sample file to config/Caddyfile-prod
  4. Edit .env.prod and config/Caddyfile-prod and check your config with ./production.sh config
  5. If satisfied, start up your instance with ./production.sh up -d
  6. If youre getting the wordpress setup page with letsencrypt staging TLS-certificate , everything is working
  7. Stop the cluster with ./production.sh stop and comment acme_ca in config/Caddyfile-prod to receive live letsencrypt TLS-certificate
  8. Start cluster with ./production.sh up -d

Development

  1. Clone this repo and change directory
  2. Copy the example .env.sample file to .env.dev
  3. Copy the example config/Caddyfile.sample file to config/Caddyfile-dev
  4. Edit .env.dev and config/Caddyfile-dev and check your config with ./develop.sh config
  5. Start your instance with ./develop.sh up -d
  6. Access your instance on https://wordpress.lan

Setup wordpress

  1. Navigate to your wordpress page and follow instructions.

Misc

Using an external docker managed reverse proxy

  • To use an external docker managed reverse proxy and omit the default caddy webserver, docker-compose files with the no-caddy syntax are available. These files are identical to the default files beside missing the caddy configuration.
    • Adjust the COMPOSE_FILE variable in the develop.sh or production.sh files and add -nocaddy
    • Rename or copy your .env(.dev) file to .env(.dev)-nocaddy and adjust the ENV_FILE variable inside the file accordingly
    • Connect your external reverse proxy service to the reverse-proxy-net network and set external: true within the network definition in the compose file. The hostname of your wordpress service is exposed to reverse-proxy-net with the alias wordpress_$(INSTANCE_NAME)

Using an external non-docker managed reverse proxy

  • Stick to the same configuration as above, but adjust the wordpress service to bind to a localhost:port combination
  • Configure your external reverse proxy to proxy your domain to the localhost:port combination

Email

Updating wordpress

  • Use the webfrontend (auto)updater as the docker image files are only used on first start (see this Github issue)

Backup/Restore

UPDATE wp_posts SET guid = replace(guid, '$OLD_BASE_URL','$NEW_BASE_URL'); UPDATE wp_posts SET post_content = replace(post_content, '$OLD_BASE_URL', '$NEW_BASE_URL');```

      • UPDATE wp_postmeta SET meta_value = replace(meta_value,'$OLD_BASE_URL','$NEW_BASE_URL');
    • Change password of admin user
      • update wp_users SET user_pass = MD5('supersafepassword') where id=1;

Feel free to contribute, there are many improvements (check TODO strings in this repository) that still need to be made.