diff options
Diffstat (limited to 'glance/README.md')
| -rw-r--r-- | glance/README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/glance/README.md b/glance/README.md new file mode 100644 index 0000000..e1c6168 --- /dev/null +++ b/glance/README.md @@ -0,0 +1,28 @@ +# Glance + +A highly customizable personal dashboard page. + +## Setup + +1. Copy `.env.example` to `.env` and set your secret token: + ``` + cp .env.example .env + ``` + +2. Place your `glance.yml` config file in `./config/`. + +3. Start: + ``` + docker compose up -d + ``` + +## Access + +- Dashboard: `http://<host>:7575` + +## What to Configure + +- **`.env`** — Set `MY_SECRET_TOKEN` to a random string. This is used in the Glance config to reference secrets (e.g. API tokens for widgets). +- **Config** — You need a `glance.yml` in `./config/`. See the [Glance docs](https://github.com/glanceapp/glance) for the config format. +- **Assets** — Static assets (images, CSS) go in `./assets/` and are served at `/assets/`. +- **System mounts** — The compose file mounts `/srv` and `/home` as read-only. Remove or adjust these if your dashboard doesn't need filesystem access. |