From 4b1a240e1796a6dfc5a3fc5d57b9d4f1a7233d32 Mon Sep 17 00:00:00 2001 From: Jannik Streek Date: Fri, 16 Feb 2024 08:43:59 +0100 Subject: [PATCH] add readme --- doc/docker.adoc | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/doc/docker.adoc b/doc/docker.adoc index 5f4b78120..0cc1e2a5d 100644 --- a/doc/docker.adoc +++ b/doc/docker.adoc @@ -20,6 +20,31 @@ If you want to use a personalized settings file, **you will have to rebuild your All of the following instructions are as a member of the `docker` group. By default, the Etherpad Docker image is built and run in `production` mode: no development dependencies are installed, and asset bundling speeds up page load time. +=== Building and running with docker compose +A docker compose file is provided in the project. Please first copy `.env.default` to `.env` and adjust the variables to your preference. + +``` +docker compose up -d # will build and start the docker container on port 9001 with development settings. +``` + +For production, please create your own docker compose file and change the `target` property in the build section to `production`, for instance: + +``` +docker compose -f docker-compose-production.yml up -d +``` + +For plugins, please add them in the build section under ETHERPAD_PLUGINS, for instance: + +``` + args: + ETHERPAD_PLUGINS: >- + ep_image_upload + ep_embedded_hyperlinks2 + ep_headings2 + ep_align + ... +``` + ==== Rebuilding with custom settings Edit `/settings.json.docker` at your will. When rebuilding the image, this file will be copied inside your image and renamed to `settings.json`.