hiperman
45 lines
1.4 KiB
Markdown
45 lines
1.4 KiB
Markdown
# Glance
|
|
|
|
Deploy Glance dashboard using Docker Compose.
|
|
|
|
## Description
|
|
|
|
Glance is a self-hosted dashboard that displays information from various sources in a simple, configurable interface.
|
|
|
|
## Variables
|
|
|
|
### Optional
|
|
|
|
| Variable | Default | Description |
|
|
|----------|---------|-------------|
|
|
| `glance_config_template` | `{{ app_templates_path }}/glance.yml.j2` | Template file for generating glance.yml config |
|
|
| `glance_config_path` | `{{ app_dir }}/config` | Configuration storage |
|
|
| `glance_http_port` | `8080` | Web interface port |
|
|
| `glance_container_version` | `latest` | Glance Docker image tag |
|
|
| `glance_restart_policy` | `{{ app_restart_policy }}` | Container restart policy |
|
|
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
- role: patrickj.docker_apps.glance
|
|
vars:
|
|
glance_http_port: 3000
|
|
glance_config_template: "/path/to/your/custom/glance.yml.j2"
|
|
```
|
|
|
|
|
|
## Configuration
|
|
|
|
The role includes a default configuration template with example widgets (RSS feeds, weather, calendar, markets, etc.). To customize your dashboard:
|
|
|
|
1. **Option 1**: Create your own template file and set `glance_config_template` to point to it
|
|
2. **Option 2**: Manually edit `{app_dir}/glance.yml` after deployment
|
|
|
|
The default template includes widgets for:
|
|
- Calendar and weather
|
|
- RSS feeds (selfhosted, tech blogs)
|
|
- Twitch channels and YouTube videos
|
|
- Reddit subreddits and Hacker News
|
|
- Stock market data and GitHub releases
|