Skip to content

Latest commit

 

History

History
111 lines (86 loc) · 2.74 KB

README.md

File metadata and controls

111 lines (86 loc) · 2.74 KB
Raw

What if you could see everything at a...

Glance

Install • Configuration • Themes

example homepage

Features

Various widgets

  • RSS feeds
  • Subreddit posts
  • Weather
  • Bookmarks
  • Hacker News
  • Lobsters
  • Latest YouTube videos from specific channels
  • Clock
  • Calendar
  • Stocks
  • iframe
  • Twitch channels & top games
  • GitHub releases
  • Repository overview
  • Site monitor
  • Search box

Themeable

multiple color schemes example

Optimized for mobile devices

mobile device previews

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 in the same directory 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 -o build/glance .

To run:

go run .

Building Docker image

Build the image:

Make sure to replace "owner" with your name or organization.

docker build -t owner/glance:latest -f Dockerfile.single-platform .

Push the image to your registry:

docker push owner/glance:latest