diff --git a/docker-compose.yml b/docker-compose.yml index e3ee93f3..0d09a26a 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,5 +1,5 @@ --- -# Welcome to Dashy! To get started, run `docker compose up` +# Welcome to Dashy! To get started, run `docker compose up -d` # You can configure your container here, by modifying this file version: "3.8" services: @@ -21,7 +21,8 @@ services: # Pass in your config file below, by specifying the path on your host machine # volumes: - # - /root/my-config.yml:/app/public/conf.yml + # - /path/to/my-config.yml:/app/public/conf.yml + # - /path/to/item-icons:/app/public/item-icons # Set port that web service will be served on. Keep container port as 80 ports: diff --git a/docs/deployment.md b/docs/deployment.md index 61e3df4a..9f0508a9 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -68,7 +68,7 @@ The image defaults to `:latest`, but you can instead specify a specific version, ### Using Docker Compose -Using Docker Compose can be useful for saving your specific config in files, without having to type out a long run command each time. Save compose config as a YAML file, and then run `docker compose up` (optionally use the `-f` flag to specify file location, if it isn't located at `./docker-compose.yml`). Compose is also useful if you are using clusters, as the format is very similar to stack files, used with Docker Swarm. +Using Docker Compose can be useful for saving your specific config in files, without having to type out a long run command each time. Save compose config as a YAML file, and then run `docker compose up -d` (optionally use the `-f` flag to specify file location, if it isn't located at `./docker-compose.yml`), `-d` is detached mode (not running in the foreground of your terminal). Compose is also useful if you are using clusters, as the format is very similar to stack files, used with Docker Swarm. The following is a complete example of a [`docker-compose.yml`](https://github.com/Lissy93/dashy/blob/master/docker-compose.yml) for Dashy. Run it as is, or uncomment the additional options you need.