Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/StephenMiracle/frankenwp


https://github.com/StephenMiracle/frankenwp

Last synced: 10 days ago
JSON representation

Awesome Lists containing this project

README 

        
# WordPress + FrankenPHP Docker Image



An enterprise-grade WordPress image built for scale. It uses the new FrankenPHP server bundled with Caddy. Lightning-fast server side caching Caddy module.



## Getting Started



- [Docker Images](https://hub.docker.com/r/wpeverywhere/frankenwp "Docker Hub")

- [Slack](https://join.slack.com/t/wpeverywhere/shared_invite/zt-2k88x3jtv-dpJHRYJ2IDT9PNQpO96zxQ "Slack")

- [Website](https://wpeverywhere.com)



### Examples



- [Standard environment with MariaDB & Docker Compose](./examples/basic/compose.yaml)

- [Debug with XDebug & Docker Compose](./examples/debug/compose.yaml)

- [SQLite with Docker Compose](./examples/sqlite/compose.yaml)



## Whats Included



### Services



- [WordPress](https://hub.docker.com/_/wordpress "WordPress Docker Image")

- [FrankenPHP](https://hub.docker.com/r/dunglas/frankenphp "FrankenPHP Docker Image")

- [Caddy](https://caddyserver.com/ "Caddy Server")



### Caching



- opcache

- Internal server sidekick



### Environment Variables



#### FrankenPHP



- `SERVER_NAME`: change the addresses on which to listen, the provided hostnames will also be used for the generated TLS certificate

- `CADDY_GLOBAL_OPTIONS`: inject global options (debug most common)

- `FRANKENPHP_CONFIG`: inject config under the frankenphp directive



#### Sidekick Cache



- `CACHE_LOC`: Where to store cache. Defaults to /var/www/html/wp-content/cache

- `CACHE_RESPONSE_CODES`: Which status codes to cache. Defaults to 200,404,405

- `BYPASS_PATH_PREFIX`: Which path prefixes to not cache. Defaults to /wp-admin,/wp-json

- `BYPASS_HOME`: Whether to skip caching home. Defaults to false.

- `PURGE_KEY`: Create a purge key that must be validated on purge requests. Helps to prevent malicious intent. No default.

- `PURGE_PATH`: Create a custom route for the cache purge API path. Defaults to /\_\_cache/purge.

- `TTL`: Defines how long objects should be stored in cache. Defaults to 6000.



#### Wordpress



- `DB_NAME`: The WordPress database name.

- `DB_USER`: The WordPress database user.

- `DB_PASSWORD`: The WordPress database password.

- `DB_HOST`: The WordPress database host.

- `DB_TABLE_PREFIX`: The WordPress database table prefix.

- `WP_DEBUG`: Turns on WordPress Debug.

- `FORCE_HTTPS`: Tells WordPress to use https on requests. This is beneficial behind load balancer. Defaults to true.

- `WORDPRESS_CONFIG_EXTRA`: use this for adding WP_HOME, WP_SITEURL, etc



## Questions



### Why Not Just Use Standard WordPress Images?



The standard WordPress images are a good starting point and can handle many use cases, but require significant modification to scale. You also don't get FrankenPHP app server. Instead, you need to choose Apache or PHP-FPM. We use the WordPress base image but extend it with FrankenPHP & Caddy.



### Why FrankenPHP?



FrankenPHP is built on Caddy, a modern web server built in Go. It is secure & performs well when scaling becomes important. It also allows us to take advantage of built-in mature concurrency through goroutines into a single Docker image. high performance in a single lean image.



**[Check out FrankenPHP Here](https://frankenphp.dev/ "FrankenPHP")**



### Why is Non-Root User Important?



It is good practice to avoid using root users in your Docker images for security purposes. If a questionable individual gets access into your running Docker container with root account then they could have access to the cluster and all the resources it manages. This could be problematic. On the other hand, by creating a user specific to the Docker image, narrows the threat to only the image itself. It is also important to note that the base WordPress images also create non-root users by default.



### What are the Changes from Base FrankenPHP?



This custom Caddy build also includes an internal project named sidekick. It provides lightning fast cache that can be distributed among many containers. The default cache uses the local wp-content/cache directory but can use many cache services.



### How to use when behind load balancer or proxy?



_tldr: Use a port (ie :80, :8095, etc) for SERVER_NAME env variable._



Working in cloud environments like AWS can be tricky because your traffic is going through a load balancer or some proxy. This means your server name is not what you think your server name is. Your domain hits a proxy dns entry that then hits your application. The application doesn't know your domain. It knows the proxied name. This may seem strange, but it's actually a well established strong architecture pattern.



What about SSL cert? Use `SERVER_NAME=mydomain.com, :80`

Caddy, the underlying application server is flexible enough for multiple entries. Separate multiple values with a comma. It will still request certificate.



## Using in Real Projects? Join the Chat



You can join our Slack chat to ask questions or connect directly. [Connect on Slack](https://join.slack.com/t/wpeverywhere/shared_invite/zt-2k88x3jtv-dpJHRYJ2IDT9PNQpO96zxQ)