inital version

README.md

@@ -1,3 +1,52 @@
-# compose-homepage
+# Homepage Dashboard
+* can be run on single node setup or in swarm  
 
-Homepage Dashboard
+## howto
+### single node
+#### start container
+```bash
+docker compose up -d
+```
+
+#### stop container (and remove)
+```bash
+docker compose down
+```
+
+#### view logs
+```bash
+docker compose logs -f
+```
+
+#### reload config
+```bash
+docker compose restart
+```
+
+### swarm
+#### start aka deploy
+hint: drone fails to start until git auth source is created and set in vars
+```bash
+docker stack deploy -c docker-compose.yml homepage
+```
+
+#### stop container aka service
+```bash
+docker stack rm homepage
+```
+
+#### view logs
+```bash
+docker service logs homepage -f
+```
+
+#### reload config (no downtime if replica 2 or more)
+```bash
+docker service update hoempage --force
+```
+
+## example caddy config
+```
+git.example.com {
+    reverse_proxy homepage:3000
+}