diff --git a/README.md b/README.md index 5580e87..27c2d1d 100755 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ # Homelab Brisbane Home Page + +A simple `docker compose up` will launch this on your machine. The **home** page will be bound to `http://localhost:8080` and the **administration** page on `http://localhost:8081`. + +By default the contents of `dat.live` will be mounted, so changes made on the **administration** page will modify `dat.live/events.json`. + +If you want to experiment a little without interfering with the master calendar there is a `dat.test` folder that can be used instead by launching with... + +```bash +HLBDAT=dat.test docker compose up +``` + +Even if you forget, you'd still need to `git add`, `git commit` and `git push` on your local machine. Moreover, *somebody* would need to `git pull` and `docker restart` on the production hosting environment before anybody else would see what you've done, so this is **super** low risk. + diff --git a/docker-compose.yaml b/docker-compose.yaml index d483172..a7f8dbd 100755 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -1,16 +1,5 @@ # -# By default the dat.live folder will be mounted. -# For testing you might like to switch to dat.test -# The HLBDAT environment variable will do this for you. -# If that variable is unset, dat.live will be used. -# To use dat.test instead, run this... -# -# $ HLBDAT=dat.test docker compose up -# -# ...but if you're happy to play with the live data -# this will do... -# -# $ docker compose up +# Check README.md for some notes on the intended usage here. # services: app: