summaryrefslogtreecommitdiff
path: root/glance
diff options
context:
space:
mode:
Diffstat (limited to 'glance')
-rw-r--r--glance/.env.example3
-rw-r--r--glance/README.md28
-rw-r--r--glance/docker-compose.yml16
3 files changed, 47 insertions, 0 deletions
diff --git a/glance/.env.example b/glance/.env.example
new file mode 100644
index 0000000..6d1e7c4
--- /dev/null
+++ b/glance/.env.example
@@ -0,0 +1,3 @@
+# Variables defined here will be available to use anywhere in the config with the syntax ${MY_SECRET_TOKEN}
+# Note: making changes to this file requires re-running docker compose up
+MY_SECRET_TOKEN=your_secret_token_here
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.
diff --git a/glance/docker-compose.yml b/glance/docker-compose.yml
new file mode 100644
index 0000000..51825a4
--- /dev/null
+++ b/glance/docker-compose.yml
@@ -0,0 +1,16 @@
+services:
+ glance:
+ container_name: glance
+ image: glanceapp/glance
+ restart: unless-stopped
+ volumes:
+ - ./config:/app/config
+ - ./assets:/app/assets
+ - /etc/localtime:/etc/localtime:ro
+ - /srv:/raid:ro
+ - /home:/root:ro
+ # Optionally, also mount docker socket if you want to use the docker containers widget
+ # - /var/run/docker.sock:/var/run/docker.sock:ro
+ ports:
+ - 7575:8080
+ env_file: .env