glanceapp/glance
1
1
Fork 0
mirror of https://github.com/glanceapp/glance.git synced 2024-10-04 08:37:18 +03:00
Code Issues Packages Projects Releases Wiki Activity
A self-hosted dashboard that puts all your feeds in one place
64 Commits 3 Branches 12 Tags 15 MiB
Go 53.3%
CSS 18.2%
HTML 17.8%
JavaScript 10.6%
0681a04607
Go to file
fawn 0681a04607
Add custom sorting to the twitch channels widget 
this allows the channels to be sorted as defined in the config while
still keeping the live channels on the top. the wording could probably
be improved, "custom" is too broad but i'm not sure what else to call
it.
2024-05-18 03:07:34 +03:00
.github Create SECURITY.md 2024-05-17 19:56:18 +01:00
docs Add custom sorting to the twitch channels widget 2024-05-18 03:07:34 +03:00
internal Add custom sorting to the twitch channels widget 2024-05-18 03:07:34 +03:00
scripts/build-and-ship Update build to include openbsd and armv7 2024-05-09 13:00:42 +01:00
.gitignore Initial commit 2024-04-27 20:10:24 +01:00
Dockerfile Update build to include openbsd and armv7 2024-05-09 13:00:42 +01:00
Dockerfile.single-platform Update readme with docker image build guide 2024-05-12 20:33:36 +01:00
go.mod Update dependencies 2024-04-28 23:53:32 +01:00
go.sum Update dependencies 2024-04-28 23:53:32 +01:00
LICENSE Initial commit 2024-04-27 20:10:24 +01:00
main.go Initial commit 2024-04-27 20:10:24 +01:00
README.md Merge pull request #57 from glanceapp/release/v0.4.0 2024-05-12 22:12:00 +01:00

README.md

What if you could see everything at a...

Glance

Install • Configuration • Themes

example homepage

Features

Various widgets

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

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 Glance with CGO disabled:

CGO_ENABLED=0 go build -o build/glance .

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