From 735c9c0a3caf592cc952de363907d11d92da99a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrian=20N=C3=B6thlich?= Date: Wed, 6 May 2020 16:07:01 +0200 Subject: [PATCH] Complete Readme with usage instructions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Adrian Nöthlich --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c7e0eaa..36a4c6c 100644 --- a/README.md +++ b/README.md @@ -7,4 +7,22 @@ The officially recommended deployment method is to use the `example.nginx.conf` Docker images and their supporting configuration files are provided as a community effort by those using them, with support provided by the core development team on a _best-effort_ basis. Keep in mind that the core team neither uses nor tests Docker images, so your results may vary. ## Migration -Please see the [migration guide](https://github.com/xwiki-labs/cryptpad-docker/blob/master/MIGRATION.md) for further information on switching to this repository. +Please see the [migration guide](MIGRATION.md) for further information on switching to this repository. + +## Usage + +### General notices +* Mounted files and folders have to be owned by userid 4001. It is possible you have to run +`sudo chown -R 4001:4001 filename` + + +### Dockerfile + +* Run: `docker run -d -p 3000:3000 -p 3001:3001 promasu/cryptpad` +* Run with customizations: `docker run -d -p 3000:3000 -p 3001:3001 -v customize:/cryptpad/customize promasu/cryptpad` +* Run with configuration: `docker run -d -p 3000:3000 -p 3001:3001 -v config.js:/cryptpad/config/config.js promasu/cryptpad` + +### Docker-compose + +* Run: `docker-compose up` +* Run with traefik2 labels: `docker-compose -f docker-compose.yml -f traefik2.yml up` \ No newline at end of file