summaryrefslogtreecommitdiff
path: root/glance/README.md
blob: e1c6168fffe5ec5b32f049b212320fc0083f5018 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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.