Glance

Install • Configuration • Widgets • Sponsor

Community widgets • Preconfigured pages • Themes

A lightweight, highly customizable dashboard that displays
your feeds in a beautiful, streamlined interface

About this fork

This repository is a maintained fork of Glance with additional functionality, reliability fixes, operational hardening, expanded regression testing, and deployment tooling.

It tracks upstream Glance while minimizing unnecessary divergence. Fork releases retain the upstream release version and add a fork-specific revision, for example v0.8.5-samcro1967.r001.

See About the samcro1967 Glance fork for detailed information about fork-specific functionality, testing, development and CI practices, security and dependency maintenance, releases and container images, production deployment safeguards, and upstream synchronization.

Features

Various widgets

• RSS feeds
• Subreddit posts
• Hacker News posts
• Weather forecasts
• YouTube channel uploads
• Twitch channels
• Market prices
• Docker containers status
• Server stats
• Custom widgets
• and many more...

Fast and lightweight

• Low memory usage
• Few dependencies
• Minimal vanilla JS
• Single <20mb binary available for multiple OSs & architectures and just as small Docker container
• Uncached pages usually load within ~1s (depending on internet speed and number of widgets)

Tons of customizability

• Different layouts
• As many pages/tabs as you need
• Numerous configuration options for each widget
• Hierarchical widget defaults for sharing common settings globally or by widget type
• Multiple styles for some widgets
• Custom CSS

Optimized for mobile devices

Because you'll want to take it with you on the go.

Themeable

Customize Glance without writing CSS using native themes for colors, typography, page backgrounds, navigation, widgets, cards, groups, controls, surfaces, and more. Themes can be configured globally, overridden per page, and switched between Glance Dark, Glance Light, and your own named themes. Custom CSS remains available for advanced styling.

See the Themes documentation for the complete theme reference, examples, and available customization options.

Configuration

Configuration is done through YAML files, to learn more about how the layout works, how to add more pages and how to configure widgets, visit the configuration documentation. Individual widgets are documented in the widget catalog.

Preview example configuration file

pages:
  - name: Home
    columns:
      - size: small
        widgets:
          - type: calendar
            first-day-of-week: monday

          - type: rss
            limit: 10
            collapse-after: 3
            cache: 12h
            feeds:
              - url: https://selfh.st/rss/
                title: selfh.st
                limit: 4
              - url: https://ciechanow.ski/atom.xml
              - url: https://www.joshwcomeau.com/rss.xml
                title: Josh Comeau
              - url: https://samwho.dev/rss.xml
              - url: https://ishadeed.com/feed.xml
                title: Ahmad Shadeed

          - type: twitch-channels
            channels:
              - theprimeagen
              - j_blow
              - piratesoftware
              - cohhcarnage
              - christitustech
              - EJ_SA

      - size: full
        widgets:
          - type: group
            widgets:
              - type: hacker-news
              - type: lobsters

          - type: videos
            channels:
              - UCXuqSBlHAE6Xw-yeJA0Tunw # Linus Tech Tips
              - UCR-DXc1voovS8nhAvccRZhg # Jeff Geerling
              - UCsBjURrPoezykLs9EqgamOA # Fireship
              - UCBJycsmduvYEL83R_U4JriQ # Marques Brownlee
              - UCHnyfMqiRRG1u-2MsSQLbXA # Veritasium

          - type: group
            widgets:
              - type: reddit
                subreddit: technology
                show-thumbnails: true
              - type: reddit
                subreddit: selfhosted
                show-thumbnails: true

      - size: small
        widgets:
          - type: weather
            location: London, United Kingdom
            units: metric
            hour-format: 12h

          - type: markets
            markets:
              - symbol: SPY
                name: S&P 500
              - symbol: BTC-USD
                name: Bitcoin
              - symbol: NVDA
                name: NVIDIA
              - symbol: AAPL
                name: Apple
              - symbol: MSFT
                name: Microsoft

          - type: releases
            cache: 1d
            repositories:
              - glanceapp/glance
              - go-gitea/gitea
              - immich-app/immich
              - syncthing/syncthing

Installation

Choose one of the following methods:

Docker compose using upstream directory structure

[!NOTE] This convenience template is maintained by the upstream Glance project and uses the upstream glanceapp/glance container image by default. To use this fork, change the image value in the generated docker-compose.yml to ghcr.io/samcro1967/glance:latest before starting the container.

Create a new directory called glance as well as the template files within it by running:

mkdir glance && cd glance && curl -sL https://github.com/glanceapp/docker-compose-template/archive/refs/heads/main.tar.gz | tar -xzf - --strip-components 2

click here to view the files that will be created

Then, edit the following files as desired:

• docker-compose.yml to configure the port, volumes and other containery things
• config/home.yml to configure the widgets or layout of the home page
• config/glance.yml if you want to change the theme or add more pages

Other files you may want to edit

• .env to configure environment variables that will be available inside configuration files
• assets/user.css to add custom CSS

When ready, run:

docker compose up -d

If you encounter any issues, you can check the logs by running:

docker compose logs

---

Docker compose manual (recommended)

Create a docker-compose.yml file with the following contents:

services:
  glance:
    container_name: glance
    image: ghcr.io/samcro1967/glance:latest
    restart: unless-stopped
    volumes:
      - ./config:/app/config
    ports:
      - 8080:8080

