Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chriszarate/docker-wordpress-vip
A Docker-based development environment for WordPress VIP development
https://github.com/chriszarate/docker-wordpress-vip
docker docker-compose photon wordpress wordpress-vip
Last synced: 2 months ago
JSON representation
A Docker-based development environment for WordPress VIP development
- Host: GitHub
- URL: https://github.com/chriszarate/docker-wordpress-vip
- Owner: chriszarate
- Created: 2016-07-17T04:12:00.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-12-24T23:35:57.000Z (about 7 years ago)
- Last Synced: 2024-10-09T05:06:23.879Z (3 months ago)
- Topics: docker, docker-compose, photon, wordpress, wordpress-vip
- Language: Shell
- Homepage:
- Size: 38.1 KB
- Stars: 17
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WordPress VIP development for Docker
This repo provides a Docker-based development environment for [WordPress VIP][vip]
development. Via [chriszarate/wordpress][image], it runs on PHP7 and adds
WP-CLI, PHPUnit, Xdebug, and the WordPress unit testing suite. It further adds
VIP shared plugins, VIP mu-plugins, a [Photon][photon] server, and the
development plugins provided by VIP Quickstart.
If you only need Docker WordPress development environment for a single plugin or
theme, my [docker-compose-wordpress][simple] repo is a simpler place to start.
# VIP Go
For an environment suitable for VIP Go development, check out my
[docker-wordpress-vip-go][vip-go] repo.
## Set up
1. Add `project.test` (or your chosen TLD) to your `/etc/hosts` file:
```
127.0.0.1 localhost project.test
```
If you choose a different TLD, edit `.env` as well.
2. Edit `setup.sh` to check out your organization’s code into the `src`
subfolder (look for `test-theme` in the final section). Then, adjust the
`services/wordpress/volumes` section of `docker-compose.yml` to reflect your
changes.
3. Run `./setup.sh`.
4. Run `docker-compose up -d`.
## Interacting with containers
**Refer to [docker-compose-wordpress][simple] for general instructions** on how
to interact with the stack, including WP-CLI, PHPUnit, Xdebug, and preloading
content.
The main difference with this stack is that all code is synced to the WordPress
container from the `src` subfolder and, generally, is assumed to be its own
separate repo.
## Configuration
Put project-specific WordPress config in `conf/wp-local-config.php` and PHP ini
changes in `conf/php-local.ini`, which are synced to the container. PHP ini
changes are only reflected when the container restarts. You may also adjust the
Nginx config of the reverse proxy container via `conf/nginx-proxy.conf`.
## Photon
A [Photon][photon] server is included and enabled by default to more closely
mimic the WordPress VIP production environment. Requests to `/wp-content/uploads`
will be proxied to the Photon container—simply append Photon-compatible query
string parameters to the URL.
## Memcached
A Memcached server and `object-cache.php` drop-in are available via the separate
`docker-compose.memcached.yml` but are not enabled by default. To use it, either
manually merge it into the main `docker-compose.yml` or reference it explicitly
when interacting with the stack:
```
docker-compose -f docker-compose.yml -f docker-compose.memcached.yml up -d
```
## HTTPS support
This repo provide HTTPS support out of the box. The setup script generates
self-signed certificates for the domain specified in `.env`. You may wish to add
the generated root certificate to your system’s trusted root certificates. This
will allow you to browse your dev environment over HTTPS without accepting a
browser security warning. On OS X:
```sh
sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain certs/ca-root/ca.crt
```
If you do not want to use HTTPS, add `HTTPS_METHOD: "nohttps"` to the
`services/proxy/environment` section of `docker-compose.yml`.
## Multiple environments
Multiple instances of this dev environment are possible. Make an additional copy
of this repo with a different folder name. Then, either juggle them by stopping
one and starting another, or modify `/etc/hosts` and `.env` to use another
domain, e.g., `project2.test`.
## Troubleshooting
If your stack is not responding, the most likely cause is that a container has
stopped or failed to start. Check to see if all of the containers are "Up":
```
docker-compose ps
```
If not, inspect the logs for that container, e.g.:
```
docker-compose logs wordpress
```
Usually, the error is apparent in the logs or the last task that ran failed. If
your `wordpress` container fails on `wp core install` or `wp plugin activate`,
that usually means that code you are syncing to the container produces a fatal
error that prevents WP-CLI from running.
Running `setup.sh` again can also help resolve problems.
If your self-signed certs have expired (`ERR_CERT_DATE_INVALID`), simply delete
the `certs/self-signed` directory and run `./certs/create-certs.sh`.
[vip]: https://vip.wordpress.com
[photon]: https://jetpack.com/support/photon/
[image]: https://hub.docker.com/r/chriszarate/wordpress/
[simple]: https://github.com/chriszarate/docker-compose-wordpress
[vip-go]: https://github.com/chriszarate/docker-wordpress-vip-go