nathanvaughn/webtrees repository overview

⁠Docker Image for webtrees⁠

This is a multi-architecture, up-to-date, Docker image for webtrees⁠ served over HTTP or HTTPS. This can be put behind a reverse proxy such as CloudFlare or Traefik, or run standalone.

⁠Usage

⁠Quickstart

If you want to jump right in, take a look at the provided docker-compose.yml⁠.

⁠Environment Variables

There are many environment variables available to help automatically configure the container. For any environment variable you do not define, the default value will be used.

Additionally, you can add _FILE to the end of any environment variable name, and instead that will read the value in from the given filename. For example, setting DB_PASS_FILE=/run/secrets/my_db_secret will read the contents of that file into DB_PASS.

If you don't want the container to be configured automatically (if you're migrating from an existing webtrees installation for example), simply leave the database (DB_) and webtrees (WT_) variables blank, and you can complete the setup wizard⁠ like normal.

⁠Database

webtrees recommends⁠ a MySQL (or compatible equivalent) database. You will need a separate container for this.

• MariaDB⁠
• MySQL⁠

PostgreSQL (pgsql) and SQLite (sqlite) are additionally both supported by webtrees and this image, but are not recommended⁠. This image does not support Microsoft SQL Server, in order to support multiple architectures. See issue: microsoft/msphpsql#441⁠

⁠SQLite Values

If you want to use a SQLite database, set the following values:

• DB_TYPE to sqlite
• DB_NAME to desiredfilename. Do not include any extension.

⁠PostgreSQL Values

If you want to use a PostreSQL database, set the following values:

• DB_TYPE to pgsql
• DB_PORT to 5432

All other values are just like a MySQL database.

⁠Volumes

The image mounts:

• /var/www/webtrees/data/

(media is stored in the media subfolder)

If you want to add custom themes or modules⁠, you can also mount the /var/www/webtrees/modules_v4/ directory.

Example docker-compose:

volumes:
  - app_data:/var/www/webtrees/data/
  - app_themes:/var/www/webtrees/modules_v4/
---
volumes:
  app_data:
    driver: local
  app_themes:
    driver: local

See the link above for information about v1.7 webtrees.

To install a custom theme or module, the process is generally as follows:

docker exec -it webtrees_app_1 bash   # connect to the running container
cd /var/www/webtrees/modules_v4/      # move into the modules directory
curl -L <download url> -o <filename>  # download the file

# if module is a .tar.gz file
tar -xf <filename.tar.gz>             # extract the tar archive https://xkcd.com/1168/
rm <filename.tar.gz>                  # remove the tar archive

# if module is a .zip file
apt update && apt install unzip       # install the unzip package
unzip <filename.zip>                  # extract the zip file
rm <filename.zip>                     # remove the zip file

exit                                  # disconnect from the container

⁠Network

The image exposes port 80 and 443.

Example docker-compose:

ports:
  - 80:80
  - 443:443

If you have the HTTPS redirect enabled, you still need to expose port 80. If you're not using HTTPS at all, you don't need to expose port 443.

⁠ImageMagick

ImageMagick is included in this image to speed up thumbnail creation⁠. webtrees will automatically prefer it over gd with no configuration.

⁠Tags

⁠Specific Versions

Each stable, legacy, beta, and alpha release version of webtrees produces a version-tagged build of the Docker container.

Example:

image: ghcr.io/nathanvaughn/webtrees:2.1.2

⁠Latest

Currently, the tags latest, latest-alpha, latest-beta and latest-legacy are available for the latest stable, alpha, beta and legacy versions of webtrees, respectively.

Example:

image: ghcr.io/nathanvaughn/webtrees:latest

⁠Issues

New releases of the Dockerfile are automatically generated from upstream webtrees versions. This means a human does not vette every release. While I try to stay on top of things, sometimes breaking issues do occur. If you have any, please feel free to fill out an issue⁠.

⁠Reverse Proxy Issues

webtrees does not like running behind a reverse proxy, and depending on your setup, you may need to adjust some database values manually.

For example, if you are accessing webtrees via a reverse proxy serving content over HTTPS, but using this container with HTTP, you might need to make the following changes in your database:

mysql -u webtrees -p

use webtrees;
update wt_site_setting set setting_value='https://example.com/login' where setting_name='LOGIN_URL';
update wt_site_setting set setting_value='https://example.com/' where setting_name='SERVER_URL';
quit;

For more info, see this⁠.

⁠Registry

This image is available from 2 different registries. Choose whichever you want:

• docker.io/nathanvaughn/webtrees⁠
• ghcr.io/nathanvaughn/webtrees⁠