varia/etherpump
14
0
Fork 0
Code Issues 15 Pull Requests Releases Activity

Outline experimenting with Docker

Browse Source
This commit is contained in:
Luke Murphy 2020-10-03 11:41:03 +02:00
parent 2a2f871886
commit 45fcd51029
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -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.