Then, create a new directory called config and download the example starting glance.yml file from this fork into it by running:

mkdir config && wget -O config/glance.yml https://raw.githubusercontent.com/samcro1967/glance/refs/heads/main/docs/glance.yml

Feel free to edit the glance.yml file to your liking, and when ready run:

docker compose up -d

If you encounter any issues, you can check the logs by running:

docker logs glance

---

Manual binary installation

Formal releases of this fork include precompiled binaries published through GitHub Releases.

Release binaries contain the fork's exact release version, such as v0.8.5-samcro1967.r001, embedded at build time. Select the archive appropriate for your operating system and architecture from the desired release.

Container deployments are also available through GitHub Container Registry. ghcr.io/samcro1967/glance:latest identifies the latest formal fork release, while ghcr.io/samcro1967/glance:dev identifies the current integrated development build.

If you require a standalone binary, you can build this fork from source using the Go toolchain. Alternatively, the upstream Glance project publishes precompiled binaries for Linux, Windows and macOS. Be aware that upstream binaries do not include the additional functionality documented in the About this fork section.

A starting configuration for this fork is available in docs/glance.yml.

---

Other

The following third-party installation channels are available for upstream Glance. They may not install this fork or include its additional functionality:

• Proxmox VE Helper Script
• NixOS package
• Hostinger
• Coolify.io

---

Common issues

Requests timing out

The most common cause of this is when using Pi-Hole, AdGuard Home or other ad-blocking DNS services, which by default have a fairly low rate limit. Depending on the number of widgets you have in a single page, this limit can very easily be exceeded. To fix this, increase the rate limit in the settings of your DNS service.

If using Podman, in some rare cases the timeout can be caused by an unknown issue, in which case it may be resolved by adding the following to the bottom of your docker-compose.yml file:

networks:
  podman:
    external: true

Broken layout for markets, bookmarks or other widgets

This is almost always caused by the browser extension Dark Reader. To fix this, disable dark mode for the domain where Glance is hosted.

cannot unmarshal !!map into []glance.page

The most common cause of this is having a pages key in your glance.yml and then also having a pages key inside one of your included pages. To fix this, remove the pages key from the top of your included pages.

FAQ

Does the information on the page update automatically?

Updateable widgets are refreshed and recovered server-side when their cached data expires, even when no page is open. When a page is open, refreshed widget content is automatically delivered to the browser without requiring a full page reload. Some client-side information also updates dynamically where it makes sense, such as the clock widget and relative times.

How frequently do widgets update?

Updateable widgets are refreshed server-side after their cached data expires. The normal refresh interval is determined by each widget's cache lifetime and can be configured where supported. Failed refreshes are retried automatically using progressive backoff so temporary dependency or network failures can recover without restarting Glance or opening the page.

Can I create my own widgets?

Yes, there are multiple ways to create custom widgets:

• iframe widget - allows you to embed things from other websites
• html widget - allows you to insert your own static HTML
• extension widget - fetch HTML from a URL
• custom-api widget - fetch JSON from a URL and render it using custom HTML

Can I change the title of a widget?

Yes, the title of all widgets can be changed by specifying the title property in the widget's configuration:

- type: rss
  title: My custom title

- type: markets
  title: My custom title

- type: videos
  title: My custom title

# and so on for all widgets...

Feature requests

Issues and feature requests related to functionality specific to this fork can be submitted to the fork's issue tracker.

For requests concerning upstream Glance rather than fork-specific functionality, use the upstream Glance issue tracker.

Building from source

Choose one of the following methods:

Build binary with Go

Requirements: Go >= v1.23

To build the project for your current OS and architecture, run:

go build -o build/glance .

To build for a specific OS and architecture, run:

GOOS=linux GOARCH=amd64 go build -o build/glance .

click here for a full list of GOOS and GOARCH combinations

Alternatively, if you just want to run the app without creating a binary, like when you're testing out changes, you can run:

go run .

---

Build project and Docker image with Docker

Requirements: Docker

To build the project and image using just Docker, run:

(replace owner with your name or organization)

docker build -t owner/glance:latest .

If you wish to push the image to a registry (by default Docker Hub), run:

docker push owner/glance:latest

---

Contributing guidelines

• Before working on a new feature it's preferable to submit a feature request first and state that you'd like to implement it yourself
• Please don't submit PRs for feature requests that are either in the roadmap^[1], backlog^[2] or icebox^[3]
• Use dev for the base branch if you're adding new features or fixing bugs, otherwise use main
• Avoid introducing new dependencies
• Avoid making backwards-incompatible configuration changes
• Avoid introducing new colors or hard-coding colors, use the standard primary, positive and negative
• For icons, try to use heroicons where applicable
• Provide a screenshot of the changes if UI related where possible
• No package.json

^{[1] [2] [3]}

[1] The feature likely already has work put into it that may conflict with your implementation

[2] The demand, implementation or functionality for this feature is not yet clear

[3] No plans to add this feature for the time being

Thank you

To all the people who were generous enough to sponsor the project and to everyone who has contributed in any way, be it PRs, submitting issues, helping others in the discussions or Discord server, creating guides and tools or just mentioning Glance on social media. Your support is greatly appreciated and helps keep the project going.