mirror of
https://github.com/glanceapp/glance.git
synced 2024-12-23 23:49:28 +01:00
docs | ||
internal | ||
scripts/build-and-ship | ||
.gitignore | ||
Dockerfile | ||
go.mod | ||
go.sum | ||
LICENSE | ||
main.go | ||
README.md |
What if you could see everything at a...
Glance
Install • Configuration • Themes
Features
Various widgets
- RSS feeds
- Subreddit posts
- Weather
- Bookmarks
- Latest YouTube videos from specific channels
- Calendar
- Stocks
- iframe
- Twitch channels & top games
- GitHub releases
- Site monitor
Themeable
Optimized for mobile devices
Fast and lightweight
- Minimal JS, no bloated frameworks
- Very few dependencies
- Single, easily distributed <15mb binary and just as small docker container
- All requests are parallelized, uncached pages usually load within ~1s (depending on internet speed and number of widgets)
Configuration
Checkout the configuration docs to learn more. A preconfigured page is also available to get you started quickly.
Installation
Caution
The project is under active development, expect things to break every once in a while.
Manual
Checkout the releases page for available binaries. You can place the binary inside /opt/glance/
and have it start with your server via a systemd service. To specify a different path for the config file use the --config
option:
/opt/glance/glance --config /etc/glance.yml
Docker
Important
Make sure you have a valid
glance.yml
file before running the container.
docker run -d -p 8080:8080 \
-v ./glance.yml:/app/glance.yml \
-v /etc/timezone:/etc/timezone:ro \
-v /etc/localtime:/etc/localtime:ro \
glanceapp/glance
Or if you prefer docker compose:
services:
glance:
image: glanceapp/glance
volumes:
- ./glance.yml:/app/glance.yml
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
ports:
- 8080:8080
restart: unless-stopped
Building from source
Requirements: Go >= v1.22
To build:
go build .
To run:
go run .