diff --git a/README.md b/README.md index 1927748..b403346 100644 --- a/README.md +++ b/README.md @@ -70,6 +70,43 @@ To change the external port the server uses, change the *first* instance of the docker run -d -p 8123:9736 ottomated/crewlink-server:latest ``` +## Docker-Compose + +Run the server with [Docker-Compose](https://docs.docker.com/compose/install/) by creating following commands: + +1. Create a folder +```sh +mkdir /opt/crewlink +cd /opt/crewlink +``` + +2. Create docker-compose.yml (In my example with nano) +```sh +nano docker-compose.yml +``` + +3. Paste and edit the following text +``` +version: '3.3' +services: + crewlink-server: + environment: + - ADDRESS=crewlink.example.com # This needs to be adjusted to your FQDN + - PORT=9736 # Change this to whatever port of the docker container should be used. Make sure to adjust the letter port below as well + - NAME=Crewlink Server # Not necessary; Change to whatever you like +# - HTTPS=true # This needs to be uncommented in case you want to use SSL +# - SSLPATH=/path/to/ssl/cert/and/key # This needs to be uncommented and adjusted in case you want to use SSL + ports: + - '9736:9736' # First port needs defines the port used on your host; Latter must be the same as the port defined above in environment + image: 'ottomated/crewlink-server:latest' +``` + +4. Press `ctrl + o` to overwrite and hit `enter` + +5. press `ctrl + x` to exit nano + +6. Run CrewLink by typing `docker-compose up -d` + ### Building the Docker Image To build your own Docker image, do the following: