From 0e6ea0c0222b98565f52a4f5390c9f5927bca0e3 Mon Sep 17 00:00:00 2001 From: Nicco Date: Wed, 8 May 2019 11:52:37 +0200 Subject: [PATCH] Update README.md --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c7d61b5..4959570 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,29 @@ -# docker-etherpad -Etherpad docker image +# Etherpad Docker + +Etherpad docker image with docker-compose support. + +## Quickstart 💥 + +```bash +docker-compose up -d +``` + +## Setup 🏗 + +```bash +git clone https://github.com/CupCakeArmy/docker-etherpad +cd docker-etherpad + +# Modify settings +vim settings.json + +# Run +docker-compose up -d +``` + +### (Default) Persist the DB 💽 + +By default the DB is persisted into `dirty.db`. +To start with a clean state you need to delete the `dirty.db` file. +Either run `rm dirty.db; touch dirty.db` or `cat /dev/null > dirty.db`. +docker-compose requires that the file exists, otherwise it will mount it as a folder.