diff --git a/README.md b/README.md index 0346677..d2ccdc6 100644 --- a/README.md +++ b/README.md @@ -27,4 +27,13 @@ More Information: [https://cwtch.im](https://cwtch.im) Development and Contributing information in [CONTRIBUTING.md](https://git.openprivacy.ca/cwtch.im/cwtch/src/master/CONTRIBUTING.md) +## Running Cwtch +### Server +#### Docker +This repository contains a `Dockerfile` allowing you to build and run the server as a [docker](https://www.docker.com/) container. + +To get started issue `docker build -t cwtch:latest`, this will create 2 temporary docker containers, one to build the Tor daemon and one to build Cwtch. The compiled binaries will then be bundled into a new image and tagged as `cwtch:latest`. + +To run Cwtch in the foreground execute `docker run cwtch:latest`, you will see a small amount of output from Tor and then Cwtch will output your server address. When you `Ctrl + C` the container will terminate. To run Cwtch in the background execute `docker run --name my-cwtch-server -d cwtch:latest`. To get your Cwtch server address issue `docker logs my-cwtch-server`. + ![](https://git.openprivacy.ca/avatars/5?s=140)