From e684485868acd311e2e6fe17e48c8385a4e43ae4 Mon Sep 17 00:00:00 2001 From: Florian Brinker Date: Sat, 20 Mar 2021 18:47:25 +0100 Subject: [PATCH] Extend readme with detailed example --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index f38f6dc..4199eff 100644 --- a/README.md +++ b/README.md @@ -35,3 +35,26 @@ services: ``` After a `docker-compose up -d`, you can reach your TileBoard instance under `http://[yourhost-or-ip]:8234`. + +## Extended Example + +I am using it in my docker-compose file like this, with my config.js, secrets and other customizations: + +```yaml +# Home Assistant Tileboard +tileboard: + container_name: tileboard + image: fbrinker/tileboard + hostname: tileboard + volumes: + - ./tileboard/config/config.js:/tileboard/config.js + - ./tileboard/config/secrets.js:/tileboard/includes/config/secrets.js + - ./tileboard/config/pages:/tileboard/includes/pages + - ./tileboard/styles/background.png:/tileboard/images/background.png + - ./tileboard/styles/custom.css:/tileboard/styles/custom.css + ports: + - "8234:8000" + restart: unless-stopped + depends_on: + - homeassistant +```