summaryrefslogtreecommitdiff
path: root/glance/README.md
diff options
context:
space:
mode:
authorTyler Hoang <tyler@tylerhoang.xyz>2026-07-09 21:49:56 -0700
committerTyler Hoang <tyler@tylerhoang.xyz>2026-07-09 21:49:56 -0700
commit1d043702ef136e8f2e516c5304a57be5718f1f6f (patch)
tree9b3ad070f11dad5994c58acd41a15db8043745aa /glance/README.md
Initial commit: docker compose files for all self-hosted servicesHEADmaster
12 services: adguard, ampache, azuracast, flood, glance, glances, grafana, immich, invidious, jellyfin, openwebui, watchtower Each service includes a docker-compose.yml, README.md with setup instructions, and .env.example where applicable.
Diffstat (limited to 'glance/README.md')
-rw-r--r--glance/README.md28
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.