Run Typemill with Docker

The Typemill repository contains a Dockerfile that helps you create your own Docker image locally. You can also use the official image on DockerHub.

The Dockerfile is a community contribution by Matthieu Borgognon.

Use DockerHub

Pull Typemill from DockerHub:

docker pull kixote/typemill

Start a Typemill container:

docker run -d --name typemill -p 8080:80 kixote/typemill

Typemill will now be available at http://localhost:8080.

Local Setup

Clone the Typemill repository:

git clone https://github.com/typemill/typemill.git
cd typemill

Build your image locally:

docker build -t typemill:local .

Run the Docker image without persistence on port 8080:

docker run -d --name typemill -p 8080:80 typemill:local

Run Typemill with persistence:

docker run -d \
    --name=typemill \
    -p 8080:80 \
    -v $(pwd)/typemill_data/settings/:/var/www/html/settings/ \
    -v $(pwd)/typemill_data/media/:/var/www/html/media/ \
    -v $(pwd)/typemill_data/data/:/var/www/html/data/ \
    -v $(pwd)/typemill_data/cache/:/var/www/html/cache/ \
    -v $(pwd)/typemill_data/plugins/:/var/www/html/plugins/ \
    -v $(pwd)/typemill_data/content/:/var/www/html/content/ \
    -v $(pwd)/typemill_data/themes/:/var/www/html/themes/ \
    typemill:local

A simple docker-compose.yml file could look like this:

version: "3.8"

services:
  typemill:
    image: typemill:local
    environment:
      TYPEMILL_PROXY_DETECTION: "true"
    volumes:
      - ./typemill_data/settings/:/var/www/html/settings/
      - ./typemill_data/media/:/var/www/html/media/
      - ./typemill_data/data/:/var/www/html/data/
      - ./typemill_data/cache/:/var/www/html/cache/
      - ./typemill_data/plugins/:/var/www/html/plugins/
      - ./typemill_data/content/:/var/www/html/content/
      - ./typemill_data/themes/:/var/www/html/themes/
    ports:
      - 8080:80

Volumes

• settings: persists user profiles, site configuration, etc. (empty by default)
• media: persists media files (empty by default)
• data: persists data like cached navigation and stored data from plugins (empty by default)
• cache: persists cache files for performance purposes (optional and empty by default)
• plugins: persists installed plugins (optional and empty by default)
• content: persists published content (will be initialized with default examples if the bound volume is empty)
• themes: persists installed themes (will be initialized with default examples if the bound volume is empty)

TLS and Proxy

The Docker image in the Typemill repository does not provide TLS support. It's perfect either for local use or behind your own proxy.

Proxy detection is enabled by default with the TYPEMILL_PROXY_DETECTION environment variable:

environment:
  TYPEMILL_PROXY_DETECTION: "true"

You can disable proxy detection:

environment:
  TYPEMILL_PROXY_DETECTION: "false"

Make sure your reverse proxy forwards the appropriate X-Forwarded-* headers. You should also add trusted proxies in the developer settings of Typemill.