pixelfed/contrib/docker/README.md

215 lines
5.5 KiB
Markdown
Raw Normal View History

# Pixelfed Docker images
## Runtimes
The Pixelfed Dockerfile support multiple target *runtimes* ([Apache](#apache), [Nginx + FPM](#nginx), and [fpm](#fpm)).
You can consider a *runtime* target as individual Dockerfiles, but instead, all of them are build from the same optimized Dockerfile, sharing +90% of their configuration and packages.
### Apache
Building a custom Pixelfed Docker image using Apache + mod_php can be achieved the following way.
#### docker build (Apache)
```shell
docker build \
-f contrib/docker/Dockerfile \
--target apache-runtime \
--tag <docker hub user>/<docker hub repo> \
.
```
#### docker compose (Apache)
```yaml
version: "3"
services:
app:
build:
context: .
dockerfile: contrib/docker/Dockerfile
target: apache-runtime
```
### Nginx
Building a custom Pixelfed Docker image using nginx + FPM can be achieved the following way.
#### docker build (nginx)
```shell
docker build \
-f contrib/docker/Dockerfile \
--target nginx-runtime \
--build-arg 'PHP_BASE_TYPE=fpm' \
--tag <docker hub user>/<docker hub repo> \
.
```
#### docker compose (nginx)
```yaml
version: "3"
services:
app:
build:
context: .
dockerfile: contrib/docker/Dockerfile
target: nginx-runtime
args:
PHP_BASE_TYPE: fpm
```
### FPM
Building a custom Pixelfed Docker image using FPM (only) can be achieved the following way.
#### docker build (fpm)
```shell
docker build \
-f contrib/docker/Dockerfile \
--target fpm-runtime \
--build-arg 'PHP_BASE_TYPE=fpm' \
--tag <docker hub user>/<docker hub repo> \
.
```
#### docker compose (fpm)
```yaml
version: "3"
services:
app:
build:
context: .
dockerfile: contrib/docker/Dockerfile
target: fpm-runtime
args:
PHP_BASE_TYPE: fpm
```
## Build settings (arguments)
The Pixelfed Dockerfile utilizes [Docker Multi-stage builds](https://docs.docker.com/build/building/multi-stage/) and [Build arguments](https://docs.docker.com/build/guide/build-args/).
Using *build arguments* allow us to create a flexible and more maintainable Dockerfile, supporting [multiple runtimes](#runtimes) ([FPM](#fpm), [Nginx](#nginx), [Apache + mod_php](#apache)) and end-user flexibility without having to fork or copy the Dockerfile.
*Build arguments* can be configured using `--build-arg 'name=value'` for `docker build`, `docker compose build` and `docker buildx build`. For `docker-compose.yml` the `args` key for [`build`](https://docs.docker.com/compose/compose-file/compose-file-v3/#build) can be used.
### `PHP_VERSION`
The `PHP` version to use when building the runtime container.
Any valid Docker Hub PHP version is acceptable here, as long as it's [published to Docker Hub](https://hub.docker.com/_/php/tags)
**Example values**:
* `8` will use the latest version of PHP 8
* `8.1` will use the latest version of PHP 8.1
* `8.2.14` will use PHP 8.2.14
* `latest` will use whatever is the latest PHP version
**Default value**: `8.1`
2024-01-04 16:12:18 +00:00
### `PHP_PECL_EXTENSIONS`
PECL extensions to install via `pecl install`
2024-01-04 16:12:18 +00:00
Use [PHP_PECL_EXTENSIONS_EXTRA](#php_pecl_extensions_extra) if you want to add *additional* extenstions.
Only change this setting if you want to change the baseline extensions.
See the [`PECL extensions` documentation on Docker Hub](https://hub.docker.com/_/php) for more information.
**Default value**: `imagick redis`
2024-01-04 16:12:18 +00:00
### `PHP_PECL_EXTENSIONS_EXTRA`
Extra PECL extensions (separated by space) to install via `pecl install`
See the [`PECL extensions` documentation on Docker Hub](https://hub.docker.com/_/php) for more information.
**Default value**: `""`
### `PHP_EXTENSIONS`
PHP Extensions to install via `docker-php-ext-install`.
**NOTE:** use [`PHP_EXTENSIONS_EXTRA`](#php_extensions_extra) if you want to add *additional* extensions, only override this if you want to change the baseline extensions.
See the [`How to install more PHP extensions` documentation on Docker Hub](https://hub.docker.com/_/php) for more information
**Default value**: `intl bcmath zip pcntl exif curl gd`
### `PHP_EXTENSIONS_EXTRA`
Extra PHP Extensions (separated by space) to install via `docker-php-ext-install`.
See the [`How to install more PHP extensions` documentation on Docker Hub](https://hub.docker.com/_/php) for more information.
**Default value**: `""`
2024-01-04 16:12:18 +00:00
### `PHP_EXTENSIONS_DATABASE`
PHP database extensions to install.
By default we install both `pgsql` and `mysql` since it's more convinient (and adds very little build time! but can be overwritten here if required.
2024-01-04 16:12:18 +00:00
**Default value**: `pdo_pgsql pdo_mysql pdo_sqlite`
### `COMPOSER_VERSION`
The version of Composer to install.
Please see the [Docker Hub `composer` page](https://hub.docker.com/_/composer) for valid values.
**Default value**: `2.6`
### `APT_PACKAGES_EXTRA`
Extra APT packages (separated by space) that should be installed inside the image by `apt-get install`
**Default value**: `""`
### `NGINX_VERSION`
Version of `nginx` to when targeting [`nginx-runtime`](#nginx).
Please see the [Docker Hub `nginx` page](https://hub.docker.com/_/nginx) for available versions.
**Default value**: `1.25.3`
### `PHP_BASE_TYPE`
The `PHP` base image layer to use when building the runtime container.
When targeting
* [`apache-runtime`](#apache) use `apache`
* [`fpm-runtime`](#fpm) use `fpm`
* [`nginx-runtime`](#nginx) use `fpm`
**Valid values**:
* `apache`
* `fpm`
* `cli`
**Default value**: `apache`
### `PHP_DEBIAN_RELEASE`
The `Debian` Operation System version to use.
**Valid values**:
* `bullseye`
* `bookworm`
**Default value**: `bullseye`