From 45fcd51029949ccf8c132913e7a629db6cd79d18 Mon Sep 17 00:00:00 2001 From: Luke Murphy Date: Sat, 3 Oct 2020 11:41:03 +0200 Subject: [PATCH] Outline experimenting with Docker --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index b67a08e..257f460 100644 --- a/README.md +++ b/README.md @@ -173,6 +173,23 @@ Here are the steps to follow (e.g. for a `0.1.3` release): You should have a [PyPi](https://pypi.org/) account and be added as an owner/maintainer on the [etherpump package](https://pypi.org/project/etherpump/). +## Testing + +It can be quite handy to run a very temporary local Etherpad instance to test against. This is possible with [Docker](https://docs.docker.com/get-docker/). + +```bash +$ docker run -d --name etherpad -p 9001:9001 etherpad/etherpad +$ docker exec -ti etherpad cat APIKEY.txt;echo +``` + +Then you can `etherpump init` to that local Etherpad for experimentation and testing. You use `http://localhost:9001` as the pad URL. + +Later on, you can remove the Etherpad with: + +```bash +$ docker rm -f --volumes etherpad +``` + ## Maintenance utilities Tools to help things stay tidy over time.