Glance
Install • Configuration • Discord • Sponsor
Community widgets • Preconfigured pages • Themes
A lightweight, highly customizable dashboard that displays
your feeds in a beautiful, streamlined interface
## 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](docs/configuration.md#configuring-glance).
Preview example configuration file
```yaml 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 provided directory structure (recommended)
Create a new directory called `glance` as well as the template files within it by running: ```bash 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](https://github.com/glanceapp/docker-compose-template/tree/main/root)* 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 CSSDocker compose manual
Create a `docker-compose.yml` file with the following contents: ```yaml services: glance: container_name: glance image: glanceapp/glance restart: unless-stopped volumes: - ./config:/app/config ports: - 8080:8080 ``` Then, create a new directory called `config` and download the example starting [`glance.yml`](https://github.com/glanceapp/glance/blob/main/docs/glance.yml) file into it by running: ```bash mkdir config && wget -O config/glance.yml https://raw.githubusercontent.com/glanceapp/glance/refs/heads/main/docs/glance.yml ``` Feel free to edit the `glance.yml` file to your liking, and when ready run: ```bash docker compose up -d ``` If you encounter any issues, you can check the logs by running: ```bash docker logs glance ```
Manual binary installation
Precompiled binaries are available for Linux, Windows and macOS (x86, x86_64, ARM and ARM64 architectures). ### Linux Visit the [latest release page](https://github.com/glanceapp/glance/releases/latest) for available binaries. You can place the binary in `/opt/glance/` and have it start with your server via a [systemd service](https://linuxhandbook.com/create-systemd-services/). By default, when running the binary, it will look for a `glance.yml` file in the directory it's placed in. To specify a different path for the config file, use the `--config` option: ```bash /opt/glance/glance --config /etc/glance.yml ``` To grab a starting template for the config file, run: ```bash wget https://raw.githubusercontent.com/glanceapp/glance/refs/heads/main/docs/glance.yml ``` ### Windows Download and extract the executable from the [latest release](https://github.com/glanceapp/glance/releases/latest) (most likely the file called `glance-windows-amd64.zip` if you're on a 64-bit system) and place it in a folder of your choice. Then, create a new text file called `glance.yml` in the same folder and paste the content from [here](https://raw.githubusercontent.com/glanceapp/glance/refs/heads/main/docs/glance.yml) in it. You should then be able to run the executable and access the dashboard by visiting `http://localhost:8080` in your browser.
Other
Glance can also be installed through the following 3rd party channels: * [Proxmox VE Helper Script](https://community-scripts.github.io/ProxmoxVE/scripts?id=glance) * [NixOS package](https://search.nixos.org/packages?channel=unstable&show=glance) * [Coolify.io](https://coolify.io/docs/services/glance/)
## 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: ```yaml 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?
No, a page refresh is required to update the information. Some things do dynamically update where it makes sense, like the clock widget and the relative time showing how long ago something happened.How frequently do widgets update?
No requests are made periodically in the background, information is only fetched upon loading the page and then cached. The default cache lifetime is different for each widget and can be configured.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 HTMLCan 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: ```yaml - 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 New feature suggestions are always welcome and will be considered, though please keep in mind that some of them may be out of scope for what the project is trying to achieve (or is reasonably capable of). If you have an idea for a new feature and would like to share it, you can do so [here](https://github.com/glanceapp/glance/issues/new?template=feature_request.yml). Feature requests are tagged with one of the following: * [Roadmap](https://github.com/glanceapp/glance/labels/roadmap) - will be implemented in a future release * [Backlog](https://github.com/glanceapp/glance/labels/backlog) - may be implemented in the future but needs further feedback or interest from the community * [Icebox](https://github.com/glanceapp/glance/labels/icebox) - no plans to implement as it doesn't currently align with the project's goals or capabilities, may be revised at a later date
## Building from source Choose one of the following methods:
Build binary with Go
Requirements: [Go](https://go.dev/dl/) >= v1.23 To build the project for your current OS and architecture, run: ```bash go build -o build/glance . ``` To build for a specific OS and architecture, run: ```bash GOOS=linux GOARCH=amd64 go build -o build/glance . ``` [*click here for a full list of GOOS and GOARCH combinations*](https://go.dev/doc/install/source#:~:text=$GOOS%20and%20$GOARCH) Alternatively, if you just want to run the app without creating a binary, like when you're testing out changes, you can run: ```bash go run . ```
Build project and Docker image with Docker
Requirements: [Docker](https://docs.docker.com/engine/install/) To build the project and image using just Docker, run: *(replace `owner` with your name or organization)* ```bash docker build -t owner/glance:latest . ``` If you wish to push the image to a registry (by default Docker Hub), run: ```bash 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](https://heroicons.com/) 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](https://github.com/sponsors/glanceapp) 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. ================================================ FILE: docs/configuration.md ================================================ # Configuring Glance - [Preconfigured page](#preconfigured-page) - [The config file](#the-config-file) - [Auto reload](#auto-reload) - [Environment variables](#environment-variables) - [Other ways of providing tokens/passwords/secrets](#other-ways-of-providing-tokenspasswordssecrets) - [Including other config files](#including-other-config-files) - [Icons](#icons) - [Config schema](#config-schema) - [Authentication](#authentication) - [Server](#server) - [Document](#document) - [Branding](#branding) - [Theme](#theme) - [Available themes](#available-themes) - [Pages & Columns](#pages--columns) - [Widgets](#widgets) - [RSS](#rss) - [Videos](#videos) - [Hacker News](#hacker-news) - [Lobsters](#lobsters) - [Reddit](#reddit) - [Search](#search-widget) - [Group](#group) - [Split Column](#split-column) - [Custom API](#custom-api) - [Extension](#extension) - [Weather](#weather) - [Todo](#todo) - [Monitor](#monitor) - [Releases](#releases) - [Docker Containers](#docker-containers) - [DNS Stats](#dns-stats) - [Server Stats](#server-stats) - [Repository](#repository) - [Bookmarks](#bookmarks) - [Calendar](#calendar) - [Calendar (legacy)](#calendar-legacy) - [ChangeDetection.io](#changedetectionio) - [Clock](#clock) - [Markets](#markets) - [Twitch Channels](#twitch-channels) - [Twitch Top Games](#twitch-top-games) - [iframe](#iframe) - [HTML](#html) ## Preconfigured page If you don't want to spend time reading through all the available configuration options and just want something to get you going quickly you can use [this `glance.yml` file](glance.yml) and make changes to it as you see fit. It will give you a page that looks like the following:  Configure the widgets, add more of them, add extra pages, etc. Make it your own! ## The config file ### Auto reload Automatic config reload is supported, meaning that you can make changes to the config file and have them take effect on save without having to restart the container/service. Making changes to environment variables does not trigger a reload and requires manual restart. Deleting a config file will stop that file from being watched, even if it is recreated. > [!NOTE] > > If you attempt to start Glance with an invalid config it will exit with an error outright. If you successfully started Glance with a valid config and then made changes to it which result in an error, you'll see that error in the console and Glance will continue to run with the old configuration. You can then continue to make changes and when there are no errors the new configuration will be loaded. > [!CAUTION] > > Reloading the configuration file clears your cached data, meaning that you have to request the data anew each time you do this. This can lead to rate limiting for some APIs if you do it too frequently. Having a cache that persists between reloads will be added in the future. ### Environment variables Inserting environment variables is supported anywhere in the config. This is done via the `${ENV_VAR}` syntax. Attempting to use an environment variable that doesn't exist will result in an error and Glance will either not start or load your new config on save. Example: ```yaml server: host: ${HOST} port: ${PORT} ``` Can also be in the middle of a string: ```yaml - type: rss title: ${RSS_TITLE} feeds: - url: http://domain.com/rss/${RSS_CATEGORY}.xml ``` Works with any type of value, not just strings: ```yaml - type: rss limit: ${RSS_LIMIT} ``` If you need to use the syntax `${NAME}` in your config without it being interpreted as an environment variable, you can escape it by prefixing with a backslash `\`: ```yaml something: \${NOT_AN_ENV_VAR} ``` #### Other ways of providing tokens/passwords/secrets You can use [Docker secrets](https://docs.docker.com/compose/how-tos/use-secrets/) with the following syntax: ```yaml # This will be replaced with the contents of the file /run/secrets/github_token # so long as the secret `github_token` is provided to the container token: ${secret:github_token} ``` Alternatively, you can load the contents of a file who's path is provided by an environment variable: `docker-compose.yml` ```yaml services: glance: image: glanceapp/glance environment: - TOKEN_FILE=/home/user/token volumes: - /home/user/token:/home/user/token ``` `glance.yml` ```yaml token: ${readFileFromEnv:TOKEN_FILE} ``` > [!NOTE] > > The contents of the file will be stripped of any leading/trailing whitespace before being used. ### Including other config files Including config files from within your main config file is supported. This is done via the `$include` directive along with a relative or absolute path to the file you want to include. If the path is relative, it will be relative to the main config file. Additionally, environment variables can be used within included files, and changes to the included files will trigger an automatic reload. Example: ```yaml pages: - $include: home.yml - $include: videos.yml - $include: homelab.yml ``` The file you are including should not have any additional indentation, its values should be at the top level and the appropriate amount of indentation will be added automatically depending on where the file is included. Example: `glance.yml` ```yaml pages: - name: Home columns: - size: full widgets: - $include: rss.yml - name: News columns: - size: full widgets: - type: group widgets: - $include: rss.yml - type: reddit subreddit: news ``` `rss.yml` ```yaml - type: rss title: News feeds: - url: ${RSS_URL} ``` The `$include` directive can be used anywhere in the config file, not just in the `pages` property, however it must be on its own line and have the appropriate indentation. If you encounter YAML parsing errors when using the `$include` directive, the reported line numbers will likely be incorrect. This is because the inclusion of files is done before the YAML is parsed, as YAML itself does not support file inclusion. To help with debugging in cases like this, you can use the `config:print` command and pipe it into `less -N` to see the full config file with includes resolved and line numbers added: ```sh glance --config /path/to/glance.yml config:print | less -N ``` This is a bit more convoluted when running Glance inside a Docker container: ```sh docker run --rm -v ./glance.yml:/app/config/glance.yml glanceapp/glance config:print | less -N ``` This assumes that the config you want to print is in your current working directory and is named `glance.yml`. ## Icons For widgets which provide you with the ability to specify icons such as the monitor, bookmarks, docker containers, etc, you can use the `icon` property to specify a URL to an image or use icon names from multiple libraries via prefixes: ```yml icon: si:immich # si for Simple icons https://simpleicons.org/ icon: sh:immich # sh for selfh.st icons https://selfh.st/icons/ icon: di:immich # di for Dashboard icons https://github.com/homarr-labs/dashboard-icons icon: mdi:camera # mdi for Material Design icons https://pictogrammers.com/library/mdi/ ``` > [!NOTE] > > The icons are loaded externally and are hosted on `cdn.jsdelivr.net`, if you do not wish to depend on a 3rd party you are free to download the icons individually and host them locally. Icons from the Simple icons library as well as Material Design icons will automatically invert their color to match your light or dark theme, however you may want to enable this manually for other icons. To do this, you can use the `auto-invert` prefix: ```yaml icon: auto-invert https://example.com/path/to/icon.png # with a URL icon: auto-invert sh:glance-dark # with a selfh.st icon ``` This expects the icon to be black and will automatically invert it to white when using a dark theme. ## Config schema For property descriptions, validation and autocompletion of the config within your IDE, @not-first has kindly created a [schema](https://github.com/not-first/glance-schema). Massive thanks to them for this, go check it out and give them a star! ## Authentication To make sure that only you and the people you want to share your dashboard with have access to it, you can set up authentication via username and password. This is done through a top level `auth` property. Example: ```yaml auth: secret-key: # this must be set to a random value generated using the secret:make CLI command users: admin: password: 123456 svilen: password: 123456 ``` To generate a secret key, run the following command: ```sh ./glance secret:make ``` Or with Docker: ```sh docker run --rm glanceapp/glance secret:make ``` ### Using hashed passwords If you do not want to store plain passwords in your config file or in environment variables, you can hash your password and provide its hash instead: ```sh ./glance password:hash mysecretpassword ``` Or with Docker: ```sh docker run --rm glanceapp/glance password:hash mysecretpassword ``` Then, in your config file use the `password-hash` property instead of `password`: ```yaml auth: secret-key: # this must be set to a random value generated using the secret:make CLI command users: admin: password-hash: $2a$10$o6SXqiccI3DDP2dN4ADumuOeIHET6Q4bUMYZD6rT2Aqt6XQ3DyO.6 ``` ### Preventing brute-force attacks Glance will automatically block IP addresses of users who fail to authenticate 5 times in a row in the span of 5 minutes. In order for this feature to work correctly, Glance must know the real IP address of requests. If you're using a reverse proxy such as nginx, Traefik, NPM, etc, you must set the `proxied` property in the `server` configuration to `true`: ```yaml server: proxied: true ``` When set to `true`, Glance will use the `X-Forwarded-For` header to determine the original IP address of the request, so make sure that your reverse proxy is correctly configured to send that header. ## Server Server configuration is done through a top level `server` property. Example: ```yaml server: port: 8080 assets-path: /home/user/glance-assets ``` ### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | host | string | no | | | port | number | no | 8080 | | proxied | boolean | no | false | | base-url | string | no | | | assets-path | string | no | | #### `host` The address which the server will listen on. Setting it to `localhost` means that only the machine that the server is running on will be able to access the dashboard. By default it will listen on all interfaces. #### `port` A number between 1 and 65,535, so long as that port isn't already used by anything else. #### `proxied` Set to `true` if you're using a reverse proxy in front of Glance. This will make Glance use the `X-Forwarded-*` headers to determine the original request details. #### `base-url` The base URL that Glance is hosted under. No need to specify this unless you're using a reverse proxy and are hosting Glance under a directory. If that's the case then you can set this value to `/glance` or whatever the directory is called. Note that the forward slash (`/`) in the beginning is required unless you specify the full domain and path. > [!IMPORTANT] > You need to strip the `base-url` prefix before forwarding the request to the Glance server. > In Caddy you can do this using [`handle_path`](https://caddyserver.com/docs/caddyfile/directives/handle_path) or [`uri strip_prefix`](https://caddyserver.com/docs/caddyfile/directives/uri). #### `assets-path` The path to a directory that will be served by the server under the `/assets/` path. This is handy for widgets like the Monitor where you have to specify an icon URL and you want to self host all the icons rather than pointing to an external source. > [!IMPORTANT] > > When installing through docker the path will point to the files inside the container. Don't forget to mount your assets path to the same path inside the container. > Example: > > If your assets are in: > ``` > /home/user/glance-assets > ``` > > You should mount: > ``` > /home/user/glance-assets:/app/assets > ``` > > And your config should contain: > ``` > assets-path: /app/assets > ``` ##### Examples Say you have a directory `glance-assets` with a file `gitea-icon.png` in it and you specify your assets path like: ```yaml assets-path: /home/user/glance-assets ``` To be able to point to an asset from your assets path, use the `/assets/` path like such: ```yaml icon: /assets/gitea-icon.png ``` ## Document If you want to insert custom HTML into the `` of the document for all pages, you can do so by using the `document` property. Example: ```yaml document: head: | ``` ## Branding You can adjust the various parts of the branding through a top level `branding` property. Example: ```yaml branding: custom-footer: |
Powered by Glance
logo-url: /assets/logo.png favicon-url: /assets/logo.png app-name: "My Dashboard" app-icon-url: "/assets/app-icon.png" app-background-color: "#151519" ``` ### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | hide-footer | bool | no | false | | custom-footer | string | no | | | logo-text | string | no | G | | logo-url | string | no | | | favicon-url | string | no | | | app-name | string | no | Glance | | app-icon-url | string | no | Glance's default icon | | app-background-color | string | no | Glance's default background color | #### `hide-footer` Hides the footer when set to `true`. #### `custom-footer` Specify custom HTML to use for the footer. #### `logo-text` Specify custom text to use instead of the "G" found in the navigation. #### `logo-url` Specify a URL to a custom image to use instead of the "G" found in the navigation. If both `logo-text` and `logo-url` are set, only `logo-url` will be used. #### `favicon-url` Specify a URL to a custom image to use for the favicon. #### `app-name` Specify the name of the web app shown in browser tab and PWA. #### `app-icon-url` Specify URL for PWA and browser tab icon (512x512 PNG). #### `app-background-color` Specify background color for PWA. Must be a valid CSS color. ## Theme Theming is done through a top level `theme` property. Values for the colors are in [HSL](https://giggster.com/guide/basics/hue-saturation-lightness/) (hue, saturation, lightness) format. You can use a color picker [like this one](https://hslpicker.com/) to convert colors from other formats to HSL. The values are separated by a space and `%` is not required for any of the numbers. Example: ```yaml theme: # This will be the default theme background-color: 100 20 10 primary-color: 40 90 40 contrast-multiplier: 1.1 disable-picker: false presets: gruvbox-dark: background-color: 0 0 16 primary-color: 43 59 81 positive-color: 61 66 44 negative-color: 6 96 59 zebra: light: true background-color: 0 0 95 primary-color: 0 0 10 negative-color: 0 90 50 ``` ### Available themes If you don't want to spend time configuring your own theme, there are [several available themes](themes.md) which you can simply copy the values for. ### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | light | boolean | no | false | | background-color | HSL | no | 240 8 9 | | primary-color | HSL | no | 43 50 70 | | positive-color | HSL | no | same as `primary-color` | | negative-color | HSL | no | 0 70 70 | | contrast-multiplier | number | no | 1 | | text-saturation-multiplier | number | no | 1 | | custom-css-file | string | no | | | disable-picker | bool | false | | | presets | object | no | | #### `light` Whether the scheme is light or dark. This does not change the background color, it inverts the text colors so that they look appropriately on a light background. #### `background-color` Color of the page and widgets. #### `primary-color` Color used across the page, largely to indicate unvisited links. #### `positive-color` Used to indicate that something is positive, such as stock price being up, twitch channel being live or a monitored site being online. If not set, the value of `primary-color` will be used. #### `negative-color` Oppposite of `positive-color`. #### `contrast-multiplier` Used to increase or decrease the contrast (in other words visibility) of the text. A value of `1.3` means that the text will be 30% lighter/darker depending on the scheme. Use this if you think that some of the text on the page is too dark and hard to read. Example:  #### `text-saturation-multiplier` Used to increase or decrease the saturation of text, useful when using a custom background color with a high amount of saturation and needing the text to have a more neutral color. `0.5` means that the saturation will be 50% lower and `1.5` means that it'll be 50% higher. #### `custom-css-file` Path to a custom CSS file, either external or one from within the server configured assets path. Example: ```yaml theme: custom-css-file: /assets/my-style.css ``` > [!TIP] > > Because Glance uses a lot of utility classes it might be difficult to target some elements. To make it easier to style specific widgets, each widget has a `widget-type-{name}` class, so for example if you wanted to make the links inside just the RSS widget bigger you could use the following selector: > > ```css > .widget-type-rss a { > font-size: 1.5rem; > } > ``` > > In addition, you can also use the `css-class` property which is available on every widget to set custom class names for individual widgets. #### `disable-picker` When set to `true` hides the theme picker and disables the abiltity to switch between themes. All users who previously picked a non-default theme will be switched over to the default theme. #### `presets` Define additional theme presets that can be selected from the theme picker on the page. For each preset, you can specify the same properties as for the default theme, such as `background-color`, `primary-color`, `positive-color`, `negative-color`, `contrast-multiplier`, etc., except for the `custom-css-file` property. Example: ```yaml theme: presets: my-custom-dark-theme: background-color: 229 19 23 contrast-multiplier: 1.2 primary-color: 222 74 74 positive-color: 96 44 68 negative-color: 359 68 71 my-custom-light-theme: light: true background-color: 220 23 95 contrast-multiplier: 1.1 primary-color: 220 91 54 positive-color: 109 58 40 negative-color: 347 87 44 ``` To override the default dark and light themes, use the key names `default-dark` and `default-light`. ## Pages & Columns  Using pages and columns is how widgets are organized. Each page contains up to 3 columns and each column can have any number of widgets. ### Pages Pages are defined through a top level `pages` property. The page defined first becomes the home page and all pages get automatically added to the navigation bar in the order that they were defined. Example: ```yaml pages: - name: Home columns: ... - name: Videos columns: ... - name: Homelab columns: ... ``` ### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | name | string | yes | | | slug | string | no | | | width | string | no | | | desktop-navigation-width | string | no | | | center-vertically | boolean | no | false | | hide-desktop-navigation | boolean | no | false | | show-mobile-header | boolean | no | false | | head-widgets | array | no | | | columns | array | yes | | #### `name` The name of the page which gets shown in the navigation bar. #### `slug` The URL friendly version of the title which is used to access the page. For example if the title of the page is "RSS Feeds" you can make the page accessible via `localhost:8080/feeds` by setting the slug to `feeds`. If not defined, it will automatically be generated from the title. #### `width` The maximum width of the page on desktop. Possible values are `default`, `slim` and `wide`. #### `desktop-navigation-width` The maximum width of the desktop navigation. Useful if you have a few pages that use a different width than the rest and don't want the navigation to jump abruptly when going to and away from those pages. Possible values are `default`, `slim` and `wide`. Here are the pixel equivalents for each value: * default: `1600px` * slim: `1100px` * wide: `1920px` > [!NOTE] > > When using `slim`, the maximum number of columns allowed for that page is `2`. #### `center-vertically` When set to `true`, vertically centers the content on the page. Has no effect if the content is taller than the height of the viewport. #### `hide-desktop-navigation` Whether to show the navigation links at the top of the page on desktop. #### `show-mobile-header` Whether to show a header displaying the name of the page on mobile. The header purposefully has a lot of vertical whitespace in order to push the content down and make it easier to reach on tall devices. Preview:  #### `head-widgets` Head widgets will be shown at the top of the page, above the columns, and take up the combined width of all columns. You can specify any widget, though some will look better than others, such as the markets, RSS feed with `horizontal-cards` style, and videos widgets. Example:  ```yaml pages: - name: Home head-widgets: - type: markets hide-header: true markets: - symbol: SPY name: S&P 500 - symbol: BTC-USD name: Bitcoin - symbol: NVDA name: NVIDIA - symbol: AAPL name: Apple - symbol: MSFT name: Microsoft columns: - size: small widgets: - type: calendar - size: full widgets: - type: hacker-news - size: small widgets: - type: weather location: London, United Kingdom ``` ### Columns Columns are defined for each page using a `columns` property. There are two types of columns - `full` and `small`, which refers to their width. A small column takes up a fixed amount of width (300px) and a full column takes up the all of the remaining width. You can have up to 3 columns per page and you must have either 1 or 2 full columns. Example: ```yaml pages: - name: Home columns: - size: small widgets: ... - size: full widgets: ... - size: small widgets: ... ``` ### Properties | Name | Type | Required | | ---- | ---- | -------- | | size | string | yes | | widgets | array | no | Here are some of the possible column configurations:  ```yaml columns: - size: small widgets: ... - size: full widgets: ... - size: small widgets: ... ```  ```yaml columns: - size: full widgets: ... - size: small widgets: ... ```  ```yaml columns: - size: full widgets: ... - size: full widgets: ... ``` ## Widgets Widgets are defined for each column using a `widgets` property. Example: ```yaml pages: - name: Home columns: - size: small widgets: - type: weather location: London, United Kingdom ``` > [!NOTE] > > Currently not all widgets are designed to fit every column size, however some widgets offer different "styles" that help alleviate this limitation. ### Shared Properties | Name | Type | Required | | ---- | ---- | -------- | | type | string | yes | | title | string | no | | title-url | string | no | | hide-header | boolean | no | false | | cache | string | no | | css-class | string | no | #### `type` Used to specify the widget. #### `title` The title of the widget. If left blank it will be defined by the widget. #### `title-url` The URL to go to when clicking on the widget's title. If left blank it will be defined by the widget (if available). #### `hide-header` When set to `true`, the header (title) of the widget will be hidden. You cannot hide the header of the group widget. > [!NOTE] > > If a widget fails to update, a red dot or circle is shown next to the title of that widget indicating that the it is not working. You will not be able to see this if you hide the header. #### `cache` How long to keep the fetched data in memory. The value is a string and must be a number followed by one of s, m, h, d. Examples: ```yaml cache: 30s # 30 seconds cache: 5m # 5 minutes cache: 2h # 2 hours cache: 1d # 1 day ``` > [!NOTE] > > Not all widgets can have their cache duration modified. The calendar and weather widgets update on the hour and this cannot be changed. #### `css-class` Set custom CSS classes for the specific widget instance. ### RSS Display a list of articles from multiple RSS feeds. Example: ```yaml - type: rss title: News style: horizontal-cards feeds: - url: https://feeds.bloomberg.com/markets/news.rss title: Bloomberg - url: https://moxie.foxbusiness.com/google-publisher/markets.xml title: Fox Business - url: https://moxie.foxbusiness.com/google-publisher/technology.xml title: Fox Business ``` #### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | style | string | no | vertical-list | | feeds | array | yes | | thumbnail-height | float | no | 10 | | card-height | float | no | 27 | | limit | integer | no | 25 | | preserve-order | bool | no | false | | single-line-titles | boolean | no | false | | collapse-after | integer | no | 5 | ##### `limit` The maximum number of articles to show. ##### `collapse-after` How many articles are visible before the "SHOW MORE" button appears. Set to `-1` to never collapse. ##### `preserve-order` When set to `true`, the order of the articles will be preserved as they are in the feeds. Useful if a feed uses its own sorting order which denotes the importance of the articles. If you use this property while having a lot of feeds, it's recommended to set a `limit` to each individual feed since if the first defined feed has 15 articles, the articles from the second feed will start after the 15th article in the list. ##### `single-line-titles` When set to `true`, truncates the title of each post if it exceeds one line. Only applies when the style is set to `vertical-list`. ##### `style` Used to change the appearance of the widget. Possible values are: * `vertical-list` - suitable for `full` and `small` columns * `detailed-list` - suitable for `full` columns * `horizontal-cards` - suitable for `full` columns * `horizontal-cards-2` - suitable for `full` columns Below is a preview of each style: `vertical-list`  `detailed-list`  `horizontal-cards`  `horizontal-cards-2`  ##### `thumbnail-height` Used to modify the height of the thumbnails. Works only when the style is set to `horizontal-cards`. The default value is `10` and the units are `rem`, if you want to for example double the height of the thumbnails you can set it to `20`. ##### `card-height` Used to modify the height of cards when using the `horizontal-cards-2` style. The default value is `27` and the units are `rem`. ##### `feeds` An array of RSS/atom feeds. The title can optionally be changed. ###### Properties for each feed | Name | Type | Required | Default | Notes | | ---- | ---- | -------- | ------- | ----- | | url | string | yes | | | | title | string | no | the title provided by the feed | | | hide-categories | boolean | no | false | Only applicable for `detailed-list` style | | hide-description | boolean | no | false | Only applicable for `detailed-list` style | | limit | integer | no | | | | item-link-prefix | string | no | | | | headers | key (string) & value (string) | no | | | ###### `limit` The maximum number of articles to show from that specific feed. Useful if you have a feed which posts a lot of articles frequently and you want to prevent it from excessively pushing down articles from other feeds. ###### `item-link-prefix` If an RSS feed isn't returning item links with a base domain and Glance has failed to automatically detect the correct domain you can manually add a prefix to each link with this property. ###### `headers` Optionally specify the headers that will be sent with the request. Example: ```yaml - type: rss feeds: - url: https://domain.com/rss headers: User-Agent: Custom User Agent ``` ### Videos Display a list of the latest videos from specific YouTube channels. Example: ```yaml - type: videos channels: - UCXuqSBlHAE6Xw-yeJA0Tunw - UCBJycsmduvYEL83R_U4JriQ - UCHnyfMqiRRG1u-2MsSQLbXA ``` Preview:  #### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | channels | array | yes | | | playlists | array | no | | | limit | integer | no | 25 | | style | string | no | horizontal-cards | | collapse-after | integer | no | 7 | | collapse-after-rows | integer | no | 4 | | include-shorts | boolean | no | false | | video-url-template | string | no | https://www.youtube.com/watch?v={VIDEO-ID} | ##### `channels` A list of channels IDs. One way of getting the ID of a channel is going to the channel's page and clicking on its description:  Then scroll down and click on "Share channel", then "Copy channel ID":  ##### `playlists` A list of playlist IDs: ```yaml - type: videos playlists: - PL8mG-RkN2uTyZZ00ObwZxxoG_nJbs3qec - PL8mG-RkN2uTxTK4m_Vl2dYR9yE41kRdBg ``` The playlist ID can be found in its link which is in the form of ``` https://www.youtube.com...&list={ID}&... ``` ##### `limit` The maximum number of videos to show. ##### `collapse-after` Specify the number of videos to show when using the `vertical-list` style before the "SHOW MORE" button appears. ##### `collapse-after-rows` Specify the number of rows to show when using the `grid-cards` style before the "SHOW MORE" button appears. ##### `style` Used to change the appearance of the widget. Possible values are `horizontal-cards`, `vertical-list` and `grid-cards`. Preview of `vertical-list`:  Preview of `grid-cards`:  ##### `video-url-template` Used to replace the default link for videos. Useful when you're running your own YouTube front-end. Example: ```yaml video-url-template: https://invidious.your-domain.com/watch?v={VIDEO-ID} ``` Placeholders: `{VIDEO-ID}` - the ID of the video ### Hacker News Display a list of posts from [Hacker News](https://news.ycombinator.com/). Example: ```yaml - type: hacker-news limit: 15 collapse-after: 5 ``` Preview:  #### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | limit | integer | no | 15 | | collapse-after | integer | no | 5 | | comments-url-template | string | no | https://news.ycombinator.com/item?id={POST-ID} | | sort-by | string | no | top | | extra-sort-by | string | no | | ##### `comments-url-template` Used to replace the default link for post comments. Useful if you want to use an alternative front-end. Example: ```yaml comments-url-template: https://www.hckrnws.com/stories/{POST-ID} ``` Placeholders: `{POST-ID}` - the ID of the post ##### `sort-by` Used to specify the order in which the posts should get returned. Possible values are `top`, `new`, and `best`. ##### `extra-sort-by` Can be used to specify an additional sort which will be applied on top of the already sorted posts. By default does not apply any extra sorting and the only available option is `engagement`. The `engagement` sort tries to place the posts with the most points and comments on top, also prioritizing recent over old posts. ### Lobsters Display a list of posts from [Lobsters](https://lobste.rs). Example: ```yaml - type: lobsters sort-by: hot tags: - go - security - linux limit: 15 collapse-after: 5 ``` Preview:  #### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | instance-url | string | no | https://lobste.rs/ | | custom-url | string | no | | | limit | integer | no | 15 | | collapse-after | integer | no | 5 | | sort-by | string | no | hot | | tags | array | no | | ##### `instance-url` The base URL for a lobsters instance hosted somewhere other than on lobste.rs. Example: ```yaml instance-url: https://www.journalduhacker.net/ ``` ##### `custom-url` A custom URL to retrieve lobsters posts from. If this is specified, the `instance-url`, `sort-by` and `tags` properties are ignored. ##### `limit` The maximum number of posts to show. ##### `collapse-after` How many posts are visible before the "SHOW MORE" button appears. Set to `-1` to never collapse. ##### `sort-by` The sort order in which posts are returned. Possible options are `hot` and `new`. ##### `tags` Limit to posts containing one of the given tags. **You cannot specify a sort order when filtering by tags, it will default to `hot`.** ### Reddit Display a list of posts from a specific subreddit. > [!WARNING] > > Reddit does not allow unauthorized API access from VPS IPs, if you're hosting Glance on a VPS you will get a 403 > response. As a workaround you can either [register an app on Reddit](https://ssl.reddit.com/prefs/apps/) and use the > generated ID and secret in the widget configuration to authenticate your requests (see `app-auth` property), use a proxy > (see `proxy` property) or route the traffic from Glance through a VPN. Example: ```yaml - type: reddit subreddit: technology ``` #### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | subreddit | string | yes | | | style | string | no | vertical-list | | show-thumbnails | boolean | no | false | | show-flairs | boolean | no | false | | limit | integer | no | 15 | | collapse-after | integer | no | 5 | | comments-url-template | string | no | https://www.reddit.com/{POST-PATH} | | request-url-template | string | no | | | proxy | string or multiple parameters | no | | | sort-by | string | no | hot | | top-period | string | no | day | | search | string | no | | | extra-sort-by | string | no | | | app-auth | object | no | | ##### `subreddit` The subreddit for which to fetch the posts from. ##### `style` Used to change the appearance of the widget. Possible values are `vertical-list`, `horizontal-cards` and `vertical-cards`. The first two were designed for full columns and the last for small columns. `vertical-list`  `horizontal-cards`  `vertical-cards`  ##### `show-thumbnails` Shows or hides thumbnails next to the post. This only works if the `style` is `vertical-list`. Preview:  > [!NOTE] > > Thumbnails don't work for some subreddits due to Reddit's API not returning the thumbnail URL. No workaround for this yet. ##### `show-flairs` Shows post flairs when set to `true`. ##### `limit` The maximum number of posts to show. ##### `collapse-after` How many posts are visible before the "SHOW MORE" button appears. Set to `-1` to never collapse. Not available when using the `vertical-cards` and `horizontal-cards` styles. ##### `comments-url-template` Used to replace the default link for post comments. Useful if you want to use the old Reddit design or any other 3rd party front-end. Example: ```yaml comments-url-template: https://old.reddit.com/{POST-PATH} ``` Placeholders: `{POST-PATH}` - the full path to the post, such as: ``` r/selfhosted/comments/bsp01i/welcome_to_rselfhosted_please_read_this_first/ ``` `{POST-ID}` - the ID that comes after `/comments/` `{SUBREDDIT}` - the subreddit name ##### `request-url-template` A custom request URL that will be used to fetch the data. This is useful when you're hosting Glance on a VPS where Reddit is blocking the requests and you want to route them through a proxy that accepts the URL as either a part of the path or a query parameter. Placeholders: `{REQUEST-URL}` - will be templated and replaced with the expanded request URL (i.e. https://www.reddit.com/r/selfhosted/hot.json). Example: ``` https://proxy/{REQUEST-URL} https://your.proxy/?url={REQUEST-URL} ``` ##### `proxy` A custom HTTP/HTTPS proxy URL that will be used to fetch the data. This is useful when you're hosting Glance on a VPS where Reddit is blocking the requests and you want to bypass the restriction by routing the requests through a proxy. Example: ```yaml proxy: http://user:pass@proxy.com:8080 proxy: https://user:pass@proxy.com:443 ``` Alternatively, you can specify the proxy URL as well as additional options by using multiple parameters: ```yaml proxy: url: http://proxy.com:8080 allow-insecure: true timeout: 10s ``` ###### `allow-insecure` When set to `true`, allows the use of insecure connections such as when the proxy has a self-signed certificate. ###### `timeout` The maximum time to wait for a response from the proxy. The value is a string and must be a number followed by one of s, m, h, d. Example: `10s` for 10 seconds, `1m` for 1 minute, etc ##### `sort-by` Can be used to specify the order in which the posts should get returned. Possible values are `hot`, `new`, `top` and `rising`. ##### `top-period` Available only when `sort-by` is set to `top`. Possible values are `hour`, `day`, `week`, `month`, `year` and `all`. ##### `search` Keywords to search for. Searching within specific fields is also possible, **though keep in mind that Reddit may remove the ability to use any of these at any time**:  ##### `extra-sort-by` Can be used to specify an additional sort which will be applied on top of the already sorted posts. By default does not apply any extra sorting and the only available option is `engagement`. The `engagement` sort tries to place the posts with the most points and comments on top, also prioritizing recent over old posts. ##### `app-auth` ```yaml widgets: - type: reddit subreddit: technology app-auth: name: ${REDDIT_APP_NAME} id: ${REDDIT_APP_CLIENT_ID} secret: ${REDDIT_APP_SECRET} ``` To register an app on Reddit, go to [this page](https://ssl.reddit.com/prefs/apps/). ### Search Widget Display a search bar that can be used to search for specific terms on various search engines. Example: ```yaml - type: search search-engine: duckduckgo bangs: - title: YouTube shortcut: "!yt" url: https://www.youtube.com/results?search_query={QUERY} ``` Preview:  #### Keyboard shortcuts | Keys | Action | Condition | | ---- | ------ | --------- | | S | Focus the search bar | Not already focused on another input field | | Enter | Perform search in the same tab | Search input is focused and not empty | | Ctrl + Enter | Perform search in a new tab | Search input is focused and not empty | | Escape | Leave focus | Search input is focused | | Up | Insert the last search query since the page was opened into the input field | Search input is focused | > [!TIP] > > You can use the property `new-tab` with a value of `true` if you want to show search results in a new tab by default. Ctrl + Enter will then show results in the same tab. #### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | search-engine | string | no | duckduckgo | | new-tab | boolean | no | false | | autofocus | boolean | no | false | | target | string | no | _blank | | placeholder | string | no | Type here to search… | | bangs | array | no | | ##### `search-engine` Either a value from the table below or a URL to a custom search engine. Use `{QUERY}` to indicate where the query value gets placed. | Name | URL | | ---- | --- | | duckduckgo | `https://duckduckgo.com/?q={QUERY}` | | google | `https://www.google.com/search?q={QUERY}` | | bing | `https://www.bing.com/search?q={QUERY}` | | perplexity | `https://www.perplexity.ai/search?q={QUERY}` | | kagi | `https://kagi.com/search?q={QUERY}` | | startpage | `https://www.startpage.com/search?q={QUERY}` | ##### `new-tab` When set to `true`, swaps the shortcuts for showing results in the same or new tab, defaulting to showing results in a new tab. ##### `autofocus` When set to `true`, automatically focuses the search input on page load. ##### `target` The target to use when opening the search results in a new tab. Possible values are `_blank`, `_self`, `_parent` and `_top`. ##### `placeholder` When set, modifies the text displayed in the input field before typing. ##### `bangs` What now? [Bangs](https://duckduckgo.com/bangs). They're shortcuts that allow you to use the same search box for many different sites. Assuming you have it configured, if for example you start your search input with `!yt` you'd be able to perform a search on YouTube:  ##### Properties for each bang | Name | Type | Required | | ---- | ---- | -------- | | title | string | no | | shortcut | string | yes | | url | string | yes | ###### `title` Optional title that will appear on the right side of the search bar when the query starts with the associated shortcut. ###### `shortcut` Any value you wish to use as the shortcut for the search engine. It does not have to start with `!`. > [!IMPORTANT] > > In YAML some characters have special meaning when placed in the beginning of a value. If your shortcut starts with `!` (and potentially some other special characters) you'll have to wrap the value in quotes: > ```yaml > shortcut: "!yt" >``` ###### `url` The URL of the search engine. Use `{QUERY}` to indicate where the query value gets placed. Examples: ```yaml url: https://www.reddit.com/search?q={QUERY} url: https://store.steampowered.com/search/?term={QUERY} url: https://www.amazon.com/s?k={QUERY} ``` ### Group Group multiple widgets into one using tabs. Widgets are defined using a `widgets` property exactly as you would on a page column. The only limitation is that you cannot place a group widget or a split column widget within a group widget. Example: ```yaml - type: group widgets: - type: reddit subreddit: gamingnews show-thumbnails: true collapse-after: 6 - type: reddit subreddit: games - type: reddit subreddit: pcgaming show-thumbnails: true ``` Preview:  #### Sharing properties To avoid repetition you can use [YAML anchors](https://support.atlassian.com/bitbucket-cloud/docs/yaml-anchors/) and share properties between widgets. Example: ```yaml - type: group define: &shared-properties type: reddit show-thumbnails: true collapse-after: 6 widgets: - subreddit: gamingnews <<: *shared-properties - subreddit: games <<: *shared-properties - subreddit: pcgaming <<: *shared-properties ``` ### Split Column Splits a full sized column in half, allowing you to place widgets side by side horizontally. This is converted to a single column on mobile devices or if not enough width is available. Widgets are defined using a `widgets` property exactly as you would on a page column. Two widgets side by side in a `full` column: View glance.yml
```yaml # ... - size: full widgets: - type: split-column widgets: - type: hacker-news collapse-after: 3 - type: lobsters collapse-after: 3 - type: videos # ... ```
You can also achieve a number of different full page layouts using just this widget, such as: 3 column layout where all columns have equal width: 
View glance.yml
```yaml pages: - name: Home columns: - size: full widgets: - type: split-column max-columns: 3 widgets: - type: reddit subreddit: selfhosted collapse-after: 15 - type: reddit subreddit: homelab collapse-after: 15 - type: reddit subreddit: sysadmin collapse-after: 15 ```
4 column layout where all columns have equal width (and the page is set to `width: wide`): 
View glance.yml
```yaml pages: - name: Home width: wide columns: - size: full widgets: - type: split-column max-columns: 4 widgets: - type: reddit subreddit: selfhosted collapse-after: 15 - type: reddit subreddit: homelab collapse-after: 15 - type: reddit subreddit: linux collapse-after: 15 - type: reddit subreddit: sysadmin collapse-after: 15 ```
Masonry layout with up to 5 columns where all columns have equal width (and the page is set to `width: wide`): 
View glance.yml
```yaml define: - &subreddit-settings type: reddit collapse-after: 5 pages: - name: Home width: wide columns: - size: full widgets: - type: split-column max-columns: 5 widgets: - subreddit: selfhosted <<: *subreddit-settings - subreddit: homelab <<: *subreddit-settings - subreddit: linux <<: *subreddit-settings - subreddit: sysadmin <<: *subreddit-settings - subreddit: DevOps <<: *subreddit-settings - subreddit: Networking <<: *subreddit-settings - subreddit: DataHoarding <<: *subreddit-settings - subreddit: OpenSource <<: *subreddit-settings - subreddit: Privacy <<: *subreddit-settings - subreddit: FreeSoftware <<: *subreddit-settings ```
Just like the `group` widget, you can insert any widget type, you can even insert a `group` widget inside of a `split-column` widget, but you can't insert a `split-column` widget inside of a `group` widget. ### Custom API Display data from a JSON API using a custom template. > [!NOTE] > > The configuration of this widget requires some basic knowledge of programming, HTML, CSS, the Go template language and Glance-specific concepts. Examples: 
View glance.yml
```yaml - type: custom-api title: Random Fact cache: 6h url: https://uselessfacts.jsph.pl/api/v2/facts/random template: |
{{ .JSON.String "text" }}
```
View glance.yml
```yaml - type: custom-api title: Immich stats cache: 1d url: https://${IMMICH_URL}/api/server/statistics headers: x-api-key: ${IMMICH_API_KEY} Accept: application/json template: |
{{ .JSON.Int "photos" | formatNumber }}
PHOTOS
{{ .JSON.Int "videos" | formatNumber }}
VIDEOS
{{ div (.JSON.Int "usage" | toFloat) 1073741824 | toInt | formatNumber }}GB
USAGE
View glance.yml
```yaml - type: custom-api title: Steam Specials cache: 12h url: https://store.steampowered.com/api/featuredcategories?cc=us template: |
-
{{ range .JSON.Array "specials.items" }}
-
{{ .String "name" }}
- {{ div (.Int "final_price" | toFloat) 100 | printf "$%.2f" }} {{ $discount := .Int "discount_percent" }}
View examples
Instead of defining options within the template and having to modify the template itself like such: ```yaml - type: custom-api template: | {{ /* User configurable options */ }} {{ $collapseAfter := 5 }} {{ $showThumbnails := true }} {{ $showFlairs := false }}
-
{{ if $showThumbnails }}
-
- {{ .JSON.String "flair" }} {{ end }}
-
{{ if (.Options.BoolOr "show-thumbnails" true) }}
-
- {{ .JSON.String "flair" }} {{ end }}
{{ .JSON.String "text" }}
{{ (.Subrequest "another-one").JSON.String "text" }}
``` The subrequests support all the same properties as the main request, except for `subrequests` itself, so you can use `headers`, `parameters`, etc. `(.Subrequest "key")` can be a little cumbersome to write, so you can define a variable to make it easier: ```yaml template: | {{ $anotherOne := .Subrequest "another-one" }}{{ $anotherOne.JSON.String "text" }}
``` You can also access the `.Response` property of a subrequest as you would with the main request: ```yaml template: | {{ $anotherOne := .Subrequest "another-one" }}{{ $anotherOne.Response.StatusCode }}
``` > [!NOTE] > > Setting this property will override any query parameters that are already in the URL. ```yaml parameters: param1: value1 param2: - item1 - item2 ``` ### Extension Display a widget provided by an external source (3rd party). If you want to learn more about developing extensions, checkout the [extensions documentation](extensions.md) (WIP). ```yaml - type: extension url: https://domain.com/widget/display-a-message allow-potentially-dangerous-html: true parameters: message: Hello, world! ``` #### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | url | string | yes | | | fallback-content-type | string | no | | | allow-potentially-dangerous-html | boolean | no | false | | headers | key & value | no | | | parameters | key & value | no | | ##### `url` The URL of the extension. **Note that the query gets stripped from this URL and the one defined by `parameters` gets used instead.** ##### `fallback-content-type` Optionally specify the fallback content type of the extension if the URL does not return a valid `Widget-Content-Type` header. Currently the only supported value for this property is `html`. ##### `headers` Optionally specify the headers that will be sent with the request. Example: ```yaml headers: x-api-key: ${SECRET_KEY} ``` ##### `allow-potentially-dangerous-html` Whether to allow the extension to display HTML. > [!WARNING] > > There's a reason this property is scary-sounding. It's intended to be used by developers who are comfortable with developing and using their own extensions. Do not enable it if you have no idea what it means or if you're not **absolutely sure** that the extension URL you're using is safe. ##### `parameters` A list of keys and values that will be sent to the extension as query paramters. ### Weather Display weather information for a specific location. The data is provided by https://open-meteo.com/. Example: ```yaml - type: weather units: metric hour-format: 12h location: London, United Kingdom ``` > [!NOTE] > > US cities which have common names can have their state specified as the second parameter as such: > > * Greenville, North Carolina, United States > * Greenville, South Carolina, United States > * Greenville, Mississippi, United States Preview:  Each bar represents a 2 hour interval. The yellow background represents sunrise and sunset. The blue dots represent the times of the day where there is a high chance for precipitation. You can hover over the bars to view the exact temperature for that time. #### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | location | string | yes | | | units | string | no | metric | | hour-format | string | no | 12h | | hide-location | boolean | no | false | | show-area-name | boolean | no | false | ##### `location` The name of the city and country to fetch weather information for. Attempting to launch the applcation with an invalid location will result in an error. You can use the [gecoding API page](https://open-meteo.com/en/docs/geocoding-api) to search for your specific location. Glance will use the first result from the list if there are multiple. ##### `units` Whether to show the temperature in celsius or fahrenheit, possible values are `metric` or `imperial`. #### `hour-format` Whether to show the hours of the day in 12-hour format or 24-hour format. Possible values are `12h` and `24h`. ##### `hide-location` Optionally don't display the location name on the widget. ##### `show-area-name` Whether to display the state/administrative area in the location name. If set to `true` the location will be displayed as: ``` Greenville, North Carolina, United States ``` Otherwise, if set to `false` (which is the default) it'll be displayed as: ``` Greenville, United States ``` ### Todo A simple to-do list that allows you to add, edit and delete tasks. The tasks are stored in the browser's local storage. Example: ```yaml - type: to-do ``` Preview:  To reorder tasks, drag and drop them by grabbing the top side of the task:  To delete a task, hover over it and click on the trash icon. #### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | id | string | no | | ##### `id` The ID of the todo list. If you want to have multiple todo lists, you must specify a different ID for each one. The ID is used to store the tasks in the browser's local storage. This means that if you have multiple todo lists with the same ID, they will share the same tasks. #### Keyboard shortcuts | Keys | Action | Condition | | ---- | ------ | --------- | | Enter | Add a task to the bottom of the list | When the "Add a task" field is focused | | Ctrl + Enter | Add a task to the top of the list | When the "Add a task" field is focused | | Down Arrow | Focus the last task that was added | When the "Add a task" field is focused | | Escape | Focus the "Add a task" field | When a task is focused | ### Monitor Display a list of sites and whether they are reachable (online) or not. This is determined by sending a GET request to the specified URL, if the response is 200 then the site is OK. The time it took to receive a response is also shown in milliseconds. Example: ```yaml - type: monitor cache: 1m title: Services sites: - title: Jellyfin url: https://jellyfin.yourdomain.com icon: /assets/jellyfin-logo.png - title: Gitea url: https://gitea.yourdomain.com icon: /assets/gitea-logo.png - title: Immich url: https://immich.yourdomain.com icon: /assets/immich-logo.png - title: AdGuard Home url: https://adguard.yourdomain.com icon: /assets/adguard-logo.png - title: Vaultwarden url: https://vault.yourdomain.com icon: /assets/vaultwarden-logo.png ``` Preview:  You can hover over the "ERROR" text to view more information. #### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | sites | array | yes | | | style | string | no | | | show-failing-only | boolean | no | false | ##### `show-failing-only` Shows only a list of failing sites when set to `true`. ##### `style` Used to change the appearance of the widget. Possible values are `compact`. Preview of `compact`:  ##### `sites` Properties for each site: | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | title | string | yes | | | url | string | yes | | | check-url | string | no | | | error-url | string | no | | | icon | string | no | | | timeout | string | no | 3s | | allow-insecure | boolean | no | false | | same-tab | boolean | no | false | | alt-status-codes | array | no | | | basic-auth | object | no | | `title` The title used to indicate the site. `url` The URL of the monitored service, which must be reachable by Glance, and will be used as the link to go to when clicking on the title. If `check-url` is not specified, this is used as the status check. `check-url` The URL which will be requested and its response will determine the status of the site. If not specified, the `url` property is used. `error-url` If the monitored service returns an error, the user will be redirected here. If not specified, the `url` property is used. `icon` See [Icons](#icons) for more information on how to specify icons. `timeout` How long to wait for a response from the server before considering it unreachable. The value is a string and must be a number followed by one of s, m, h, d. Example: `5s` for 5 seconds, `1m` for 1 minute, etc. `allow-insecure` Whether to ignore invalid/self-signed certificates. `same-tab` Whether to open the link in the same or a new tab. `alt-status-codes` Status codes other than 200 that you want to return "OK". ```yaml alt-status-codes: - 403 ``` `basic-auth` HTTP Basic Authentication credentials for protected sites. ```yaml basic-auth: username: your-username password: your-password ``` ### Releases Display a list of latest releases for specific repositories on Github, GitLab, Codeberg or Docker Hub. Example: ```yaml - type: releases show-source-icon: true repositories: - go-gitea/gitea - jellyfin/jellyfin - glanceapp/glance - codeberg:redict/redict - gitlab:fdroid/fdroidclient - dockerhub:gotify/server ``` Preview:  #### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | repositories | array | yes | | | show-source-icon | boolean | no | false | | | token | string | no | | | gitlab-token | string | no | | | limit | integer | no | 10 | | collapse-after | integer | no | 5 | ##### `repositories` A list of repositores to fetch the latest release for. Only the name/repo is required, not the full URL. A prefix can be specified for repositories hosted elsewhere such as GitLab, Codeberg and Docker Hub. Example: ```yaml repositories: - gitlab:inkscape/inkscape - dockerhub:glanceapp/glance - codeberg:redict/redict ``` Official images on Docker Hub can be specified by omitting the owner: ```yaml repositories: - dockerhub:nginx - dockerhub:node - dockerhub:alpine ``` You can also specify exact tags for Docker Hub images: ```yaml repositories: - dockerhub:nginx:latest - dockerhub:nginx:stable-alpine ``` To include prereleases you can specify the repository as an object and use the `include-prereleases` property: **Note: This feature is currently only available for GitHub repositories.** ```yaml repositories: - gitlab:inkscape/inkscape - repository: glanceapp/glance include-prereleases: true - codeberg:redict/redict ``` ##### `show-source-icon` Shows an icon of the source (GitHub/GitLab/Codeberg/Docker Hub) next to the repository name when set to `true`. ##### `token` Without authentication Github allows for up to 60 requests per hour. You can easily exceed this limit and start seeing errors if you're tracking lots of repositories or your cache time is low. To circumvent this you can [create a read only token from your Github account](https://github.com/settings/personal-access-tokens/new) and provide it here. You can also specify the value for this token through an ENV variable using the syntax `${GITHUB_TOKEN}` where `GITHUB_TOKEN` is the name of the variable that holds the token. If you've installed Glance through docker you can specify the token in your docker-compose: ```yaml services: glance: image: glanceapp/glance environment: - GITHUB_TOKEN=View docker-compose.yml
```yaml services: immich-server: image: ghcr.io/immich-app/immich-server labels: glance.name: Immich glance.icon: si:immich glance.url: https://immich.domain.com glance.description: Image & video management glance.id: immich redis: image: docker.io/redis:6.2-alpine labels: glance.parent: immich glance.name: Redis database: image: docker.io/tensorchord/pgvecto-rs:pg14-v0.2.0 labels: glance.parent: immich glance.name: DB proxy: image: nginx:stable labels: glance.parent: immich glance.name: Proxy ```
This will place all child containers under the `Immich` container when hovering over its icon:  If any of the child containers are down, their status will propagate up to the parent container:  #### Properties | Name | Type | Required | Default | | ---- | ---- | -------- | ------- | | hide-by-default | boolean | no | false | | format-container-names | boolean | no | false | | sock-path | string | no | /var/run/docker.sock | | category | string | no | | | running-only | boolean | no | false | ##### `hide-by-default` Whether to hide the containers by default. If set to `true` you'll have to manually add a `glance.hide: false` label to each container you want to display. By default all containers will be shown and if you want to hide a specific container you can add a `glance.hide: true` label. ##### `format-container-names` When set to `true`, automatically converts container names such as `container_name_1` into `Container Name 1`. ##### `sock-path` The path to the Docker socket. This can also be a [remote socket](https://docs.docker.com/engine/daemon/remote-access/) or proxied socket using something like [docker-socket-proxy](https://github.com/Tecnativa/docker-socket-proxy). ###### `category` Filter to only the containers which have this category specified via the `glance.category` label. Useful if you want to have multiple containers widgets, each showing a different set of containers.
View example
```yaml services: jellyfin: image: jellyfin/jellyfin:latest labels: glance.name: Jellyfin glance.icon: si:jellyfin glance.url: https://jellyfin.domain.com glance.category: media gitea: image: gitea/gitea:latest labels: glance.name: Gitea glance.icon: si:gitea glance.url: https://gitea.domain.com glance.category: dev-tools vaultwarden: image: vaultwarden/server:latest labels: glance.name: Vaultwarden glance.icon: si:vaultwarden glance.url: https://vaultwarden.domain.com glance.category: dev-tools ``` Then you can use the `category` property to filter the containers: ```yaml - type: docker-containers title: Dev tool containers category: dev-tools - type: docker-containers title: Media containers category: media ```
Hello, World!
``` Note the use of `|` after `source:`, this allows you to insert a multi-line string. ================================================ FILE: docs/custom-api.md ================================================ [Jump to function definitions](#functions) ## Examples The best way to get an idea of how the templates work would be with a bunch examples. Here are the most common use cases: JSON response: ```json { "title": "My Title", "content": "My Content", } ``` To access the two fields in the JSON response, you would use the following: ```html{{ .JSON.String "title" }}
{{ .JSON.String "content" }}
```
Output:
```html
My Title
My Content
```
JSON response: ```json { "author": "John Doe", "posts": [ { "title": "My Title", "content": "My Content" }, { "title": "My Title 2", "content": "My Content 2" } ] } ``` To loop through the array of posts, you would use the following: ```html {{ range .JSON.Array "posts" }}
{{ .String "title" }}
{{ .String "content" }}
{{ end }}
```
Output:
```html
My Title
My Content
My Title 2
My Content 2
```
Notice the missing `.JSON` when accessing the title and content, this is because the range function sets the context to the current array element.
If you want to access the top-level context within the range, you can use the following:
```html
{{ range .JSON.Array "posts" }}
{{ .String "title" }}
{{ .String "content" }}
{{ $.JSON.String "author" }}
{{ end }}
```
Output:
```html
My Title
My Content
John Doe
My Title 2
My Content 2
John Doe
```
JSON response: ```json [ "Apple", "Banana", "Cherry", "Watermelon" ] ``` Somewhat awkwardly, when the current context is a basic type that isn't an object, the way you specify its type is to use an empty string as the key. So, to loop through the array of strings, you would use the following: ```html {{ range .JSON.Array "" }}
{{ .String "" }}
{{ end }}
```
Output:
```html
Apple
Banana
Cherry
Watermelon
```
To access an item at a specific index, you could use the following:
```html
{{ .JSON.String "0" }}
```
Output:
```html
Apple
```
JSON response: ```json { "user": { "address": { "city": "New York", "state": "NY" } } } ``` To easily access deeply nested objects, you can use the following dot notation: ```html
{{ .JSON.String "user.address.city" }}
{{ .JSON.String "user.address.state" }}
```
Output:
```html
New York
NY
```
Using indexes anywhere in the path is also supported:
```json
{
"users": [
{
"name": "John Doe"
},
{
"name": "Jane Doe"
}
]
}
```
```html
{{ .JSON.String "users.0.name" }}
{{ .JSON.String "users.1.name" }}
```
Output:
```html
John Doe
Jane Doe
```
JSON response: ```json { "user": { "name": "John Doe", "age": 30 } } ``` To check if a field exists, you can use the following: ```html {{ if .JSON.Exists "user.age" }}
{{ .JSON.Int "user.age" }}
{{ else }}
Age not provided
{{ end }}
```
Output:
```html
30
```
JSON response: ```json { "price": 100, "discount": 10 } ``` Calculations can be performed on either ints or floats. If both numbers are ints, an int will be returned, otherwise a float will be returned. If you try to divide by zero, 0 will be returned. If you provide non-numeric values, `NaN` will be returned. ```html
{{ sub (.JSON.Int "price") (.JSON.Int "discount") }}
```
Output:
```html
90
```
Other operations include `add`, `mul`, `div` and `mod`.
JSON response: ```json { "posts": [ { "title": "Exploring the Depths of Quantum Computing", "date": "2023-10-27T10:00:00Z" }, { "title": "A Beginner's Guide to Sustainable Living", "date": "2023-11-15T14:30:00+01:00" }, { "title": "The Art of Baking Sourdough Bread", "date": "2023-12-03T08:45:22-08:00" } ] } ``` To parse the date and display the relative time (e.g. 2h, 1d, etc), you would use the following: ``` {{ range .JSON.Array "posts" }}
{{ .String "title" }}
{{ end }}
```
The `parseTime` function takes two arguments: the layout of the date string and the date string itself. The layout can be one of the following: "RFC3339", "RFC3339Nano", "DateTime", "DateOnly", "TimeOnly" or a custom layout in Go's [date format](https://pkg.go.dev/time#pkg-constants).
Output:
```html
Exploring the Depths of Quantum Computing
A Beginner's Guide to Sustainable Living
The Art of Baking Sourdough Bread
```
You don't have to worry about the internal implementation, this will then be dynamically populated by Glance on the client side to show the correct relative time.
The important thing to notice here is that the return value of `toRelativeTime` must be used as an attribute in an HTML tag, be it a `div`, `li`, `span`, etc.
In some instances, you may want to know the status code of the response. This can be done using the following: ```html {{ if eq .Response.StatusCode 200 }}
Success!
{{ else }}Failed to fetch data
{{ end }} ``` You can also access the response headers: ```html{{ .Response.Header.Get "Content-Type" }}
```
JSON response: ```json {"name": "Steve", "age": 30} {"name": "Alex", "age": 25} {"name": "John", "age": 35} ``` The above format is "[ndjson](https://docs.mulesoft.com/dataweave/latest/dataweave-formats-ndjson)" or "[JSON Lines](https://jsonlines.org/)", where each line is a separate JSON object. To parse this format, you must first disable the JSON validation check in your config, since by default the response is expected to be a single valid JSON object: ```yaml - type: custom-api skip-json-validation: true ``` Then, to iterate over each object you can use `.JSONLines`: ```html {{ range .JSONLines }}
{{ .String "name" }} is {{ .Int "age" }} years old
{{ end }} ``` Output: ```htmlSteve is 30 years old
Alex is 25 years old
John is 35 years old
``` For other ways of selecting data from a JSON Lines response, have a look at the docs for [tidwall/gjson](https://github.com/tidwall/gjson/tree/master?tab=readme-ov-file#json-lines). For example, to get an array of all names, you can use the following: ```html {{ range .JSON.Array "..#.name" }}{{ .String "" }}
{{ end }} ``` Output: ```htmlSteve
Alex
John
```In some instances, you may need to make two consecutive API calls, where you use the result of the first call in the second call. To achieve this, you can make additional HTTP requests from within the template itself using the following syntax: ```yaml - type: custom-api url: https://api.example.com/get-id-of-something template: | {{ $theID := .JSON.String "id" }} {{ $something := newRequest (concat "https://api.example.com/something/" $theID) | withParameter "key" "value" | withHeader "Authorization" "Bearer token" | getResponse }} {{ $something.JSON.String "title" }} ``` Here, `$theID` gets retrieved from the result of the first API call and used in the second API call. The `newRequest` function creates a new request, and the `getResponse` function executes it. You can also use `withParameter` and `withHeader` to optionally add parameters and headers to the request. If you need to make a request to a URL that requires dynamic parameters, you can omit the `url` property in the YAML and run the request entirely from within the template itself: ```yaml - type: custom-api title: Events from the last 24h template: | {{ $events := newRequest "https://api.example.com/events" | withParameter "after" (offsetNow "-24h" | formatTime "rfc3339") | getResponse }} {{ if eq $events.Response.StatusCode 200 }} {{ range $events.JSON.Array "events" }}
{{ .String "title" }}
{{ end }}
{{ else }}
Failed to fetch data: {{ $events.Response.Status }}
{{ end }} ``` *Note that you need to manually check for the correct status code.* ## Functions The following functions are available on the `JSON` object: - `String(key string) string`: Returns the value of the key as a string. - `Int(key string) int`: Returns the value of the key as an integer. - `Float(key string) float`: Returns the value of the key as a float. - `Bool(key string) bool`: Returns the value of the key as a boolean. - `Array(key string) []JSON`: Returns the value of the key as an array of `JSON` objects. - `Exists(key string) bool`: Returns true if the key exists in the JSON object. The following functions are available on the `Options` object: - `StringOr(key string, default string) string`: Returns the value of the key as a string, or the default value if the key does not exist. - `IntOr(key string, default int) int`: Returns the value of the key as an integer, or the default value if the key does not exist. - `FloatOr(key string, default float) float`: Returns the value of the key as a float, or the default value if the key does not exist. - `BoolOr(key string, default bool) bool`: Returns the value of the key as a boolean, or the default value if the key does not exist. - `JSON(key string) JSON`: Returns the value of the key as a stringified `JSON` object, or throws an error if the key does not exist. The following helper functions provided by Glance are available: - `toFloat(i int) float`: Converts an integer to a float. - `toInt(f float) int`: Converts a float to an integer. - `toRelativeTime(t time.Time) template.HTMLAttr`: Converts Time to a relative time such as 2h, 1d, etc which dynamically updates. **NOTE:** the value of this function should be used as an attribute in an HTML tag, e.g. ``. - `now() time.Time`: Returns the current time. - `offsetNow(offset string) time.Time`: Returns the current time with an offset. The offset can be positive or negative and must be in the format "3h" "-1h" or "2h30m10s". - `duration(str string) time.Duration`: Parses a string such as `1h`, `24h`, `5h30m`, etc into a `time.Duration`. - `parseTime(layout string, s string) time.Time`: Parses a string into time.Time. The layout must be provided in Go's [date format](https://pkg.go.dev/time#pkg-constants). You can alternatively use these values instead of the literal format: "unix", "RFC3339", "RFC3339Nano", "DateTime", "DateOnly". - `formatTime(layout string, s string) time.Time`: Formats a `time.Time` into a string. The layout uses the same format as `parseTime`. - `parseLocalTime(layout string, s string) time.Time`: Same as the above, except in the absence of a timezone, it will use the local timezone instead of UTC. - `parseRelativeTime(layout string, s string) time.Time`: A shorthand for `{{ .String "date" | parseTime "rfc3339" | toRelativeTime }}`. - `add(a, b float) float`: Adds two numbers. - `sub(a, b float) float`: Subtracts two numbers. - `mul(a, b float) float`: Multiplies two numbers. - `div(a, b float) float`: Divides two numbers. - `mod(a, b int) int`: Remainder after dividing a by b (a % b). - `formatApproxNumber(n int) string`: Formats a number to be more human-readable, e.g. 1000 -> 1k. - `formatNumber(n float|int) string`: Formats a number with commas, e.g. 1000 -> 1,000. - `trimPrefix(prefix string, str string) string`: Trims the prefix from a string. - `trimSuffix(suffix string, str string) string`: Trims the suffix from a string. - `trimSpace(str string) string`: Trims whitespace from a string on both ends. - `replaceAll(old string, new string, str string) string`: Replaces all occurrences of a string in a string. - `replaceMatches(pattern string, replacement string, str string) string`: Replaces all occurrences of a regular expression in a string. - `findMatch(pattern string, str string) string`: Finds the first match of a regular expression in a string. - `findSubmatch(pattern string, str string) string`: Finds the first submatch of a regular expression in a string. - `sortByString(key string, order string, arr []JSON): []JSON`: Sorts an array of JSON objects by a string key in either ascending or descending order. - `sortByInt(key string, order string, arr []JSON): []JSON`: Sorts an array of JSON objects by an integer key in either ascending or descending order. - `sortByFloat(key string, order string, arr []JSON): []JSON`: Sorts an array of JSON objects by a float key in either ascending or descending order. - `sortByTime(key string, layout string, order string, arr []JSON): []JSON`: Sorts an array of JSON objects by a time key in either ascending or descending order. The format must be provided in Go's [date format](https://pkg.go.dev/time#pkg-constants). - `concat(strings ...string) string`: Concatenates multiple strings together. - `unique(key string, arr []JSON) []JSON`: Returns a unique array of JSON objects based on the given key. - `percentChange(current float, previous float) float`: Calculates the percentage change between two numbers. - `startOfDay(t time.Time) time.Time`: Returns the start of the day for a given time. - `endOfDay(t time.Time) time.Time`: Returns the end of the day for a given time. The following helper functions provided by Go's `text/template` are available: - `eq(a, b any) bool`: Compares two values for equality. - `ne(a, b any) bool`: Compares two values for inequality. - `lt(a, b any) bool`: Compares two values for less than. - `le(a, b any) bool`: Compares two values for less than or equal to. - `gt(a, b any) bool`: Compares two values for greater than. - `ge(a, b any) bool`: Compares two values for greater than or equal to. - `and(args ...bool) bool`: Returns true if **all** arguments are true; accepts two or more boolean values. - `or(args ...bool) bool`: Returns true if **any** argument is true; accepts two or more boolean values. - `not(a bool) bool`: Returns the opposite of the value. - `index(a any, b int) any`: Returns the value at the specified index of an array. - `len(a any) int`: Returns the length of an array. - `printf(format string, a ...any) string`: Returns a formatted string. ================================================ FILE: docs/extensions.md ================================================ # Extensions > [!IMPORTANT] > > **This document as well as the extensions feature are a work in progress. The API may change in the future. You are responsible for maintaining your own extensions.** ## Overview With the intention of requiring minimal knowledge in order to develop extensions, rather than being a convoluted protocol they are nothing more than an HTTP request to a server that returns a few special headers. The exchange between Glance and extensions can be seen in the following diagram:  If you know how to setup an HTTP server and a bit of HTML and CSS you're ready to start building your own extensions. > [!TIP] > > By default, the extension widget has a cache time of 30 minutes. To avoid having to restart Glance after every extension change you can set the cache time of the widget to 1 second: > ```yaml > - type: extension > url: http://localhost:8081 > cache: 1s > ``` ## Headers ### `Widget-Title` Used to specify the title of the widget. If not provided, the widget's title will be "Extension". ### `Widget-Title-URL` Used to specify the URL that will be opened when the widget's title is clicked. If the user has specified a `title-url` in their config, it will take precedence over this header. ### `Widget-Content-Type` Used to specify the content type that will be returned by the extension. If not provided, the content will be shown as plain text. ### `Widget-Content-Frameless` When set to `true`, the widget's content will be displayed without the default background or "frame". ## Content Types > [!NOTE] > > Currently, `html` is the only supported content type. The long-term goal is to have generic content types such as `videos`, `forum-posts`, `markets`, `streams`, etc. which will be returned in JSON format and displayed by Glance using existing styles and functionality, allowing extension developers to achieve a native look while only focusing on providing data from their preferred source. ### `html` Displays the content as HTML. This requires the user to have the `allow-potentially-dangerous-html` property set to `true`, otherwise the content will be shown as plain text. #### Using existing classes and functionality Most of the features seen throughout Glance can easily be used in your custom HTML extensions. Below is an example of some of these features: ```htmlText with subdued color
Text with base color
Text with highlighted color
Text with primary color
Text with positive color
Text with negative color
Font size 1
Font size 2
Font size 3
Font size 4
Font size base
Font size 5
Font size 6
Link with visited indicator
Link with primary color if not visited
Event happened ago
- horizontal
- list
- with
- multiple
- text
- items
- list
- with
- gap
- and
- horizontal
- lines
- collapsible
- list
- with
- many
- items
- that
- will
- appear
- when
- you
- click
- the
- button
- below
Lazily loaded image:
List of posts:
-
Lorem ipsum dolor, sit amet consectetur adipisicing elit. Voluptatum, ipsa?
- 3,321 points
- 139 comments
-
Lorem ipsum dolor, sit amet consectetur adipisicing elit. Voluptatum, ipsa?
- 3,321 points
- 139 comments
-
Lorem ipsum dolor, sit amet consectetur adipisicing elit. Voluptatum, ipsa?
- 3,321 points
- 139 comments
View config (requires Glance v0.6.0 or higher)
```yaml
- name: Startpage
width: slim
hide-desktop-navigation: true
center-vertically: true
columns:
- size: full
widgets:
- type: search
autofocus: true
- type: monitor
cache: 1m
title: Services
sites:
- title: Jellyfin
url: https://yourdomain.com/
icon: si:jellyfin
- title: Gitea
url: https://yourdomain.com/
icon: si:gitea
- title: qBittorrent # only for Linux ISOs, of course
url: https://yourdomain.com/
icon: si:qbittorrent
- title: Immich
url: https://yourdomain.com/
icon: si:immich
- title: AdGuard Home
url: https://yourdomain.com/
icon: si:adguard
- title: Vaultwarden
url: https://yourdomain.com/
icon: si:vaultwarden
- type: bookmarks
groups:
- title: General
links:
- title: Gmail
url: https://mail.google.com/mail/u/0/
- title: Amazon
url: https://www.amazon.com/
- title: Github
url: https://github.com/
- title: Entertainment
links:
- title: YouTube
url: https://www.youtube.com/
- title: Prime Video
url: https://www.primevideo.com/
- title: Disney+
url: https://www.disneyplus.com/
- title: Social
links:
- title: Reddit
url: https://www.reddit.com/
- title: Twitter
url: https://twitter.com/
- title: Instagram
url: https://www.instagram.com/
```
View config (requires Glance v0.6.0 or higher)
```yaml
- name: Markets
columns:
- size: small
widgets:
- type: markets
title: Indices
markets:
- symbol: SPY
name: S&P 500
- symbol: DX-Y.NYB
name: Dollar Index
- type: markets
title: Crypto
markets:
- symbol: BTC-USD
name: Bitcoin
- symbol: ETH-USD
name: Ethereum
- type: markets
title: Stocks
sort-by: absolute-change
markets:
- symbol: NVDA
name: NVIDIA
- symbol: AAPL
name: Apple
- symbol: MSFT
name: Microsoft
- symbol: GOOGL
name: Google
- symbol: AMD
name: AMD
- symbol: RDDT
name: Reddit
- symbol: AMZN
name: Amazon
- symbol: TSLA
name: Tesla
- symbol: INTC
name: Intel
- symbol: META
name: Meta
- size: full
widgets:
- type: rss
title: News
style: horizontal-cards
feeds:
- url: https://feeds.bloomberg.com/markets/news.rss
title: Bloomberg
- url: https://moxie.foxbusiness.com/google-publisher/markets.xml
title: Fox Business
- url: https://moxie.foxbusiness.com/google-publisher/technology.xml
title: Fox Business
- type: group
widgets:
- type: reddit
show-thumbnails: true
subreddit: technology
- type: reddit
show-thumbnails: true
subreddit: wallstreetbets
- type: videos
style: grid-cards
collapse-after-rows: 3
channels:
- UCvSXMi2LebwJEM1s4bz5IBA # New Money
- UCV6KDgJskWaEckne5aPA0aQ # Graham Stephan
- UCAzhpt9DmG6PnHXjmJTvRGQ # Federal Reserve
- size: small
widgets:
- type: rss
title: News
limit: 30
collapse-after: 13
feeds:
- url: https://www.ft.com/technology?format=rss
title: Financial Times
- url: https://feeds.a.dj.com/rss/RSSMarketsMain.xml
title: Wall Street Journal
```
View config (requires Glance v0.6.0 or higher)
```yaml
- name: Gaming
columns:
- size: small
widgets:
- type: twitch-top-games
limit: 20
collapse-after: 13
exclude:
- just-chatting
- pools-hot-tubs-and-beaches
- music
- art
- asmr
- size: full
widgets:
- type: group
widgets:
- type: reddit
show-thumbnails: true
subreddit: pcgaming
- type: reddit
subreddit: games
- type: videos
style: grid-cards
collapse-after-rows: 3
channels:
- UCNvzD7Z-g64bPXxGzaQaa4g # gameranx
- UCZ7AeeVbyslLM_8-nVy2B8Q # Skill Up
- UCHDxYLv8iovIbhrfl16CNyg # GameLinked
- UC9PBzalIcEQCsiIkq36PyUA # Digital Foundry
- size: small
widgets:
- type: reddit
subreddit: gamingnews
limit: 7
style: vertical-cards
```
{{- range .Groups }}
{{ end }}
================================================
FILE: internal/glance/templates/calendar.html
================================================
{{ template "widget-base.html" . }}
{{ define "widget-content" }}
{{ end }}
================================================
FILE: internal/glance/templates/change-detection.html
================================================
{{ template "widget-base.html" . }}
{{ define "widget-content" }}
{{- if ne .Title "" }}
{{- end }}
{{ .Title }}
{{- end }}
-
{{- range .Links }}
-
{{- if ne "" .Icon.URL }}{{- if .Description }}{{- end }} {{ .Title }}{{ .Description }}{{- end }}
{{- end }}
-
{{ range .ChangeDetections }}
- {{ .Title }} {{ else }}
- No watches configured {{ end}}
-
{{ range .Timezones }}
-
{{ if ne .Label "" }}{{ .Label }}{{ else }}{{ .Timezone }}{{ end }}
{{ end }}
-
{{- range .Containers }}
-
{{- if .URL }} {{ .Name }} {{- else }}{{ .Name }}{{- end }} {{- if .Description }}{{ .Description }}{{- end }}{{ template "state-icon" .StateIcon }}
{{- else }}
No containers available to show.
{{- end }}
-
{{- range .Posts }}
-
{{- if $.ShowThumbnails }} {{- if .IsCrosspost }} {{- else if .ThumbnailUrl }}
{{- else if .TargetUrl }} {{- else }} {{- end }} {{- end }}
{{ .Title }} {{- if .Tags }} {{- end }}- {{ .Score | formatApproxNumber }} points
- {{ .CommentCount | formatApproxNumber }} comments {{- if .TargetUrl }}
- {{ .TargetUrlDomain }} {{- end }}
{{- end }}
Login
{{ range .Markets }}
{{ end }}
{{ end }}
================================================
FILE: internal/glance/templates/monitor-compact.html
================================================
{{ template "widget-base.html" . }}
{{ define "widget-content" }}
{{ if not (and .ShowFailingOnly (not .HasFailing)) }}
-
{{ range .Sites }}
{{ if and $.ShowFailingOnly (eq .StatusStyle "ok" ) }}{{ continue }}{{ end }}
{{ template "site" . }}
{{ end }}
All sites are online
{{ .Status.ResponseTime.Milliseconds | formatNumber }}ms
{{ end }}
{{ if eq .StatusStyle "ok" }}
{{ else }}
{{ end }}
{{ end }}
================================================
FILE: internal/glance/templates/monitor.html
================================================
{{ template "widget-base.html" . }}
{{ define "widget-content" }}
{{ if not (and .ShowFailingOnly (not .HasFailing)) }}
-
{{ range .Sites }}
{{ if and $.ShowFailingOnly (eq .StatusStyle "ok" ) }} {{ continue }} {{ end }}
{{ template "site" . }}
{{ end }}
All sites are online
{{ .Title }}
{{ if eq .StatusStyle "ok" }}
{{ else }}
{{ end }}
{{ end }}
================================================
FILE: internal/glance/templates/old-calendar.html
================================================
{{ template "widget-base.html" . }}
{{ define "widget-content" }}
{{ end }}
================================================
FILE: internal/glance/templates/page-content.html
================================================
{{ if .Page.ShowMobileHeader }}
-
{{ if not .Status.Error }}
- {{ .StatusText }}
- {{ .Status.ResponseTime.Milliseconds | formatNumber }}ms {{ else if .Status.TimedOut }}
- Timed Out {{ else }}
- ERROR {{ end }}
{{ .Page.Title }}
{{ end }}
{{ if .Page.HeadWidgets }}
{{ end }}
{{- range .Page.Columns }}
================================================
FILE: internal/glance/templates/page.html
================================================
{{ template "document.html" . }}
{{ define "document-title" }}{{ .Page.Title }}{{ end }}
{{ define "document-head-after" }}
{{ end }}
{{ define "navigation-links" }}
{{ range .App.Config.Pages }}
{{ .Title }}
{{ end }}
{{ end }}
{{ define "document-body" }}
{{- range .Widgets }}
{{- .Render }}
{{- end }}
{{- end }}
{{ if not .Page.HideDesktopNavigation }}
{{ end }}
{{ template "footer.html" . }}
{{ end }}
================================================
FILE: internal/glance/templates/reddit-horizontal-cards.html
================================================
{{ template "widget-base.html" . }}
{{ define "widget-content-classes" }}widget-content-frameless{{ end }}
{{ define "widget-content" }}
{{ .Page.Title }}
Loading
{{ range .Posts }}
{{ if ne "" .ThumbnailUrl }}
{{ end }}
{{ end }}
{{ range .Posts }}
{{ end }}
================================================
FILE: internal/glance/templates/releases.html
================================================
{{ template "widget-base.html" . }}
{{ define "widget-content" }}
{{ if ne "" .ThumbnailUrl }}
{{ end }}
{{ end }}
-
{{ range .Releases }}
-
{{ .Name }} {{ if $.ShowSourceIcon }}
{{ end }}
- {{ .Version }} {{ if gt .Downvotes 3 }}
- {{ .Downvotes | formatNumber }} ⚠ {{ end }}
{{ end }}
- {{ .Repository.Stars | formatNumber }} stars
- {{ .Repository.Forks | formatNumber }} forks
Last {{ .CommitsLimit }} commits
-
{{ range .Repository.Commits }}
{{ end }}
-
{{ range .Repository.Commits }}
- {{ .Message }} {{ end }}
Open pull requests ({{ .Repository.OpenPullRequests | formatNumber }} total)
-
{{ range .Repository.PullRequests }}
{{ end }}
-
{{ range .Repository.PullRequests }}
- {{ .Title }} {{ end }}
Open issues ({{ .Repository.OpenIssues | formatNumber }} total)
-
{{ range .Repository.Issues }}
{{ end }}
-
{{ range .Repository.Issues }}
- {{ .Title }} {{ end }}
-
{{ range .Items }}
-
{{ if ne "" .ImageURL }}
{{ else }} {{ end }}
{{ .Title }} {{ if ne "" .Description }}{{ .Description }}
{{ end }} {{ if gt (len .Categories) 0 }} {{ end }}
{{ else }}
- {{ .NoItemsMessage }} {{ end }}
{{ range .Items }}
{{ if ne "" .ImageURL }}
{{ else }}
{{ end }}
{{ end }}
{{ range .Items }}
{{ if ne "" .ImageURL }}
{{ else }}
{{ end }}
{{ end }}
-
{{ range .Items }}
- {{ .Title }} {{ else }}
- {{ .NoItemsMessage }} {{ end }}
{{ if .Name }}{{ .Name }}{{ else }}{{ .Info.Hostname }}{{ end }}
{{- if .IsReachable }}
{{ if .Info.HostInfoIsAvailable }}{{ else }}unknown{{ end }} uptime
{{- else }}
unreachable
{{- end }}
{{- if .IsReachable }}
{{- end }}
PLATFORM
{{ if .Info.HostInfoIsAvailable }}{{ .Info.Platform }}{{ else }}Unknown{{ end }}
CPU
{{- if and .Info.CPU.TemperatureIsAvailable (ge .Info.CPU.TemperatureC 80) }}
{{- end }}
{{ if .Info.CPU.LoadIsAvailable }}{{ .Info.CPU.Load1Percent }} %{{ else }}n/a{{ end }}
1M AVG
{{ .Info.CPU.Load1Percent }} %
15M AVG
{{ .Info.CPU.Load15Percent }} %
TEMP C
{{ .Info.CPU.TemperatureC }} °
RAM
{{ if .Info.Memory.IsAvailable }}{{ .Info.Memory.UsedPercent }} %{{ else }}n/a{{ end }}
RAM
{{ .Info.Memory.UsedMB | formatServerMegabytes }} / {{ .Info.Memory.TotalMB | formatServerMegabytes }}
SWAP
{{ .Info.Memory.SwapUsedMB | formatServerMegabytes }} / {{ .Info.Memory.SwapTotalMB | formatServerMegabytes }}
DISK
{{ if .Info.Mountpoints }}{{ (index .Info.Mountpoints 0).UsedPercent }} %{{ else }}n/a{{ end }}
-
{{- range .Info.Mountpoints }}
-
{{ if .Name }}{{ .Name }}{{ else }}{{ .Path }}{{ end }}{{ .UsedMB | formatServerMegabytes }} / {{ .TotalMB | formatServerMegabytes }}
{{- end }}
{{ range .Widgets }}
{{ .Render }}
{{ end }}
{{ end }}
================================================
FILE: internal/glance/templates/theme-preset-preview.html
================================================
{{- $background := "hsl(240, 8%, 9%)" | safeCSS }}
{{- $primary := "hsl(43, 50%, 70%)" | safeCSS }}
{{- $positive := "hsl(43, 50%, 70%)" | safeCSS }}
{{- $negative := "hsl(0, 70%, 70%)" | safeCSS }}
{{- if .BackgroundColor }}{{ $background = .BackgroundColor.String | safeCSS }}{{ end }}
{{- if .PrimaryColor }}
{{- $primary = .PrimaryColor.String | safeCSS }}
{{- if not .PositiveColor }}
{{- $positive = $primary }}
{{- else }}
{{- $positive = .PositiveColor.String | safeCSS }}
{{- end }}
{{- end }}
{{- if .NegativeColor }}{{ $negative = .NegativeColor.String | safeCSS }}{{ end }}
================================================
FILE: internal/glance/templates/theme-style.gotmpl
================================================
:root {
{{ if .BackgroundColor }}
--bgh: {{ .BackgroundColor.H }};
--bgs: {{ .BackgroundColor.S }}%;
--bgl: {{ .BackgroundColor.L }}%;
{{ end }}
{{ if ne 0.0 .ContrastMultiplier }}--cm: {{ .ContrastMultiplier }};{{ end }}
{{ if ne 0.0 .TextSaturationMultiplier }}--tsm: {{ .TextSaturationMultiplier }};{{ end }}
{{ if .PrimaryColor }}--color-primary: {{ .PrimaryColor.String | safeCSS }};{{ end }}
{{ if .PositiveColor }}--color-positive: {{ .PositiveColor.String | safeCSS }};{{ end }}
{{ if .NegativeColor }}--color-negative: {{ .NegativeColor.String | safeCSS }};{{ end }}
}
================================================
FILE: internal/glance/templates/todo.html
================================================
{{ template "widget-base.html" . }}
{{ define "widget-content" }}
{{ end }}
================================================
FILE: internal/glance/templates/twitch-channels.html
================================================
{{ template "widget-base.html" . }}
{{ define "widget-content" }}
-
{{ range .Channels }}
-
{{ if .IsLive }}{{ end }} {{ if .Exists }}
{{ .StreamTitle }}
{{ else }} {{ end }}
{{ .Name }} {{ if .Exists }} {{ if .IsLive }} {{ if .Category }} {{ .Category }} {{ end }}- {{ .ViewersCount | formatApproxNumber }} viewers
Offline{{ end }} {{ else }}Not found{{ end }}
{{ end }}
-
{{ range .Categories }}
-
{{ .Name }}
- {{ .ViewersCount | formatApproxNumber }} viewers {{ if .IsNew }}
- NEW {{ end }}
-
{{ range $i, $tag := .Tags }}
{{ if eq $i 0 }}
- {{ $tag.Name }} {{ else }}
- {{ $tag.Name }} {{ end }} {{ end }}
{{ end }}
{{ range .Videos }}
{{ end }}
{{ end }}
================================================
FILE: internal/glance/templates/videos-vertical-list.html
================================================
{{ template "widget-base.html" . }}
{{- define "widget-content" }}
-
{{- range .Videos }}
-
{{ range .Videos }}
{{ end }}
" + html.EscapeString(string(content)) + "") } } func fetchExtension(options extensionRequestOptions) (extension, error) { request, _ := http.NewRequest("GET", options.URL, nil) if len(options.Parameters) > 0 { request.URL.RawQuery = options.Parameters.toQueryString() } for key, value := range options.Headers { request.Header.Add(key, value) } response, err := http.DefaultClient.Do(request) if err != nil { slog.Error("Failed fetching extension", "url", options.URL, "error", err) return extension{}, fmt.Errorf("%w: request failed: %w", errNoContent, err) } defer response.Body.Close() body, err := io.ReadAll(response.Body) if err != nil { slog.Error("Failed reading response body of extension", "url", options.URL, "error", err) return extension{}, fmt.Errorf("%w: could not read body: %w", errNoContent, err) } extension := extension{} if response.Header.Get(extensionHeaderTitle) == "" { extension.Title = "Extension" } else { extension.Title = response.Header.Get(extensionHeaderTitle) } if response.Header.Get(extensionHeaderTitleURL) != "" { extension.TitleURL = response.Header.Get(extensionHeaderTitleURL) } contentType, ok := extensionStringToType[response.Header.Get(extensionHeaderContentType)] if !ok { contentType, ok = extensionStringToType[options.FallbackContentType] if !ok { contentType = extensionContentUnknown } } if stringToBool(response.Header.Get(extensionHeaderContentFrameless)) { extension.Frameless = true } extension.Content = convertExtensionContent(options, body, contentType) return extension, nil } ================================================ FILE: internal/glance/widget-group.go ================================================ package glance import ( "context" "errors" "html/template" "time" ) var groupWidgetTemplate = mustParseTemplate("group.html", "widget-base.html") type groupWidget struct { widgetBase `yaml:",inline"` containerWidgetBase `yaml:",inline"` } func (widget *groupWidget) initialize() error { widget.withError(nil) widget.HideHeader = true for i := range widget.Widgets { widget.Widgets[i].setHideHeader(true) if widget.Widgets[i].GetType() == "group" { return errors.New("nested groups are not supported") } else if widget.Widgets[i].GetType() == "split-column" { return errors.New("split columns inside of groups are not supported") } } if err := widget.containerWidgetBase._initializeWidgets(); err != nil { return err } return nil } func (widget *groupWidget) update(ctx context.Context) { widget.containerWidgetBase._update(ctx) } func (widget *groupWidget) setProviders(providers *widgetProviders) { widget.containerWidgetBase._setProviders(providers) } func (widget *groupWidget) requiresUpdate(now *time.Time) bool { return widget.containerWidgetBase._requiresUpdate(now) } func (widget *groupWidget) Render() template.HTML { return widget.renderTemplate(widget, groupWidgetTemplate) } ================================================ FILE: internal/glance/widget-hacker-news.go ================================================ package glance import ( "context" "fmt" "html/template" "log/slog" "net/http" "strconv" "strings" "time" ) type hackerNewsWidget struct { widgetBase `yaml:",inline"` Posts forumPostList `yaml:"-"` Limit int `yaml:"limit"` SortBy string `yaml:"sort-by"` ExtraSortBy string `yaml:"extra-sort-by"` CollapseAfter int `yaml:"collapse-after"` CommentsUrlTemplate string `yaml:"comments-url-template"` ShowThumbnails bool `yaml:"-"` } func (widget *hackerNewsWidget) initialize() error { widget. withTitle("Hacker News"). withTitleURL("https://news.ycombinator.com/"). withCacheDuration(30 * time.Minute) if widget.Limit <= 0 { widget.Limit = 15 } if widget.CollapseAfter == 0 || widget.CollapseAfter < -1 { widget.CollapseAfter = 5 } if widget.SortBy != "top" && widget.SortBy != "new" && widget.SortBy != "best" { widget.SortBy = "top" } return nil } func (widget *hackerNewsWidget) update(ctx context.Context) { posts, err := fetchHackerNewsPosts(widget.SortBy, 40, widget.CommentsUrlTemplate) if !widget.canContinueUpdateAfterHandlingErr(err) { return } if widget.ExtraSortBy == "engagement" { posts.calculateEngagement() posts.sortByEngagement() } if widget.Limit < len(posts) { posts = posts[:widget.Limit] } widget.Posts = posts } func (widget *hackerNewsWidget) Render() template.HTML { return widget.renderTemplate(widget, forumPostsTemplate) } type hackerNewsPostResponseJson struct { Id int `json:"id"` Score int `json:"score"` Title string `json:"title"` TargetUrl string `json:"url,omitempty"` CommentCount int `json:"descendants"` TimePosted int64 `json:"time"` } func fetchHackerNewsPostIds(sort string) ([]int, error) { request, _ := http.NewRequest("GET", fmt.Sprintf("https://hacker-news.firebaseio.com/v0/%sstories.json", sort), nil) response, err := decodeJsonFromRequest[[]int](defaultHTTPClient, request) if err != nil { return nil, fmt.Errorf("%w: could not fetch list of post IDs", errNoContent) } return response, nil } func fetchHackerNewsPostsFromIds(postIds []int, commentsUrlTemplate string) (forumPostList, error) { requests := make([]*http.Request, len(postIds)) for i, id := range postIds { request, _ := http.NewRequest("GET", fmt.Sprintf("https://hacker-news.firebaseio.com/v0/item/%d.json", id), nil) requests[i] = request } task := decodeJsonFromRequestTask[hackerNewsPostResponseJson](defaultHTTPClient) job := newJob(task, requests).withWorkers(30) results, errs, err := workerPoolDo(job) if err != nil { return nil, err } posts := make(forumPostList, 0, len(postIds)) for i := range results { if errs[i] != nil { slog.Error("Failed to fetch or parse hacker news post", "error", errs[i], "url", requests[i].URL) continue } var commentsUrl string if commentsUrlTemplate == "" { commentsUrl = "https://news.ycombinator.com/item?id=" + strconv.Itoa(results[i].Id) } else { commentsUrl = strings.ReplaceAll(commentsUrlTemplate, "{POST-ID}", strconv.Itoa(results[i].Id)) } posts = append(posts, forumPost{ Title: results[i].Title, DiscussionUrl: commentsUrl, TargetUrl: results[i].TargetUrl, TargetUrlDomain: extractDomainFromUrl(results[i].TargetUrl), CommentCount: results[i].CommentCount, Score: results[i].Score, TimePosted: time.Unix(results[i].TimePosted, 0), }) } if len(posts) == 0 { return nil, errNoContent } if len(posts) != len(postIds) { return posts, fmt.Errorf("%w could not fetch some hacker news posts", errPartialContent) } return posts, nil } func fetchHackerNewsPosts(sort string, limit int, commentsUrlTemplate string) (forumPostList, error) { postIds, err := fetchHackerNewsPostIds(sort) if err != nil { return nil, err } if len(postIds) > limit { postIds = postIds[:limit] } return fetchHackerNewsPostsFromIds(postIds, commentsUrlTemplate) } ================================================ FILE: internal/glance/widget-html.go ================================================ package glance import ( "html/template" ) type htmlWidget struct { widgetBase `yaml:",inline"` Source template.HTML `yaml:"source"` } func (widget *htmlWidget) initialize() error { widget.withTitle("").withError(nil) return nil } func (widget *htmlWidget) Render() template.HTML { return widget.Source } ================================================ FILE: internal/glance/widget-iframe.go ================================================ package glance import ( "errors" "fmt" "html/template" "net/url" ) var iframeWidgetTemplate = mustParseTemplate("iframe.html", "widget-base.html") type iframeWidget struct { widgetBase `yaml:",inline"` cachedHTML template.HTML `yaml:"-"` Source string `yaml:"source"` Height int `yaml:"height"` } func (widget *iframeWidget) initialize() error { widget.withTitle("IFrame").withError(nil) if widget.Source == "" { return errors.New("source is required") } if _, err := url.Parse(widget.Source); err != nil { return fmt.Errorf("parsing URL: %v", err) } if widget.Height == 50 { widget.Height = 300 } else if widget.Height < 50 { widget.Height = 50 } widget.cachedHTML = widget.renderTemplate(widget, iframeWidgetTemplate) return nil } func (widget *iframeWidget) Render() template.HTML { return widget.cachedHTML } ================================================ FILE: internal/glance/widget-lobsters.go ================================================ package glance import ( "context" "html/template" "net/http" "strings" "time" ) type lobstersWidget struct { widgetBase `yaml:",inline"` Posts forumPostList `yaml:"-"` InstanceURL string `yaml:"instance-url"` CustomURL string `yaml:"custom-url"` Limit int `yaml:"limit"` CollapseAfter int `yaml:"collapse-after"` SortBy string `yaml:"sort-by"` Tags []string `yaml:"tags"` ShowThumbnails bool `yaml:"-"` } func (widget *lobstersWidget) initialize() error { widget.withTitle("Lobsters").withCacheDuration(time.Hour) if widget.InstanceURL == "" { widget.withTitleURL("https://lobste.rs") } else { widget.withTitleURL(widget.InstanceURL) } if widget.SortBy == "" || (widget.SortBy != "hot" && widget.SortBy != "new") { widget.SortBy = "hot" } if widget.Limit <= 0 { widget.Limit = 15 } if widget.CollapseAfter == 0 || widget.CollapseAfter < -1 { widget.CollapseAfter = 5 } return nil } func (widget *lobstersWidget) update(ctx context.Context) { posts, err := fetchLobstersPosts(widget.CustomURL, widget.InstanceURL, widget.SortBy, widget.Tags) if !widget.canContinueUpdateAfterHandlingErr(err) { return } if widget.Limit < len(posts) { posts = posts[:widget.Limit] } widget.Posts = posts } func (widget *lobstersWidget) Render() template.HTML { return widget.renderTemplate(widget, forumPostsTemplate) } type lobstersPostResponseJson struct { CreatedAt string `json:"created_at"` Title string `json:"title"` URL string `json:"url"` Score int `json:"score"` CommentCount int `json:"comment_count"` CommentsURL string `json:"comments_url"` Tags []string `json:"tags"` } type lobstersFeedResponseJson []lobstersPostResponseJson func fetchLobstersPostsFromFeed(feedUrl string) (forumPostList, error) { request, err := http.NewRequest("GET", feedUrl, nil) if err != nil { return nil, err } feed, err := decodeJsonFromRequest[lobstersFeedResponseJson](defaultHTTPClient, request) if err != nil { return nil, err } posts := make(forumPostList, 0, len(feed)) for i := range feed { createdAt, _ := time.Parse(time.RFC3339, feed[i].CreatedAt) posts = append(posts, forumPost{ Title: feed[i].Title, DiscussionUrl: feed[i].CommentsURL, TargetUrl: feed[i].URL, TargetUrlDomain: extractDomainFromUrl(feed[i].URL), CommentCount: feed[i].CommentCount, Score: feed[i].Score, TimePosted: createdAt, Tags: feed[i].Tags, }) } if len(posts) == 0 { return nil, errNoContent } return posts, nil } func fetchLobstersPosts(customURL string, instanceURL string, sortBy string, tags []string) (forumPostList, error) { var feedUrl string if customURL != "" { feedUrl = customURL } else { if instanceURL != "" { instanceURL = strings.TrimRight(instanceURL, "/") + "/" } else { instanceURL = "https://lobste.rs/" } if sortBy == "hot" { sortBy = "hottest" } else if sortBy == "new" { sortBy = "newest" } if len(tags) == 0 { feedUrl = instanceURL + sortBy + ".json" } else { tags := strings.Join(tags, ",") feedUrl = instanceURL + "t/" + tags + ".json" } } posts, err := fetchLobstersPostsFromFeed(feedUrl) if err != nil { return nil, err } return posts, nil } ================================================ FILE: internal/glance/widget-markets.go ================================================ package glance import ( "context" "fmt" "html/template" "log/slog" "math" "net/http" "sort" "strings" "time" ) var marketsWidgetTemplate = mustParseTemplate("markets.html", "widget-base.html") type marketsWidget struct { widgetBase `yaml:",inline"` StocksRequests []marketRequest `yaml:"stocks"` MarketRequests []marketRequest `yaml:"markets"` ChartLinkTemplate string `yaml:"chart-link-template"` SymbolLinkTemplate string `yaml:"symbol-link-template"` Sort string `yaml:"sort-by"` Markets marketList `yaml:"-"` } func (widget *marketsWidget) initialize() error { widget.withTitle("Markets").withCacheDuration(time.Hour) // legacy support, remove in v0.10.0 if len(widget.MarketRequests) == 0 { widget.MarketRequests = widget.StocksRequests } for i := range widget.MarketRequests { m := &widget.MarketRequests[i] if widget.ChartLinkTemplate != "" && m.ChartLink == "" { m.ChartLink = strings.ReplaceAll(widget.ChartLinkTemplate, "{SYMBOL}", m.Symbol) } if widget.SymbolLinkTemplate != "" && m.SymbolLink == "" { m.SymbolLink = strings.ReplaceAll(widget.SymbolLinkTemplate, "{SYMBOL}", m.Symbol) } } return nil } func (widget *marketsWidget) update(ctx context.Context) { markets, err := fetchMarketsDataFromYahoo(widget.MarketRequests) if !widget.canContinueUpdateAfterHandlingErr(err) { return } if widget.Sort == "absolute-change" { markets.sortByAbsChange() } else if widget.Sort == "change" { markets.sortByChange() } widget.Markets = markets } func (widget *marketsWidget) Render() template.HTML { return widget.renderTemplate(widget, marketsWidgetTemplate) } type marketRequest struct { CustomName string `yaml:"name"` Symbol string `yaml:"symbol"` ChartLink string `yaml:"chart-link"` SymbolLink string `yaml:"symbol-link"` } type market struct { marketRequest Name string Currency string Price float64 PriceHint int PercentChange float64 SvgChartPoints string } type marketList []market func (t marketList) sortByAbsChange() { sort.Slice(t, func(i, j int) bool { return math.Abs(t[i].PercentChange) > math.Abs(t[j].PercentChange) }) } func (t marketList) sortByChange() { sort.Slice(t, func(i, j int) bool { return t[i].PercentChange > t[j].PercentChange }) } type marketResponseJson struct { Chart struct { Result []struct { Meta struct { Currency string `json:"currency"` Symbol string `json:"symbol"` RegularMarketPrice float64 `json:"regularMarketPrice"` ChartPreviousClose float64 `json:"chartPreviousClose"` ShortName string `json:"shortName"` PriceHint int `json:"priceHint"` } `json:"meta"` Indicators struct { Quote []struct { Close []float64 `json:"close,omitempty"` } `json:"quote"` } `json:"indicators"` } `json:"result"` } `json:"chart"` } // TODO: allow changing chart time frame const marketChartDays = 21 func fetchMarketsDataFromYahoo(marketRequests []marketRequest) (marketList, error) { requests := make([]*http.Request, 0, len(marketRequests)) for i := range marketRequests { request, _ := http.NewRequest("GET", fmt.Sprintf("https://query1.finance.yahoo.com/v8/finance/chart/%s?range=1mo&interval=1d", marketRequests[i].Symbol), nil) setBrowserUserAgentHeader(request) requests = append(requests, request) } job := newJob(decodeJsonFromRequestTask[marketResponseJson](defaultHTTPClient), requests) responses, errs, err := workerPoolDo(job) if err != nil { return nil, fmt.Errorf("%w: %v", errNoContent, err) } markets := make(marketList, 0, len(responses)) var failed int for i := range responses { if errs[i] != nil { failed++ slog.Error("Failed to fetch market data", "symbol", marketRequests[i].Symbol, "error", errs[i]) continue } response := responses[i] if len(response.Chart.Result) == 0 { failed++ slog.Error("Market response contains no data", "symbol", marketRequests[i].Symbol) continue } result := &response.Chart.Result[0] prices := result.Indicators.Quote[0].Close if len(prices) > marketChartDays { prices = prices[len(prices)-marketChartDays:] } previous := result.Meta.RegularMarketPrice if len(prices) >= 2 && prices[len(prices)-2] != 0 { previous = prices[len(prices)-2] } points := svgPolylineCoordsFromYValues(100, 50, maybeCopySliceWithoutZeroValues(prices)) currency, exists := currencyToSymbol[strings.ToUpper(result.Meta.Currency)] if !exists { currency = result.Meta.Currency } markets = append(markets, market{ marketRequest: marketRequests[i], Price: result.Meta.RegularMarketPrice, Currency: currency, PriceHint: result.Meta.PriceHint, Name: ternary(marketRequests[i].CustomName == "", result.Meta.ShortName, marketRequests[i].CustomName, ), PercentChange: percentChange( result.Meta.RegularMarketPrice, previous, ), SvgChartPoints: points, }) } if len(markets) == 0 { return nil, errNoContent } if failed > 0 { return markets, fmt.Errorf("%w: could not fetch data for %d market(s)", errPartialContent, failed) } return markets, nil } var currencyToSymbol = map[string]string{ "USD": "$", "EUR": "€", "JPY": "¥", "CAD": "C$", "AUD": "A$", "GBP": "£", "CHF": "Fr", "NZD": "N$", "INR": "₹", "BRL": "R$", "RUB": "₽", "TRY": "₺", "ZAR": "R", "CNY": "¥", "KRW": "₩", "HKD": "HK$", "SGD": "S$", "SEK": "kr", "NOK": "kr", "DKK": "kr", "PLN": "zł", "PHP": "₱", } ================================================ FILE: internal/glance/widget-monitor.go ================================================ package glance import ( "context" "errors" "html/template" "net/http" "slices" "strconv" "time" ) var ( monitorWidgetTemplate = mustParseTemplate("monitor.html", "widget-base.html") monitorWidgetCompactTemplate = mustParseTemplate("monitor-compact.html", "widget-base.html") ) type monitorWidget struct { widgetBase `yaml:",inline"` Sites []struct { *SiteStatusRequest `yaml:",inline"` Status *siteStatus `yaml:"-"` URL string `yaml:"-"` ErrorURL string `yaml:"error-url"` Title string `yaml:"title"` Icon customIconField `yaml:"icon"` SameTab bool `yaml:"same-tab"` StatusText string `yaml:"-"` StatusStyle string `yaml:"-"` AltStatusCodes []int `yaml:"alt-status-codes"` } `yaml:"sites"` Style string `yaml:"style"` ShowFailingOnly bool `yaml:"show-failing-only"` HasFailing bool `yaml:"-"` } func (widget *monitorWidget) initialize() error { widget.withTitle("Monitor").withCacheDuration(5 * time.Minute) return nil } func (widget *monitorWidget) update(ctx context.Context) { requests := make([]*SiteStatusRequest, len(widget.Sites)) for i := range widget.Sites { requests[i] = widget.Sites[i].SiteStatusRequest } statuses, err := fetchStatusForSites(requests) if !widget.canContinueUpdateAfterHandlingErr(err) { return } widget.HasFailing = false for i := range widget.Sites { site := &widget.Sites[i] status := &statuses[i] site.Status = status if !slices.Contains(site.AltStatusCodes, status.Code) && (status.Code >= 400 || status.Error != nil) { widget.HasFailing = true } if status.Error != nil && site.ErrorURL != "" { site.URL = site.ErrorURL } else { site.URL = site.DefaultURL } site.StatusText = statusCodeToText(status.Code, site.AltStatusCodes) site.StatusStyle = statusCodeToStyle(status.Code, site.AltStatusCodes) } } func (widget *monitorWidget) Render() template.HTML { if widget.Style == "compact" { return widget.renderTemplate(widget, monitorWidgetCompactTemplate) } return widget.renderTemplate(widget, monitorWidgetTemplate) } func statusCodeToText(status int, altStatusCodes []int) string { if status == 200 || slices.Contains(altStatusCodes, status) { return "OK" } if status == 404 { return "Not Found" } if status == 403 { return "Forbidden" } if status == 401 { return "Unauthorized" } if status >= 500 { return "Server Error" } if status >= 400 { return "Client Error" } return strconv.Itoa(status) } func statusCodeToStyle(status int, altStatusCodes []int) string { if status == 200 || slices.Contains(altStatusCodes, status) { return "ok" } return "error" } type SiteStatusRequest struct { DefaultURL string `yaml:"url"` CheckURL string `yaml:"check-url"` AllowInsecure bool `yaml:"allow-insecure"` Timeout durationField `yaml:"timeout"` BasicAuth struct { Username string `yaml:"username"` Password string `yaml:"password"` } `yaml:"basic-auth"` } type siteStatus struct { Code int TimedOut bool ResponseTime time.Duration Error error } func fetchSiteStatusTask(statusRequest *SiteStatusRequest) (siteStatus, error) { var url string if statusRequest.CheckURL != "" { url = statusRequest.CheckURL } else { url = statusRequest.DefaultURL } timeout := ternary(statusRequest.Timeout > 0, time.Duration(statusRequest.Timeout), 3*time.Second) ctx, cancel := context.WithTimeout(context.Background(), timeout) defer cancel() request, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil) if err != nil { return siteStatus{ Error: err, }, nil } if statusRequest.BasicAuth.Username != "" || statusRequest.BasicAuth.Password != "" { request.SetBasicAuth(statusRequest.BasicAuth.Username, statusRequest.BasicAuth.Password) } requestSentAt := time.Now() var response *http.Response if !statusRequest.AllowInsecure { response, err = defaultHTTPClient.Do(request) } else { response, err = defaultInsecureHTTPClient.Do(request) } status := siteStatus{ResponseTime: time.Since(requestSentAt)} if err != nil { if errors.Is(err, context.DeadlineExceeded) { status.TimedOut = true } status.Error = err return status, nil } defer response.Body.Close() status.Code = response.StatusCode return status, nil } func fetchStatusForSites(requests []*SiteStatusRequest) ([]siteStatus, error) { job := newJob(fetchSiteStatusTask, requests).withWorkers(20) results, _, err := workerPoolDo(job) if err != nil { return nil, err } return results, nil } ================================================ FILE: internal/glance/widget-old-calendar.go ================================================ package glance import ( "context" "html/template" "time" ) var oldCalendarWidgetTemplate = mustParseTemplate("old-calendar.html", "widget-base.html") type oldCalendarWidget struct { widgetBase `yaml:",inline"` Calendar *calendar StartSunday bool `yaml:"start-sunday"` } func (widget *oldCalendarWidget) initialize() error { widget.withTitle("Calendar").withCacheOnTheHour() return nil } func (widget *oldCalendarWidget) update(ctx context.Context) { widget.Calendar = newCalendar(time.Now(), widget.StartSunday) widget.withError(nil).scheduleNextUpdate() } func (widget *oldCalendarWidget) Render() template.HTML { return widget.renderTemplate(widget, oldCalendarWidgetTemplate) } type calendar struct { CurrentDay int CurrentWeekNumber int CurrentMonthName string CurrentYear int Days []int } // TODO: very inflexible, refactor to allow more customizability // TODO: allow changing between showing the previous and next week and the entire month func newCalendar(now time.Time, startSunday bool) *calendar { year, week := now.ISOWeek() weekday := now.Weekday() if !startSunday { weekday = (weekday + 6) % 7 // Shift Monday to 0 } currentMonthDays := daysInMonth(now.Month(), year) var previousMonthDays int if previousMonthNumber := now.Month() - 1; previousMonthNumber < 1 { previousMonthDays = daysInMonth(12, year-1) } else { previousMonthDays = daysInMonth(previousMonthNumber, year) } startDaysFrom := now.Day() - int(weekday) - 7 days := make([]int, 21) for i := 0; i < 21; i++ { day := startDaysFrom + i if day < 1 { day = previousMonthDays + day } else if day > currentMonthDays { day = day - currentMonthDays } days[i] = day } return &calendar{ CurrentDay: now.Day(), CurrentWeekNumber: week, CurrentMonthName: now.Month().String(), CurrentYear: year, Days: days, } } func daysInMonth(m time.Month, year int) int { return time.Date(year, m+1, 0, 0, 0, 0, 0, time.UTC).Day() } ================================================ FILE: internal/glance/widget-reddit.go ================================================ package glance import ( "context" "errors" "fmt" "html" "html/template" "net/http" "net/url" "strconv" "strings" "time" ) var ( redditWidgetHorizontalCardsTemplate = mustParseTemplate("reddit-horizontal-cards.html", "widget-base.html") redditWidgetVerticalCardsTemplate = mustParseTemplate("reddit-vertical-cards.html", "widget-base.html") ) type redditWidget struct { widgetBase `yaml:",inline"` Posts forumPostList `yaml:"-"` Subreddit string `yaml:"subreddit"` Proxy proxyOptionsField `yaml:"proxy"` Style string `yaml:"style"` ShowThumbnails bool `yaml:"show-thumbnails"` ShowFlairs bool `yaml:"show-flairs"` SortBy string `yaml:"sort-by"` TopPeriod string `yaml:"top-period"` Search string `yaml:"search"` ExtraSortBy string `yaml:"extra-sort-by"` CommentsURLTemplate string `yaml:"comments-url-template"` Limit int `yaml:"limit"` CollapseAfter int `yaml:"collapse-after"` RequestURLTemplate string `yaml:"request-url-template"` AppAuth struct { Name string `yaml:"name"` ID string `yaml:"id"` Secret string `yaml:"secret"` enabled bool accessToken string tokenExpiresAt time.Time } `yaml:"app-auth"` } func (widget *redditWidget) initialize() error { if widget.Subreddit == "" { return errors.New("subreddit is required") } if widget.Limit <= 0 { widget.Limit = 15 } if widget.CollapseAfter == 0 || widget.CollapseAfter < -1 { widget.CollapseAfter = 5 } s := widget.SortBy if s != "hot" && s != "new" && s != "top" && s != "rising" { widget.SortBy = "hot" } p := widget.TopPeriod if p != "hour" && p != "day" && p != "week" && p != "month" && p != "year" && p != "all" { widget.TopPeriod = "day" } if widget.RequestURLTemplate != "" { if !strings.Contains(widget.RequestURLTemplate, "{REQUEST-URL}") { return errors.New("no `{REQUEST-URL}` placeholder specified") } } a := &widget.AppAuth if a.Name != "" || a.ID != "" || a.Secret != "" { if a.Name == "" || a.ID == "" || a.Secret == "" { return errors.New("application name, client ID and client secret are required") } a.enabled = true } widget. withTitle("r/" + widget.Subreddit). withTitleURL("https://www.reddit.com/r/" + widget.Subreddit + "/"). withCacheDuration(30 * time.Minute) return nil } func (widget *redditWidget) update(ctx context.Context) { posts, err := widget.fetchSubredditPosts() if !widget.canContinueUpdateAfterHandlingErr(err) { return } if len(posts) > widget.Limit { posts = posts[:widget.Limit] } if widget.ExtraSortBy == "engagement" { posts.calculateEngagement() posts.sortByEngagement() } widget.Posts = posts } func (widget *redditWidget) Render() template.HTML { if widget.Style == "horizontal-cards" { return widget.renderTemplate(widget, redditWidgetHorizontalCardsTemplate) } if widget.Style == "vertical-cards" { return widget.renderTemplate(widget, redditWidgetVerticalCardsTemplate) } return widget.renderTemplate(widget, forumPostsTemplate) } type subredditResponseJson struct { Data struct { Children []struct { Data struct { Id string `json:"id"` Title string `json:"title"` Upvotes int `json:"ups"` Url string `json:"url"` Time float64 `json:"created"` CommentsCount int `json:"num_comments"` Domain string `json:"domain"` Permalink string `json:"permalink"` Stickied bool `json:"stickied"` Pinned bool `json:"pinned"` IsSelf bool `json:"is_self"` Thumbnail string `json:"thumbnail"` Flair string `json:"link_flair_text"` ParentList []struct { Id string `json:"id"` Subreddit string `json:"subreddit"` Permalink string `json:"permalink"` } `json:"crosspost_parent_list"` } `json:"data"` } `json:"children"` } `json:"data"` } func (widget *redditWidget) parseCustomCommentsURL(subreddit, postId, postPath string) string { template := strings.ReplaceAll(widget.CommentsURLTemplate, "{SUBREDDIT}", subreddit) template = strings.ReplaceAll(template, "{POST-ID}", postId) template = strings.ReplaceAll(template, "{POST-PATH}", strings.TrimLeft(postPath, "/")) return template } func (widget *redditWidget) fetchSubredditPosts() (forumPostList, error) { var client requestDoer = defaultHTTPClient var baseURL string var requestURL string var headers http.Header query := url.Values{} app := &widget.AppAuth if !app.enabled { baseURL = "https://www.reddit.com" headers = http.Header{ "User-Agent": []string{getBrowserUserAgentHeader()}, } } else { baseURL = "https://oauth.reddit.com" if app.accessToken == "" || time.Now().Add(time.Minute).After(app.tokenExpiresAt) { if err := widget.fetchNewAppAccessToken(); err != nil { return nil, fmt.Errorf("fetching new app access token: %v", err) } } headers = http.Header{ "Authorization": []string{"Bearer " + app.accessToken}, "User-Agent": []string{app.Name + "/1.0"}, } } if widget.Limit > 25 { query.Set("limit", strconv.Itoa(widget.Limit)) } if widget.Search != "" { query.Set("q", widget.Search+" subreddit:"+widget.Subreddit) query.Set("sort", widget.SortBy) requestURL = fmt.Sprintf("%s/search.json?%s", baseURL, query.Encode()) } else { if widget.SortBy == "top" { query.Set("t", widget.TopPeriod) } requestURL = fmt.Sprintf("%s/r/%s/%s.json?%s", baseURL, widget.Subreddit, widget.SortBy, query.Encode()) } if widget.RequestURLTemplate != "" { requestURL = strings.ReplaceAll(widget.RequestURLTemplate, "{REQUEST-URL}", requestURL) } else if widget.Proxy.client != nil { client = widget.Proxy.client } request, err := http.NewRequest("GET", requestURL, nil) if err != nil { return nil, err } request.Header = headers responseJson, err := decodeJsonFromRequest[subredditResponseJson](client, request) if err != nil { return nil, err } if len(responseJson.Data.Children) == 0 { return nil, fmt.Errorf("no posts found") } posts := make(forumPostList, 0, len(responseJson.Data.Children)) for i := range responseJson.Data.Children { post := &responseJson.Data.Children[i].Data if post.Stickied || post.Pinned { continue } var commentsUrl string if widget.CommentsURLTemplate == "" { commentsUrl = "https://www.reddit.com" + post.Permalink } else { commentsUrl = widget.parseCustomCommentsURL(widget.Subreddit, post.Id, post.Permalink) } forumPost := forumPost{ Title: html.UnescapeString(post.Title), DiscussionUrl: commentsUrl, TargetUrlDomain: post.Domain, CommentCount: post.CommentsCount, Score: post.Upvotes, TimePosted: time.Unix(int64(post.Time), 0), } if post.Thumbnail != "" && post.Thumbnail != "self" && post.Thumbnail != "default" && post.Thumbnail != "nsfw" { forumPost.ThumbnailUrl = html.UnescapeString(post.Thumbnail) } if !post.IsSelf { forumPost.TargetUrl = post.Url } if widget.ShowFlairs && post.Flair != "" { forumPost.Tags = append(forumPost.Tags, post.Flair) } if len(post.ParentList) > 0 { forumPost.IsCrosspost = true forumPost.TargetUrlDomain = "r/" + post.ParentList[0].Subreddit if widget.CommentsURLTemplate == "" { forumPost.TargetUrl = "https://www.reddit.com" + post.ParentList[0].Permalink } else { forumPost.TargetUrl = widget.parseCustomCommentsURL( post.ParentList[0].Subreddit, post.ParentList[0].Id, post.ParentList[0].Permalink, ) } } posts = append(posts, forumPost) } return posts, nil } func (widget *redditWidget) fetchNewAppAccessToken() error { body := strings.NewReader("grant_type=client_credentials") req, err := http.NewRequest("POST", "https://www.reddit.com/api/v1/access_token", body) if err != nil { return fmt.Errorf("creating request for app access token: %v", err) } app := &widget.AppAuth req.SetBasicAuth(app.ID, app.Secret) req.Header.Add("User-Agent", app.Name+"/1.0") req.Header.Add("Content-Type", "application/x-www-form-urlencoded") type tokenResponse struct { AccessToken string `json:"access_token"` ExpiresIn int `json:"expires_in"` } client := ternary(widget.Proxy.client != nil, widget.Proxy.client, defaultHTTPClient) response, err := decodeJsonFromRequest[tokenResponse](client, req) if err != nil { return err } app.accessToken = response.AccessToken app.tokenExpiresAt = time.Now().Add(time.Duration(response.ExpiresIn) * time.Second) return nil } ================================================ FILE: internal/glance/widget-releases.go ================================================ package glance import ( "context" "errors" "fmt" "html/template" "log/slog" "net/http" "net/url" "sort" "strings" "time" "gopkg.in/yaml.v3" ) var releasesWidgetTemplate = mustParseTemplate("releases.html", "widget-base.html") type releasesWidget struct { widgetBase `yaml:",inline"` Releases appReleaseList `yaml:"-"` Repositories []*releaseRequest `yaml:"repositories"` Token string `yaml:"token"` GitLabToken string `yaml:"gitlab-token"` Limit int `yaml:"limit"` CollapseAfter int `yaml:"collapse-after"` ShowSourceIcon bool `yaml:"show-source-icon"` } func (widget *releasesWidget) initialize() error { widget.withTitle("Releases").withCacheDuration(2 * time.Hour) if widget.Limit <= 0 { widget.Limit = 10 } if widget.CollapseAfter == 0 || widget.CollapseAfter < -1 { widget.CollapseAfter = 5 } for i := range widget.Repositories { r := widget.Repositories[i] if r.source == releaseSourceGithub && widget.Token != "" { r.token = &widget.Token } else if r.source == releaseSourceGitlab && widget.GitLabToken != "" { r.token = &widget.GitLabToken } } return nil } func (widget *releasesWidget) update(ctx context.Context) { releases, err := fetchLatestReleases(widget.Repositories) if !widget.canContinueUpdateAfterHandlingErr(err) { return } if len(releases) > widget.Limit { releases = releases[:widget.Limit] } for i := range releases { releases[i].SourceIconURL = widget.Providers.assetResolver("icons/" + string(releases[i].Source) + ".svg") } widget.Releases = releases } func (widget *releasesWidget) Render() template.HTML { return widget.renderTemplate(widget, releasesWidgetTemplate) } type releaseSource string const ( releaseSourceCodeberg releaseSource = "codeberg" releaseSourceGithub releaseSource = "github" releaseSourceGitlab releaseSource = "gitlab" releaseSourceDockerHub releaseSource = "dockerhub" ) type appRelease struct { Source releaseSource SourceIconURL string Name string Version string NotesUrl string TimeReleased time.Time Downvotes int } type appReleaseList []appRelease func (r appReleaseList) sortByNewest() appReleaseList { sort.Slice(r, func(i, j int) bool { return r[i].TimeReleased.After(r[j].TimeReleased) }) return r } type releaseRequest struct { IncludePreleases bool `yaml:"include-prereleases"` Repository string `yaml:"repository"` source releaseSource token *string } func (r *releaseRequest) UnmarshalYAML(node *yaml.Node) error { type releaseRequestAlias releaseRequest alias := (*releaseRequestAlias)(r) var repository string if err := node.Decode(&repository); err != nil { if err := node.Decode(alias); err != nil { return fmt.Errorf("could not umarshal repository into string or struct: %v", err) } } if r.Repository == "" { if repository == "" { return errors.New("repository is required") } else { r.Repository = repository } } parts := strings.SplitN(repository, ":", 2) if len(parts) == 1 { r.source = releaseSourceGithub } else if len(parts) == 2 { r.Repository = parts[1] switch parts[0] { case string(releaseSourceGithub): r.source = releaseSourceGithub case string(releaseSourceGitlab): r.source = releaseSourceGitlab case string(releaseSourceDockerHub): r.source = releaseSourceDockerHub case string(releaseSourceCodeberg): r.source = releaseSourceCodeberg default: return errors.New("invalid source") } } return nil } func fetchLatestReleases(requests []*releaseRequest) (appReleaseList, error) { job := newJob(fetchLatestReleaseTask, requests).withWorkers(20) results, errs, err := workerPoolDo(job) if err != nil { return nil, err } var failed int releases := make(appReleaseList, 0, len(requests)) for i := range results { if errs[i] != nil { failed++ slog.Error("Failed to fetch release", "source", requests[i].source, "repository", requests[i].Repository, "error", errs[i]) continue } releases = append(releases, *results[i]) } if failed == len(requests) { return nil, errNoContent } releases.sortByNewest() if failed > 0 { return releases, fmt.Errorf("%w: could not get %d releases", errPartialContent, failed) } return releases, nil } func fetchLatestReleaseTask(request *releaseRequest) (*appRelease, error) { switch request.source { case releaseSourceCodeberg: return fetchLatestCodebergRelease(request) case releaseSourceGithub: return fetchLatestGithubRelease(request) case releaseSourceGitlab: return fetchLatestGitLabRelease(request) case releaseSourceDockerHub: return fetchLatestDockerHubRelease(request) } return nil, errors.New("unsupported source") } type githubReleaseResponseJson struct { TagName string `json:"tag_name"` PublishedAt string `json:"published_at"` HtmlUrl string `json:"html_url"` Reactions struct { Downvotes int `json:"-1"` } `json:"reactions"` } func fetchLatestGithubRelease(request *releaseRequest) (*appRelease, error) { var requestURL string if !request.IncludePreleases { requestURL = fmt.Sprintf("https://api.github.com/repos/%s/releases/latest", request.Repository) } else { requestURL = fmt.Sprintf("https://api.github.com/repos/%s/releases", request.Repository) } httpRequest, err := http.NewRequest("GET", requestURL, nil) if err != nil { return nil, err } if request.token != nil { httpRequest.Header.Add("Authorization", "Bearer "+(*request.token)) } var response githubReleaseResponseJson if !request.IncludePreleases { response, err = decodeJsonFromRequest[githubReleaseResponseJson](defaultHTTPClient, httpRequest) if err != nil { return nil, err } } else { responses, err := decodeJsonFromRequest[[]githubReleaseResponseJson](defaultHTTPClient, httpRequest) if err != nil { return nil, err } if len(responses) == 0 { return nil, fmt.Errorf("no releases found for repository %s", request.Repository) } response = responses[0] } return &appRelease{ Source: releaseSourceGithub, Name: request.Repository, Version: normalizeVersionFormat(response.TagName), NotesUrl: response.HtmlUrl, TimeReleased: parseRFC3339Time(response.PublishedAt), Downvotes: response.Reactions.Downvotes, }, nil } type dockerHubRepositoryTagsResponse struct { Results []dockerHubRepositoryTagResponse `json:"results"` } type dockerHubRepositoryTagResponse struct { Name string `json:"name"` LastPushed string `json:"tag_last_pushed"` } const dockerHubOfficialRepoTagURLFormat = "https://hub.docker.com/_/%s/tags?name=%s" const dockerHubRepoTagURLFormat = "https://hub.docker.com/r/%s/tags?name=%s" const dockerHubTagsURLFormat = "https://hub.docker.com/v2/namespaces/%s/repositories/%s/tags" const dockerHubSpecificTagURLFormat = "https://hub.docker.com/v2/namespaces/%s/repositories/%s/tags/%s" func fetchLatestDockerHubRelease(request *releaseRequest) (*appRelease, error) { nameParts := strings.Split(request.Repository, "/") if len(nameParts) > 2 { return nil, fmt.Errorf("invalid repository name: %s", request.Repository) } else if len(nameParts) == 1 { nameParts = []string{"library", nameParts[0]} } tagParts := strings.SplitN(nameParts[1], ":", 2) var requestURL string if len(tagParts) == 2 { requestURL = fmt.Sprintf(dockerHubSpecificTagURLFormat, nameParts[0], tagParts[0], tagParts[1]) } else { requestURL = fmt.Sprintf(dockerHubTagsURLFormat, nameParts[0], nameParts[1]) } httpRequest, err := http.NewRequest("GET", requestURL, nil) if err != nil { return nil, err } if request.token != nil { httpRequest.Header.Add("Authorization", "Bearer "+(*request.token)) } var tag *dockerHubRepositoryTagResponse if len(tagParts) == 1 { response, err := decodeJsonFromRequest[dockerHubRepositoryTagsResponse](defaultHTTPClient, httpRequest) if err != nil { return nil, err } if len(response.Results) == 0 { return nil, fmt.Errorf("no tags found for repository: %s", request.Repository) } tag = &response.Results[0] } else { response, err := decodeJsonFromRequest[dockerHubRepositoryTagResponse](defaultHTTPClient, httpRequest) if err != nil { return nil, err } tag = &response } var repo string var displayName string var notesURL string if len(tagParts) == 1 { repo = nameParts[1] } else { repo = tagParts[0] } if nameParts[0] == "library" { displayName = repo notesURL = fmt.Sprintf(dockerHubOfficialRepoTagURLFormat, repo, tag.Name) } else { displayName = nameParts[0] + "/" + repo notesURL = fmt.Sprintf(dockerHubRepoTagURLFormat, displayName, tag.Name) } return &appRelease{ Source: releaseSourceDockerHub, NotesUrl: notesURL, Name: displayName, Version: tag.Name, TimeReleased: parseRFC3339Time(tag.LastPushed), }, nil } type gitlabReleaseResponseJson struct { TagName string `json:"tag_name"` ReleasedAt string `json:"released_at"` Links struct { Self string `json:"self"` } `json:"_links"` } func fetchLatestGitLabRelease(request *releaseRequest) (*appRelease, error) { httpRequest, err := http.NewRequest( "GET", fmt.Sprintf( "https://gitlab.com/api/v4/projects/%s/releases/permalink/latest", url.QueryEscape(request.Repository), ), nil, ) if err != nil { return nil, err } if request.token != nil { httpRequest.Header.Add("PRIVATE-TOKEN", *request.token) } response, err := decodeJsonFromRequest[gitlabReleaseResponseJson](defaultHTTPClient, httpRequest) if err != nil { return nil, err } return &appRelease{ Source: releaseSourceGitlab, Name: request.Repository, Version: normalizeVersionFormat(response.TagName), NotesUrl: response.Links.Self, TimeReleased: parseRFC3339Time(response.ReleasedAt), }, nil } type codebergReleaseResponseJson struct { TagName string `json:"tag_name"` PublishedAt string `json:"published_at"` HtmlUrl string `json:"html_url"` } func fetchLatestCodebergRelease(request *releaseRequest) (*appRelease, error) { httpRequest, err := http.NewRequest( "GET", fmt.Sprintf( "https://codeberg.org/api/v1/repos/%s/releases/latest", request.Repository, ), nil, ) if err != nil { return nil, err } response, err := decodeJsonFromRequest[codebergReleaseResponseJson](defaultHTTPClient, httpRequest) if err != nil { return nil, err } return &appRelease{ Source: releaseSourceCodeberg, Name: request.Repository, Version: normalizeVersionFormat(response.TagName), NotesUrl: response.HtmlUrl, TimeReleased: parseRFC3339Time(response.PublishedAt), }, nil } ================================================ FILE: internal/glance/widget-repository.go ================================================ package glance import ( "context" "fmt" "html/template" "net/http" "strings" "sync" "time" ) var repositoryWidgetTemplate = mustParseTemplate("repository.html", "widget-base.html") type repositoryWidget struct { widgetBase `yaml:",inline"` RequestedRepository string `yaml:"repository"` Token string `yaml:"token"` PullRequestsLimit int `yaml:"pull-requests-limit"` IssuesLimit int `yaml:"issues-limit"` CommitsLimit int `yaml:"commits-limit"` Repository repository `yaml:"-"` } func (widget *repositoryWidget) initialize() error { widget.withTitle("Repository").withCacheDuration(1 * time.Hour) if widget.PullRequestsLimit == 0 || widget.PullRequestsLimit < -1 { widget.PullRequestsLimit = 3 } if widget.IssuesLimit == 0 || widget.IssuesLimit < -1 { widget.IssuesLimit = 3 } if widget.CommitsLimit == 0 || widget.CommitsLimit < -1 { widget.CommitsLimit = -1 } return nil } func (widget *repositoryWidget) update(ctx context.Context) { details, err := fetchRepositoryDetailsFromGithub( widget.RequestedRepository, string(widget.Token), widget.PullRequestsLimit, widget.IssuesLimit, widget.CommitsLimit, ) if !widget.canContinueUpdateAfterHandlingErr(err) { return } widget.Repository = details } func (widget *repositoryWidget) Render() template.HTML { return widget.renderTemplate(widget, repositoryWidgetTemplate) } type repository struct { Name string Stars int Forks int OpenPullRequests int PullRequests []githubTicket OpenIssues int Issues []githubTicket LastCommits int Commits []githubCommitDetails } type githubTicket struct { Number int CreatedAt time.Time Title string } type githubCommitDetails struct { Sha string Author string CreatedAt time.Time Message string } type githubRepositoryResponseJson struct { Name string `json:"full_name"` Stars int `json:"stargazers_count"` Forks int `json:"forks_count"` } type githubTicketResponseJson struct { Count int `json:"total_count"` Tickets []struct { Number int `json:"number"` CreatedAt string `json:"created_at"` Title string `json:"title"` } `json:"items"` } type gitHubCommitResponseJson struct { Sha string `json:"sha"` Commit struct { Author struct { Name string `json:"name"` Date string `json:"date"` } `json:"author"` Message string `json:"message"` } `json:"commit"` } func fetchRepositoryDetailsFromGithub(repo string, token string, maxPRs int, maxIssues int, maxCommits int) (repository, error) { repositoryRequest, err := http.NewRequest("GET", fmt.Sprintf("https://api.github.com/repos/%s", repo), nil) if err != nil { return repository{}, fmt.Errorf("%w: could not create request with repository: %v", errNoContent, err) } PRsRequest, _ := http.NewRequest("GET", fmt.Sprintf("https://api.github.com/search/issues?q=is:pr+is:open+repo:%s&per_page=%d", repo, maxPRs), nil) issuesRequest, _ := http.NewRequest("GET", fmt.Sprintf("https://api.github.com/search/issues?q=is:issue+is:open+repo:%s&per_page=%d", repo, maxIssues), nil) CommitsRequest, _ := http.NewRequest("GET", fmt.Sprintf("https://api.github.com/repos/%s/commits?per_page=%d", repo, maxCommits), nil) if token != "" { token = fmt.Sprintf("Bearer %s", token) repositoryRequest.Header.Add("Authorization", token) PRsRequest.Header.Add("Authorization", token) issuesRequest.Header.Add("Authorization", token) CommitsRequest.Header.Add("Authorization", token) } var repositoryResponse githubRepositoryResponseJson var detailsErr error var PRsResponse githubTicketResponseJson var PRsErr error var issuesResponse githubTicketResponseJson var issuesErr error var commitsResponse []gitHubCommitResponseJson var CommitsErr error var wg sync.WaitGroup wg.Add(1) go (func() { defer wg.Done() repositoryResponse, detailsErr = decodeJsonFromRequest[githubRepositoryResponseJson](defaultHTTPClient, repositoryRequest) })() if maxPRs > 0 { wg.Add(1) go (func() { defer wg.Done() PRsResponse, PRsErr = decodeJsonFromRequest[githubTicketResponseJson](defaultHTTPClient, PRsRequest) })() } if maxIssues > 0 { wg.Add(1) go (func() { defer wg.Done() issuesResponse, issuesErr = decodeJsonFromRequest[githubTicketResponseJson](defaultHTTPClient, issuesRequest) })() } if maxCommits > 0 { wg.Add(1) go (func() { defer wg.Done() commitsResponse, CommitsErr = decodeJsonFromRequest[[]gitHubCommitResponseJson](defaultHTTPClient, CommitsRequest) })() } wg.Wait() if detailsErr != nil { return repository{}, fmt.Errorf("%w: could not get repository details: %s", errNoContent, detailsErr) } details := repository{ Name: repositoryResponse.Name, Stars: repositoryResponse.Stars, Forks: repositoryResponse.Forks, PullRequests: make([]githubTicket, 0, len(PRsResponse.Tickets)), Issues: make([]githubTicket, 0, len(issuesResponse.Tickets)), Commits: make([]githubCommitDetails, 0, len(commitsResponse)), } err = nil if maxPRs > 0 { if PRsErr != nil { err = fmt.Errorf("%w: could not get PRs: %s", errPartialContent, PRsErr) } else { details.OpenPullRequests = PRsResponse.Count for i := range PRsResponse.Tickets { details.PullRequests = append(details.PullRequests, githubTicket{ Number: PRsResponse.Tickets[i].Number, CreatedAt: parseRFC3339Time(PRsResponse.Tickets[i].CreatedAt), Title: PRsResponse.Tickets[i].Title, }) } } } if maxIssues > 0 { if issuesErr != nil { // TODO: fix, overwriting the previous error err = fmt.Errorf("%w: could not get issues: %s", errPartialContent, issuesErr) } else { details.OpenIssues = issuesResponse.Count for i := range issuesResponse.Tickets { details.Issues = append(details.Issues, githubTicket{ Number: issuesResponse.Tickets[i].Number, CreatedAt: parseRFC3339Time(issuesResponse.Tickets[i].CreatedAt), Title: issuesResponse.Tickets[i].Title, }) } } } if maxCommits > 0 { if CommitsErr != nil { err = fmt.Errorf("%w: could not get commits: %s", errPartialContent, CommitsErr) } else { for i := range commitsResponse { details.Commits = append(details.Commits, githubCommitDetails{ Sha: commitsResponse[i].Sha, Author: commitsResponse[i].Commit.Author.Name, CreatedAt: parseRFC3339Time(commitsResponse[i].Commit.Author.Date), Message: strings.SplitN(commitsResponse[i].Commit.Message, "\n\n", 2)[0], }) } } } return details, err } ================================================ FILE: internal/glance/widget-rss.go ================================================ package glance import ( "context" "fmt" "html" "html/template" "io" "log/slog" "net/http" "net/url" "regexp" "sort" "strings" "sync" "time" "github.com/mmcdole/gofeed" gofeedext "github.com/mmcdole/gofeed/extensions" ) var ( rssWidgetTemplate = mustParseTemplate("rss-list.html", "widget-base.html") rssWidgetDetailedListTemplate = mustParseTemplate("rss-detailed-list.html", "widget-base.html") rssWidgetHorizontalCardsTemplate = mustParseTemplate("rss-horizontal-cards.html", "widget-base.html") rssWidgetHorizontalCards2Template = mustParseTemplate("rss-horizontal-cards-2.html", "widget-base.html") ) var feedParser = gofeed.NewParser() type rssWidget struct { widgetBase `yaml:",inline"` FeedRequests []rssFeedRequest `yaml:"feeds"` Style string `yaml:"style"` ThumbnailHeight float64 `yaml:"thumbnail-height"` CardHeight float64 `yaml:"card-height"` Limit int `yaml:"limit"` CollapseAfter int `yaml:"collapse-after"` SingleLineTitles bool `yaml:"single-line-titles"` PreserveOrder bool `yaml:"preserve-order"` Items rssFeedItemList `yaml:"-"` NoItemsMessage string `yaml:"-"` cachedFeedsMutex sync.Mutex cachedFeeds map[string]*cachedRSSFeed `yaml:"-"` } func (widget *rssWidget) initialize() error { widget.withTitle("RSS Feed").withCacheDuration(2 * time.Hour) if widget.Limit <= 0 { widget.Limit = 25 } if widget.CollapseAfter == 0 || widget.CollapseAfter < -1 { widget.CollapseAfter = 5 } if widget.ThumbnailHeight < 0 { widget.ThumbnailHeight = 0 } if widget.CardHeight < 0 { widget.CardHeight = 0 } if widget.Style == "detailed-list" { for i := range widget.FeedRequests { widget.FeedRequests[i].IsDetailed = true } } widget.NoItemsMessage = "No items were returned from the feeds." widget.cachedFeeds = make(map[string]*cachedRSSFeed) return nil } func (widget *rssWidget) update(ctx context.Context) { items, err := widget.fetchItemsFromFeeds() if !widget.canContinueUpdateAfterHandlingErr(err) { return } if !widget.PreserveOrder { items.sortByNewest() } if len(items) > widget.Limit { items = items[:widget.Limit] } widget.Items = items } func (widget *rssWidget) Render() template.HTML { if widget.Style == "horizontal-cards" { return widget.renderTemplate(widget, rssWidgetHorizontalCardsTemplate) } if widget.Style == "horizontal-cards-2" { return widget.renderTemplate(widget, rssWidgetHorizontalCards2Template) } if widget.Style == "detailed-list" { return widget.renderTemplate(widget, rssWidgetDetailedListTemplate) } return widget.renderTemplate(widget, rssWidgetTemplate) } type cachedRSSFeed struct { etag string lastModified string items []rssFeedItem } type rssFeedItem struct { ChannelName string ChannelURL string Title string Link string ImageURL string Categories []string Description string PublishedAt time.Time } type rssFeedRequest struct { URL string `yaml:"url"` Title string `yaml:"title"` HideCategories bool `yaml:"hide-categories"` HideDescription bool `yaml:"hide-description"` Limit int `yaml:"limit"` ItemLinkPrefix string `yaml:"item-link-prefix"` Headers map[string]string `yaml:"headers"` IsDetailed bool `yaml:"-"` } type rssFeedItemList []rssFeedItem func (f rssFeedItemList) sortByNewest() rssFeedItemList { sort.Slice(f, func(i, j int) bool { return f[i].PublishedAt.After(f[j].PublishedAt) }) return f } func (widget *rssWidget) fetchItemsFromFeeds() (rssFeedItemList, error) { requests := widget.FeedRequests job := newJob(widget.fetchItemsFromFeedTask, requests).withWorkers(30) feeds, errs, err := workerPoolDo(job) if err != nil { return nil, fmt.Errorf("%w: %v", errNoContent, err) } failed := 0 entries := make(rssFeedItemList, 0, len(feeds)*10) seen := make(map[string]struct{}) for i := range feeds { if errs[i] != nil { failed++ slog.Error("Failed to get RSS feed", "url", requests[i].URL, "error", errs[i]) continue } for _, item := range feeds[i] { if _, exists := seen[item.Link]; exists { continue } entries = append(entries, item) seen[item.Link] = struct{}{} } } if failed == len(requests) { return nil, errNoContent } if failed > 0 { return entries, fmt.Errorf("%w: missing %d RSS feeds", errPartialContent, failed) } return entries, nil } func (widget *rssWidget) fetchItemsFromFeedTask(request rssFeedRequest) ([]rssFeedItem, error) { req, err := http.NewRequest("GET", request.URL, nil) if err != nil { return nil, err } req.Header.Add("User-Agent", glanceUserAgentString) widget.cachedFeedsMutex.Lock() cache, isCached := widget.cachedFeeds[request.URL] if isCached { if cache.etag != "" { req.Header.Add("If-None-Match", cache.etag) } if cache.lastModified != "" { req.Header.Add("If-Modified-Since", cache.lastModified) } } widget.cachedFeedsMutex.Unlock() for key, value := range request.Headers { req.Header.Set(key, value) } resp, err := defaultHTTPClient.Do(req) if err != nil { return nil, err } defer resp.Body.Close() if resp.StatusCode == http.StatusNotModified && isCached { return cache.items, nil } if resp.StatusCode != http.StatusOK { return nil, fmt.Errorf("unexpected status code %d from %s", resp.StatusCode, request.URL) } body, err := io.ReadAll(resp.Body) if err != nil { return nil, err } feed, err := feedParser.ParseString(string(body)) if err != nil { return nil, err } if request.Limit > 0 && len(feed.Items) > request.Limit { feed.Items = feed.Items[:request.Limit] } items := make(rssFeedItemList, 0, len(feed.Items)) for i := range feed.Items { item := feed.Items[i] rssItem := rssFeedItem{ ChannelURL: feed.Link, } if request.ItemLinkPrefix != "" { rssItem.Link = request.ItemLinkPrefix + item.Link } else if strings.HasPrefix(item.Link, "http://") || strings.HasPrefix(item.Link, "https://") { rssItem.Link = item.Link } else { parsedUrl, err := url.Parse(feed.Link) if err != nil { parsedUrl, err = url.Parse(request.URL) } if err == nil { var link string if len(item.Link) > 0 && item.Link[0] == '/' { link = item.Link } else { link = "/" + item.Link } rssItem.Link = parsedUrl.Scheme + "://" + parsedUrl.Host + link } } if item.Title != "" { rssItem.Title = html.UnescapeString(item.Title) } else { rssItem.Title = shortenFeedDescriptionLen(item.Description, 100) } if request.IsDetailed { if !request.HideDescription && item.Description != "" && item.Title != "" { rssItem.Description = shortenFeedDescriptionLen(item.Description, 200) } if !request.HideCategories { var categories = make([]string, 0, 6) for _, category := range item.Categories { if len(categories) == 6 { break } if len(category) == 0 || len(category) > 30 { continue } categories = append(categories, category) } rssItem.Categories = categories } } if request.Title != "" { rssItem.ChannelName = request.Title } else { rssItem.ChannelName = feed.Title } if item.Image != nil { rssItem.ImageURL = item.Image.URL } else if url := findThumbnailInItemExtensions(item); url != "" { rssItem.ImageURL = url } else if feed.Image != nil { if len(feed.Image.URL) > 0 && feed.Image.URL[0] == '/' { rssItem.ImageURL = strings.TrimRight(feed.Link, "/") + feed.Image.URL } else { rssItem.ImageURL = feed.Image.URL } } if item.PublishedParsed != nil { rssItem.PublishedAt = *item.PublishedParsed } else { rssItem.PublishedAt = time.Now() } items = append(items, rssItem) } if resp.Header.Get("ETag") != "" || resp.Header.Get("Last-Modified") != "" { widget.cachedFeedsMutex.Lock() widget.cachedFeeds[request.URL] = &cachedRSSFeed{ etag: resp.Header.Get("ETag"), lastModified: resp.Header.Get("Last-Modified"), items: items, } widget.cachedFeedsMutex.Unlock() } return items, nil } func findThumbnailInItemExtensions(item *gofeed.Item) string { media, ok := item.Extensions["media"] if !ok { return "" } return recursiveFindThumbnailInExtensions(media) } func recursiveFindThumbnailInExtensions(extensions map[string][]gofeedext.Extension) string { for _, exts := range extensions { for _, ext := range exts { if ext.Name == "thumbnail" || ext.Name == "image" { if url, ok := ext.Attrs["url"]; ok { return url } } if ext.Children != nil { if url := recursiveFindThumbnailInExtensions(ext.Children); url != "" { return url } } } } return "" } var htmlTagsWithAttributesPattern = regexp.MustCompile(`<\/?[a-zA-Z0-9-]+ *(?:[a-zA-Z-]+=(?:"|').*?(?:"|') ?)* *\/?>`) func sanitizeFeedDescription(description string) string { if description == "" { return "" } description = strings.ReplaceAll(description, "\n", " ") description = htmlTagsWithAttributesPattern.ReplaceAllString(description, "") description = sequentialWhitespacePattern.ReplaceAllString(description, " ") description = strings.TrimSpace(description) description = html.UnescapeString(description) return description } func shortenFeedDescriptionLen(description string, maxLen int) string { description, _ = limitStringLength(description, 1000) description = sanitizeFeedDescription(description) description, limited := limitStringLength(description, maxLen) if limited { description += "…" } return description } ================================================ FILE: internal/glance/widget-search.go ================================================ package glance import ( "fmt" "html/template" "strings" ) var searchWidgetTemplate = mustParseTemplate("search.html", "widget-base.html") type SearchBang struct { Title string Shortcut string URL string } type searchWidget struct { widgetBase `yaml:",inline"` cachedHTML template.HTML `yaml:"-"` SearchEngine string `yaml:"search-engine"` Bangs []SearchBang `yaml:"bangs"` NewTab bool `yaml:"new-tab"` Target string `yaml:"target"` Autofocus bool `yaml:"autofocus"` Placeholder string `yaml:"placeholder"` } func convertSearchUrl(url string) string { // Go's template is being stubborn and continues to escape the curlies in the // URL regardless of what the type of the variable is so this is my way around it return strings.ReplaceAll(url, "{QUERY}", "!QUERY!") } var searchEngines = map[string]string{ "duckduckgo": "https://duckduckgo.com/?q={QUERY}", "google": "https://www.google.com/search?q={QUERY}", "bing": "https://www.bing.com/search?q={QUERY}", "perplexity": "https://www.perplexity.ai/search?q={QUERY}", "kagi": "https://kagi.com/search?q={QUERY}", "startpage": "https://www.startpage.com/search?q={QUERY}", } func (widget *searchWidget) initialize() error { widget.withTitle("Search").withError(nil) if widget.SearchEngine == "" { widget.SearchEngine = "duckduckgo" } if widget.Placeholder == "" { widget.Placeholder = "Type here to search…" } if url, ok := searchEngines[widget.SearchEngine]; ok { widget.SearchEngine = url } widget.SearchEngine = convertSearchUrl(widget.SearchEngine) for i := range widget.Bangs { if widget.Bangs[i].Shortcut == "" { return fmt.Errorf("search bang #%d has no shortcut", i+1) } if widget.Bangs[i].URL == "" { return fmt.Errorf("search bang #%d has no URL", i+1) } widget.Bangs[i].URL = convertSearchUrl(widget.Bangs[i].URL) } widget.cachedHTML = widget.renderTemplate(widget, searchWidgetTemplate) return nil } func (widget *searchWidget) Render() template.HTML { return widget.cachedHTML } ================================================ FILE: internal/glance/widget-server-stats.go ================================================ package glance import ( "context" "html/template" "log/slog" "net/http" "strconv" "strings" "sync" "time" "github.com/glanceapp/glance/pkg/sysinfo" ) var serverStatsWidgetTemplate = mustParseTemplate("server-stats.html", "widget-base.html") type serverStatsWidget struct { widgetBase `yaml:",inline"` Servers []serverStatsRequest `yaml:"servers"` } func (widget *serverStatsWidget) initialize() error { widget.withTitle("Server Stats").withCacheDuration(15 * time.Second) widget.widgetBase.WIP = true if len(widget.Servers) == 0 { widget.Servers = []serverStatsRequest{{Type: "local"}} } for i := range widget.Servers { widget.Servers[i].URL = strings.TrimRight(widget.Servers[i].URL, "/") if widget.Servers[i].Timeout == 0 { widget.Servers[i].Timeout = durationField(3 * time.Second) } } return nil } func (widget *serverStatsWidget) update(context.Context) { // Refactor later, most of it may change depending on feedback var wg sync.WaitGroup for i := range widget.Servers { serv := &widget.Servers[i] if serv.Type == "local" { info, errs := sysinfo.Collect(serv.SystemInfoRequest) if len(errs) > 0 { for i := range errs { slog.Warn("Getting system info: " + errs[i].Error()) } } serv.IsReachable = true serv.Info = info } else { wg.Add(1) go func() { defer wg.Done() info, err := fetchRemoteServerInfo(serv) if err != nil { slog.Warn("Getting remote system info: " + err.Error()) serv.IsReachable = false serv.Info = &sysinfo.SystemInfo{ Hostname: "Unnamed server #" + strconv.Itoa(i+1), } } else { serv.IsReachable = true serv.Info = info } }() } } wg.Wait() widget.withError(nil).scheduleNextUpdate() } func (widget *serverStatsWidget) Render() template.HTML { return widget.renderTemplate(widget, serverStatsWidgetTemplate) } type serverStatsRequest struct { *sysinfo.SystemInfoRequest `yaml:",inline"` Info *sysinfo.SystemInfo `yaml:"-"` IsReachable bool `yaml:"-"` StatusText string `yaml:"-"` Name string `yaml:"name"` HideSwap bool `yaml:"hide-swap"` Type string `yaml:"type"` URL string `yaml:"url"` Token string `yaml:"token"` Timeout durationField `yaml:"timeout"` // Support for other agents // Provider string `yaml:"provider"` } func fetchRemoteServerInfo(infoReq *serverStatsRequest) (*sysinfo.SystemInfo, error) { ctx, cancel := context.WithTimeout(context.Background(), time.Duration(infoReq.Timeout)) defer cancel() request, _ := http.NewRequestWithContext(ctx, "GET", infoReq.URL+"/api/sysinfo/all", nil) if infoReq.Token != "" { request.Header.Set("Authorization", "Bearer "+infoReq.Token) } info, err := decodeJsonFromRequest[*sysinfo.SystemInfo](defaultHTTPClient, request) if err != nil { return nil, err } return info, nil } ================================================ FILE: internal/glance/widget-shared.go ================================================ package glance import ( "math" "sort" "time" ) const twitchGqlEndpoint = "https://gql.twitch.tv/gql" const twitchGqlClientId = "kimne78kx3ncx6brgo4mv6wki5h1ko" var forumPostsTemplate = mustParseTemplate("forum-posts.html", "widget-base.html") type forumPost struct { Title string DiscussionUrl string TargetUrl string TargetUrlDomain string ThumbnailUrl string CommentCount int Score int Engagement float64 TimePosted time.Time Tags []string IsCrosspost bool } type forumPostList []forumPost const depreciatePostsOlderThanHours = 7 const maxDepreciation = 0.9 const maxDepreciationAfterHours = 24 func (p forumPostList) calculateEngagement() { var totalComments int var totalScore int for i := range p { totalComments += p[i].CommentCount totalScore += p[i].Score } numberOfPosts := float64(len(p)) averageComments := float64(totalComments) / numberOfPosts averageScore := float64(totalScore) / numberOfPosts for i := range p { p[i].Engagement = (float64(p[i].CommentCount)/averageComments + float64(p[i].Score)/averageScore) / 2 elapsed := time.Since(p[i].TimePosted) if elapsed < time.Hour*depreciatePostsOlderThanHours { continue } p[i].Engagement *= 1.0 - (math.Max(elapsed.Hours()-depreciatePostsOlderThanHours, maxDepreciationAfterHours)/maxDepreciationAfterHours)*maxDepreciation } } func (p forumPostList) sortByEngagement() { sort.Slice(p, func(i, j int) bool { return p[i].Engagement > p[j].Engagement }) } ================================================ FILE: internal/glance/widget-split-column.go ================================================ package glance import ( "context" "html/template" "time" ) var splitColumnWidgetTemplate = mustParseTemplate("split-column.html", "widget-base.html") type splitColumnWidget struct { widgetBase `yaml:",inline"` containerWidgetBase `yaml:",inline"` MaxColumns int `yaml:"max-columns"` } func (widget *splitColumnWidget) initialize() error { widget.withError(nil).withTitle("Split Column").setHideHeader(true) if err := widget.containerWidgetBase._initializeWidgets(); err != nil { return err } if widget.MaxColumns < 2 { widget.MaxColumns = 2 } return nil } func (widget *splitColumnWidget) update(ctx context.Context) { widget.containerWidgetBase._update(ctx) } func (widget *splitColumnWidget) setProviders(providers *widgetProviders) { widget.containerWidgetBase._setProviders(providers) } func (widget *splitColumnWidget) requiresUpdate(now *time.Time) bool { return widget.containerWidgetBase._requiresUpdate(now) } func (widget *splitColumnWidget) Render() template.HTML { return widget.renderTemplate(widget, splitColumnWidgetTemplate) } ================================================ FILE: internal/glance/widget-todo.go ================================================ package glance import ( "html/template" ) var todoWidgetTemplate = mustParseTemplate("todo.html", "widget-base.html") type todoWidget struct { widgetBase `yaml:",inline"` cachedHTML template.HTML `yaml:"-"` TodoID string `yaml:"id"` } func (widget *todoWidget) initialize() error { widget.withTitle("To-do").withError(nil) widget.cachedHTML = widget.renderTemplate(widget, todoWidgetTemplate) return nil } func (widget *todoWidget) Render() template.HTML { return widget.cachedHTML } ================================================ FILE: internal/glance/widget-twitch-channels.go ================================================ package glance import ( "context" "encoding/json" "fmt" "html/template" "log/slog" "net/http" "sort" "strings" "time" ) var twitchChannelsWidgetTemplate = mustParseTemplate("twitch-channels.html", "widget-base.html") type twitchChannelsWidget struct { widgetBase `yaml:",inline"` ChannelsRequest []string `yaml:"channels"` Channels []twitchChannel `yaml:"-"` CollapseAfter int `yaml:"collapse-after"` SortBy string `yaml:"sort-by"` } func (widget *twitchChannelsWidget) initialize() error { widget. withTitle("Twitch Channels"). withTitleURL("https://www.twitch.tv/directory/following"). withCacheDuration(time.Minute * 10) if widget.CollapseAfter == 0 || widget.CollapseAfter < -1 { widget.CollapseAfter = 5 } if widget.SortBy != "viewers" && widget.SortBy != "live" { widget.SortBy = "viewers" } return nil } func (widget *twitchChannelsWidget) update(ctx context.Context) { channels, err := fetchChannelsFromTwitch(widget.ChannelsRequest) if !widget.canContinueUpdateAfterHandlingErr(err) { return } if widget.SortBy == "viewers" { channels.sortByViewers() } else if widget.SortBy == "live" { channels.sortByLive() } widget.Channels = channels } func (widget *twitchChannelsWidget) Render() template.HTML { return widget.renderTemplate(widget, twitchChannelsWidgetTemplate) } type twitchChannel struct { Login string Exists bool Name string StreamTitle string AvatarUrl string IsLive bool LiveSince time.Time Category string CategorySlug string ViewersCount int } type twitchChannelList []twitchChannel func (channels twitchChannelList) sortByViewers() { sort.Slice(channels, func(i, j int) bool { return channels[i].ViewersCount > channels[j].ViewersCount }) } func (channels twitchChannelList) sortByLive() { sort.SliceStable(channels, func(i, j int) bool { return channels[i].IsLive && !channels[j].IsLive }) } type twitchOperationResponse struct { Data json.RawMessage Extensions struct { OperationName string `json:"operationName"` } } type twitchChannelShellOperationResponse struct { UserOrError struct { Type string `json:"__typename"` DisplayName string `json:"displayName"` ProfileImageUrl string `json:"profileImageURL"` Stream *struct { ViewersCount int `json:"viewersCount"` } } `json:"userOrError"` } type twitchStreamMetadataOperationResponse struct { UserOrNull *struct { Stream *struct { StartedAt string `json:"createdAt"` Game *struct { Slug string `json:"slug"` Name string `json:"name"` } `json:"game"` } `json:"stream"` LastBroadcast *struct { Title string `json:"title"` } } `json:"user"` } const twitchChannelStatusOperationRequestBody = `[ {"operationName":"ChannelShell","variables":{"login":"%s"},"extensions":{"persistedQuery":{"version":1,"sha256Hash":"580ab410bcd0c1ad194224957ae2241e5d252b2c5173d8e0cce9d32d5bb14efe"}}}, {"operationName":"StreamMetadata","variables":{"channelLogin":"%s"},"extensions":{"persistedQuery":{"version":1,"sha256Hash":"676ee2f834ede42eb4514cdb432b3134fefc12590080c9a2c9bb44a2a4a63266"}}} ]` // TODO: rework // The operations for multiple channels can all be sent in a single request // rather than sending a separate request for each channel. Need to figure out // what the limit is for max operations per request and batch operations in // multiple requests if number of channels exceeds allowed limit. func fetchChannelFromTwitchTask(channel string) (twitchChannel, error) { result := twitchChannel{ Login: strings.ToLower(channel), } reader := strings.NewReader(fmt.Sprintf(twitchChannelStatusOperationRequestBody, channel, channel)) request, _ := http.NewRequest("POST", twitchGqlEndpoint, reader) request.Header.Add("Client-ID", twitchGqlClientId) response, err := decodeJsonFromRequest[[]twitchOperationResponse](defaultHTTPClient, request) if err != nil { return result, err } if len(response) != 2 { return result, fmt.Errorf("expected 2 operation responses, got %d", len(response)) } var channelShell twitchChannelShellOperationResponse var streamMetadata twitchStreamMetadataOperationResponse for i := range response { switch response[i].Extensions.OperationName { case "ChannelShell": if err = json.Unmarshal(response[i].Data, &channelShell); err != nil { return result, fmt.Errorf("unmarshalling channel shell: %w", err) } case "StreamMetadata": if err = json.Unmarshal(response[i].Data, &streamMetadata); err != nil { return result, fmt.Errorf("unmarshalling stream metadata: %w", err) } default: return result, fmt.Errorf("unknown operation name: %s", response[i].Extensions.OperationName) } } if channelShell.UserOrError.Type != "User" { result.Name = result.Login return result, nil } result.Exists = true result.Name = channelShell.UserOrError.DisplayName result.AvatarUrl = channelShell.UserOrError.ProfileImageUrl if channelShell.UserOrError.Stream != nil { result.IsLive = true result.ViewersCount = channelShell.UserOrError.Stream.ViewersCount if streamMetadata.UserOrNull != nil && streamMetadata.UserOrNull.Stream != nil { if streamMetadata.UserOrNull.LastBroadcast != nil { result.StreamTitle = streamMetadata.UserOrNull.LastBroadcast.Title } if streamMetadata.UserOrNull.Stream.Game != nil { result.Category = streamMetadata.UserOrNull.Stream.Game.Name result.CategorySlug = streamMetadata.UserOrNull.Stream.Game.Slug } startedAt, err := time.Parse("2006-01-02T15:04:05Z", streamMetadata.UserOrNull.Stream.StartedAt) if err == nil { result.LiveSince = startedAt } else { slog.Warn("Failed to parse Twitch stream started at", "error", err, "started_at", streamMetadata.UserOrNull.Stream.StartedAt) } } } else { // This prevents live channels with 0 viewers from being // incorrectly sorted lower than offline channels result.ViewersCount = -1 } return result, nil } func fetchChannelsFromTwitch(channelLogins []string) (twitchChannelList, error) { result := make(twitchChannelList, 0, len(channelLogins)) job := newJob(fetchChannelFromTwitchTask, channelLogins).withWorkers(10) channels, errs, err := workerPoolDo(job) if err != nil { return result, err } var failed int for i := range channels { if errs[i] != nil { failed++ slog.Error("Failed to fetch Twitch channel", "channel", channelLogins[i], "error", errs[i]) continue } result = append(result, channels[i]) } if failed == len(channelLogins) { return result, errNoContent } if failed > 0 { return result, fmt.Errorf("%w: failed to fetch %d channels", errPartialContent, failed) } return result, nil } ================================================ FILE: internal/glance/widget-twitch-top-games.go ================================================ package glance import ( "context" "errors" "fmt" "html/template" "net/http" "slices" "strings" "time" ) var twitchGamesWidgetTemplate = mustParseTemplate("twitch-games-list.html", "widget-base.html") type twitchGamesWidget struct { widgetBase `yaml:",inline"` Categories []twitchCategory `yaml:"-"` Exclude []string `yaml:"exclude"` Limit int `yaml:"limit"` CollapseAfter int `yaml:"collapse-after"` } func (widget *twitchGamesWidget) initialize() error { widget. withTitle("Top games on Twitch"). withTitleURL("https://www.twitch.tv/directory?sort=VIEWER_COUNT"). withCacheDuration(time.Minute * 10) if widget.Limit <= 0 { widget.Limit = 10 } if widget.CollapseAfter == 0 || widget.CollapseAfter < -1 { widget.CollapseAfter = 5 } return nil } func (widget *twitchGamesWidget) update(ctx context.Context) { categories, err := fetchTopGamesFromTwitch(widget.Exclude, widget.Limit) if !widget.canContinueUpdateAfterHandlingErr(err) { return } widget.Categories = categories } func (widget *twitchGamesWidget) Render() template.HTML { return widget.renderTemplate(widget, twitchGamesWidgetTemplate) } type twitchCategory struct { Slug string `json:"slug"` Name string `json:"name"` AvatarUrl string `json:"avatarURL"` ViewersCount int `json:"viewersCount"` Tags []struct { Name string `json:"tagName"` } `json:"tags"` GameReleaseDate string `json:"originalReleaseDate"` IsNew bool `json:"-"` } type twitchDirectoriesOperationResponse struct { Data struct { DirectoriesWithTags struct { Edges []struct { Node twitchCategory `json:"node"` } `json:"edges"` } `json:"directoriesWithTags"` } `json:"data"` } const twitchDirectoriesOperationRequestBody = `[ {"operationName": "BrowsePage_AllDirectories","variables": {"limit": %d,"options": {"sort": "VIEWER_COUNT","tags": []}},"extensions": {"persistedQuery": {"version": 1,"sha256Hash": "2f67f71ba89f3c0ed26a141ec00da1defecb2303595f5cda4298169549783d9e"}}} ]` func fetchTopGamesFromTwitch(exclude []string, limit int) ([]twitchCategory, error) { reader := strings.NewReader(fmt.Sprintf(twitchDirectoriesOperationRequestBody, len(exclude)+limit)) request, _ := http.NewRequest("POST", twitchGqlEndpoint, reader) request.Header.Add("Client-ID", twitchGqlClientId) response, err := decodeJsonFromRequest[[]twitchDirectoriesOperationResponse](defaultHTTPClient, request) if err != nil { return nil, err } if len(response) == 0 { return nil, errors.New("no categories could be retrieved") } edges := (response)[0].Data.DirectoriesWithTags.Edges categories := make([]twitchCategory, 0, len(edges)) for i := range edges { if slices.Contains(exclude, edges[i].Node.Slug) { continue } category := &edges[i].Node category.AvatarUrl = strings.Replace(category.AvatarUrl, "285x380", "144x192", 1) if len(category.Tags) > 2 { category.Tags = category.Tags[:2] } gameReleasedDate, err := time.Parse("2006-01-02T15:04:05Z", category.GameReleaseDate) if err == nil { if time.Since(gameReleasedDate) < 14*24*time.Hour { category.IsNew = true } } categories = append(categories, *category) } if len(categories) > limit { categories = categories[:limit] } return categories, nil } ================================================ FILE: internal/glance/widget-utils.go ================================================ package glance import ( "context" "crypto/tls" "encoding/json" "encoding/xml" "errors" "fmt" "io" "math/rand/v2" "net/http" "strconv" "sync" "sync/atomic" "time" ) var ( errNoContent = errors.New("failed to retrieve any content") errPartialContent = errors.New("failed to retrieve some of the content") ) const defaultClientTimeout = 5 * time.Second var defaultHTTPClient = &http.Client{ Transport: &http.Transport{ MaxIdleConnsPerHost: 10, Proxy: http.ProxyFromEnvironment, }, Timeout: defaultClientTimeout, } var defaultInsecureHTTPClient = &http.Client{ Timeout: defaultClientTimeout, Transport: &http.Transport{ TLSClientConfig: &tls.Config{InsecureSkipVerify: true}, Proxy: http.ProxyFromEnvironment, }, } type requestDoer interface { Do(*http.Request) (*http.Response, error) } var glanceUserAgentString = "Glance/" + buildVersion + " +https://github.com/glanceapp/glance" var userAgentPersistentVersion atomic.Int32 func getBrowserUserAgentHeader() string { if rand.IntN(2000) == 0 { userAgentPersistentVersion.Store(rand.Int32N(5)) } version := strconv.Itoa(130 + int(userAgentPersistentVersion.Load())) return "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:" + version + ".0) Gecko/20100101 Firefox/" + version + ".0" } func setBrowserUserAgentHeader(request *http.Request) { request.Header.Set("User-Agent", getBrowserUserAgentHeader()) } func decodeJsonFromRequest[T any](client requestDoer, request *http.Request) (T, error) { var result T response, err := client.Do(request) if err != nil { return result, err } defer response.Body.Close() body, err := io.ReadAll(response.Body) if err != nil { return result, err } if response.StatusCode != http.StatusOK { truncatedBody, _ := limitStringLength(string(body), 256) return result, fmt.Errorf( "unexpected status code %d from %s, response: %s", response.StatusCode, request.URL, truncatedBody, ) } err = json.Unmarshal(body, &result) if err != nil { return result, err } return result, nil } func decodeJsonFromRequestTask[T any](client requestDoer) func(*http.Request) (T, error) { return func(request *http.Request) (T, error) { return decodeJsonFromRequest[T](client, request) } } // TODO: tidy up, these are a copy of the above but with a line changed func decodeXmlFromRequest[T any](client requestDoer, request *http.Request) (T, error) { var result T response, err := client.Do(request) if err != nil { return result, err } defer response.Body.Close() body, err := io.ReadAll(response.Body) if err != nil { return result, err } if response.StatusCode != http.StatusOK { truncatedBody, _ := limitStringLength(string(body), 256) return result, fmt.Errorf( "unexpected status code %d for %s, response: %s", response.StatusCode, request.URL, truncatedBody, ) } err = xml.Unmarshal(body, &result) if err != nil { return result, err } return result, nil } func decodeXmlFromRequestTask[T any](client requestDoer) func(*http.Request) (T, error) { return func(request *http.Request) (T, error) { return decodeXmlFromRequest[T](client, request) } } type workerPoolTask[I any, O any] struct { index int input I output O err error } type workerPoolJob[I any, O any] struct { data []I workers int task func(I) (O, error) ctx context.Context } const defaultNumWorkers = 10 func (job *workerPoolJob[I, O]) withWorkers(workers int) *workerPoolJob[I, O] { if workers == 0 { job.workers = defaultNumWorkers } else { job.workers = min(workers, len(job.data)) } return job } // func (job *workerPoolJob[I, O]) withContext(ctx context.Context) *workerPoolJob[I, O] { // if ctx != nil { // job.ctx = ctx // } // return job // } func newJob[I any, O any](task func(I) (O, error), data []I) *workerPoolJob[I, O] { return &workerPoolJob[I, O]{ workers: defaultNumWorkers, task: task, data: data, ctx: context.Background(), } } func workerPoolDo[I any, O any](job *workerPoolJob[I, O]) ([]O, []error, error) { results := make([]O, len(job.data)) errs := make([]error, len(job.data)) if len(job.data) == 0 { return results, errs, nil } if len(job.data) == 1 { results[0], errs[0] = job.task(job.data[0]) return results, errs, nil } tasksQueue := make(chan *workerPoolTask[I, O]) resultsQueue := make(chan *workerPoolTask[I, O]) var wg sync.WaitGroup for range job.workers { wg.Add(1) go func() { defer wg.Done() for t := range tasksQueue { t.output, t.err = job.task(t.input) resultsQueue <- t } }() } var err error go func() { loop: for i := range job.data { select { default: tasksQueue <- &workerPoolTask[I, O]{ index: i, input: job.data[i], } case <-job.ctx.Done(): err = job.ctx.Err() break loop } } close(tasksQueue) wg.Wait() close(resultsQueue) }() for task := range resultsQueue { errs[task.index] = task.err results[task.index] = task.output } return results, errs, err } ================================================ FILE: internal/glance/widget-videos.go ================================================ package glance import ( "context" "fmt" "html/template" "log/slog" "net/http" "net/url" "sort" "strings" "time" ) const videosWidgetPlaylistPrefix = "playlist:" var ( videosWidgetTemplate = mustParseTemplate("videos.html", "widget-base.html", "video-card-contents.html") videosWidgetGridTemplate = mustParseTemplate("videos-grid.html", "widget-base.html", "video-card-contents.html") videosWidgetVerticalListTemplate = mustParseTemplate("videos-vertical-list.html", "widget-base.html") ) type videosWidget struct { widgetBase `yaml:",inline"` Videos videoList `yaml:"-"` VideoUrlTemplate string `yaml:"video-url-template"` Style string `yaml:"style"` CollapseAfter int `yaml:"collapse-after"` CollapseAfterRows int `yaml:"collapse-after-rows"` Channels []string `yaml:"channels"` Playlists []string `yaml:"playlists"` Limit int `yaml:"limit"` IncludeShorts bool `yaml:"include-shorts"` } func (widget *videosWidget) initialize() error { widget.withTitle("Videos").withCacheDuration(time.Hour) if widget.Limit <= 0 { widget.Limit = 25 } if widget.CollapseAfterRows == 0 || widget.CollapseAfterRows < -1 { widget.CollapseAfterRows = 4 } if widget.CollapseAfter == 0 || widget.CollapseAfter < -1 { widget.CollapseAfter = 7 } // A bit cheeky, but from a user's perspective it makes more sense when channels and // playlists are separate things rather than specifying a list of channels and some of // them awkwardly have a "playlist:" prefix if len(widget.Playlists) > 0 { initialLen := len(widget.Channels) widget.Channels = append(widget.Channels, make([]string, len(widget.Playlists))...) for i := range widget.Playlists { widget.Channels[initialLen+i] = videosWidgetPlaylistPrefix + widget.Playlists[i] } } return nil } func (widget *videosWidget) update(ctx context.Context) { videos, err := fetchYoutubeChannelUploads(widget.Channels, widget.VideoUrlTemplate, widget.IncludeShorts) if !widget.canContinueUpdateAfterHandlingErr(err) { return } if len(videos) > widget.Limit { videos = videos[:widget.Limit] } widget.Videos = videos } func (widget *videosWidget) Render() template.HTML { var template *template.Template switch widget.Style { case "grid-cards": template = videosWidgetGridTemplate case "vertical-list": template = videosWidgetVerticalListTemplate default: template = videosWidgetTemplate } return widget.renderTemplate(widget, template) } type youtubeFeedResponseXml struct { Channel string `xml:"author>name"` ChannelLink string `xml:"author>uri"` Videos []struct { Title string `xml:"title"` Published string `xml:"published"` Link struct { Href string `xml:"href,attr"` } `xml:"link"` Group struct { Thumbnail struct { Url string `xml:"url,attr"` } `xml:"http://search.yahoo.com/mrss/ thumbnail"` } `xml:"http://search.yahoo.com/mrss/ group"` } `xml:"entry"` } func parseYoutubeFeedTime(t string) time.Time { parsedTime, err := time.Parse("2006-01-02T15:04:05-07:00", t) if err != nil { return time.Now() } return parsedTime } type video struct { ThumbnailUrl string Title string Url string Author string AuthorUrl string TimePosted time.Time } type videoList []video func (v videoList) sortByNewest() videoList { sort.Slice(v, func(i, j int) bool { return v[i].TimePosted.After(v[j].TimePosted) }) return v } func fetchYoutubeChannelUploads(channelOrPlaylistIDs []string, videoUrlTemplate string, includeShorts bool) (videoList, error) { requests := make([]*http.Request, 0, len(channelOrPlaylistIDs)) for i := range channelOrPlaylistIDs { var feedUrl string if strings.HasPrefix(channelOrPlaylistIDs[i], videosWidgetPlaylistPrefix) { feedUrl = "https://www.youtube.com/feeds/videos.xml?playlist_id=" + strings.TrimPrefix(channelOrPlaylistIDs[i], videosWidgetPlaylistPrefix) } else if !includeShorts && strings.HasPrefix(channelOrPlaylistIDs[i], "UC") { playlistId := strings.Replace(channelOrPlaylistIDs[i], "UC", "UULF", 1) feedUrl = "https://www.youtube.com/feeds/videos.xml?playlist_id=" + playlistId } else { feedUrl = "https://www.youtube.com/feeds/videos.xml?channel_id=" + channelOrPlaylistIDs[i] } request, _ := http.NewRequest("GET", feedUrl, nil) requests = append(requests, request) } job := newJob(decodeXmlFromRequestTask[youtubeFeedResponseXml](defaultHTTPClient), requests).withWorkers(30) responses, errs, err := workerPoolDo(job) if err != nil { return nil, fmt.Errorf("%w: %v", errNoContent, err) } videos := make(videoList, 0, len(channelOrPlaylistIDs)*15) var failed int for i := range responses { if errs[i] != nil { failed++ slog.Error("Failed to fetch youtube feed", "channel", channelOrPlaylistIDs[i], "error", errs[i]) continue } response := responses[i] for j := range response.Videos { v := &response.Videos[j] var videoUrl string if videoUrlTemplate == "" { videoUrl = v.Link.Href } else { parsedUrl, err := url.Parse(v.Link.Href) if err == nil { videoUrl = strings.ReplaceAll(videoUrlTemplate, "{VIDEO-ID}", parsedUrl.Query().Get("v")) } else { videoUrl = "#" } } videos = append(videos, video{ ThumbnailUrl: v.Group.Thumbnail.Url, Title: v.Title, Url: videoUrl, Author: response.Channel, AuthorUrl: response.ChannelLink + "/videos", TimePosted: parseYoutubeFeedTime(v.Published), }) } } if len(videos) == 0 { return nil, errNoContent } videos.sortByNewest() if failed > 0 { return videos, fmt.Errorf("%w: missing videos from %d channels", errPartialContent, failed) } return videos, nil } ================================================ FILE: internal/glance/widget-weather.go ================================================ package glance import ( "context" "errors" "fmt" "html/template" "math" "net/http" "net/url" "slices" "strings" "time" _ "time/tzdata" ) var weatherWidgetTemplate = mustParseTemplate("weather.html", "widget-base.html") type weatherWidget struct { widgetBase `yaml:",inline"` Location string `yaml:"location"` ShowAreaName bool `yaml:"show-area-name"` HideLocation bool `yaml:"hide-location"` HourFormat string `yaml:"hour-format"` Units string `yaml:"units"` Place *openMeteoPlaceResponseJson `yaml:"-"` Weather *weather `yaml:"-"` TimeLabels [12]string `yaml:"-"` } var timeLabels12h = [12]string{"2am", "4am", "6am", "8am", "10am", "12pm", "2pm", "4pm", "6pm", "8pm", "10pm", "12am"} var timeLabels24h = [12]string{"02:00", "04:00", "06:00", "08:00", "10:00", "12:00", "14:00", "16:00", "18:00", "20:00", "22:00", "00:00"} func (widget *weatherWidget) initialize() error { widget.withTitle("Weather").withCacheOnTheHour() if widget.Location == "" { return fmt.Errorf("location is required") } if widget.HourFormat == "" || widget.HourFormat == "12h" { widget.TimeLabels = timeLabels12h } else if widget.HourFormat == "24h" { widget.TimeLabels = timeLabels24h } else { return errors.New("hour-format must be either 12h or 24h") } if widget.Units == "" { widget.Units = "metric" } else if widget.Units != "metric" && widget.Units != "imperial" { return errors.New("units must be either metric or imperial") } return nil } func (widget *weatherWidget) update(ctx context.Context) { if widget.Place == nil { place, err := fetchOpenMeteoPlaceFromName(widget.Location) if err != nil { widget.withError(err).scheduleEarlyUpdate() return } widget.Place = place } weather, err := fetchWeatherForOpenMeteoPlace(widget.Place, widget.Units) if !widget.canContinueUpdateAfterHandlingErr(err) { return } widget.Weather = weather } func (widget *weatherWidget) Render() template.HTML { return widget.renderTemplate(widget, weatherWidgetTemplate) } type weather struct { Temperature int ApparentTemperature int WeatherCode int CurrentColumn int SunriseColumn int SunsetColumn int Columns []weatherColumn } func (w *weather) WeatherCodeAsString() string { if weatherCode, ok := weatherCodeTable[w.WeatherCode]; ok { return weatherCode } return "" } type openMeteoPlacesResponseJson struct { Results []openMeteoPlaceResponseJson } type openMeteoPlaceResponseJson struct { Name string Area string `json:"admin1"` Latitude float64 Longitude float64 Timezone string Country string location *time.Location } type openMeteoWeatherResponseJson struct { Daily struct { Sunrise []int64 `json:"sunrise"` Sunset []int64 `json:"sunset"` } `json:"daily"` Hourly struct { Temperature []float64 `json:"temperature_2m"` PrecipitationProbability []int `json:"precipitation_probability"` } `json:"hourly"` Current struct { Temperature float64 `json:"temperature_2m"` ApparentTemperature float64 `json:"apparent_temperature"` WeatherCode int `json:"weather_code"` } `json:"current"` } type weatherColumn struct { Temperature int Scale float64 HasPrecipitation bool } var commonCountryAbbreviations = map[string]string{ "US": "United States", "USA": "United States", "UK": "United Kingdom", } func expandCountryAbbreviations(name string) string { if expanded, ok := commonCountryAbbreviations[strings.TrimSpace(name)]; ok { return expanded } return name } // Separates the location that Open Meteo accepts from the administrative area // which can then be used to filter to the correct place after the list of places // has been retrieved. Also expands abbreviations since Open Meteo does not accept // country names like "US", "USA" and "UK" func parsePlaceName(name string) (string, string) { parts := strings.Split(name, ",") if len(parts) == 1 { return name, "" } if len(parts) == 2 { return parts[0] + ", " + expandCountryAbbreviations(parts[1]), "" } return parts[0] + ", " + expandCountryAbbreviations(parts[2]), strings.TrimSpace(parts[1]) } func fetchOpenMeteoPlaceFromName(location string) (*openMeteoPlaceResponseJson, error) { location, area := parsePlaceName(location) requestUrl := fmt.Sprintf("https://geocoding-api.open-meteo.com/v1/search?name=%s&count=20&language=en&format=json", url.QueryEscape(location)) request, _ := http.NewRequest("GET", requestUrl, nil) responseJson, err := decodeJsonFromRequest[openMeteoPlacesResponseJson](defaultHTTPClient, request) if err != nil { return nil, fmt.Errorf("fetching places data: %v", err) } if len(responseJson.Results) == 0 { return nil, fmt.Errorf("no places found for %s", location) } var place *openMeteoPlaceResponseJson if area != "" { area = strings.ToLower(area) for i := range responseJson.Results { if strings.ToLower(responseJson.Results[i].Area) == area { place = &responseJson.Results[i] break } } if place == nil { return nil, fmt.Errorf("no place found for %s in %s", location, area) } } else { place = &responseJson.Results[0] } loc, err := time.LoadLocation(place.Timezone) if err != nil { return nil, fmt.Errorf("loading location: %v", err) } place.location = loc return place, nil } func fetchWeatherForOpenMeteoPlace(place *openMeteoPlaceResponseJson, units string) (*weather, error) { query := url.Values{} var temperatureUnit string if units == "imperial" { temperatureUnit = "fahrenheit" } else { temperatureUnit = "celsius" } query.Add("latitude", fmt.Sprintf("%f", place.Latitude)) query.Add("longitude", fmt.Sprintf("%f", place.Longitude)) query.Add("timeformat", "unixtime") query.Add("timezone", place.Timezone) query.Add("forecast_days", "1") query.Add("current", "temperature_2m,apparent_temperature,weather_code") query.Add("hourly", "temperature_2m,precipitation_probability") query.Add("daily", "sunrise,sunset") query.Add("temperature_unit", temperatureUnit) requestUrl := "https://api.open-meteo.com/v1/forecast?" + query.Encode() request, _ := http.NewRequest("GET", requestUrl, nil) responseJson, err := decodeJsonFromRequest[openMeteoWeatherResponseJson](defaultHTTPClient, request) if err != nil { return nil, fmt.Errorf("%w: %v", errNoContent, err) } now := time.Now().In(place.location) bars := make([]weatherColumn, 0, 24) currentBar := now.Hour() / 2 sunriseBar := (time.Unix(int64(responseJson.Daily.Sunrise[0]), 0).In(place.location).Hour()) / 2 sunsetBar := (time.Unix(int64(responseJson.Daily.Sunset[0]), 0).In(place.location).Hour() - 1) / 2 if sunsetBar < 0 { sunsetBar = 0 } if len(responseJson.Hourly.Temperature) == 24 { temperatures := make([]int, 12) precipitations := make([]bool, 12) t := responseJson.Hourly.Temperature p := responseJson.Hourly.PrecipitationProbability for i := 0; i < 24; i += 2 { if i/2 == currentBar { temperatures[i/2] = int(responseJson.Current.Temperature) } else { temperatures[i/2] = int(math.Round((t[i] + t[i+1]) / 2)) } precipitations[i/2] = (p[i]+p[i+1])/2 > 75 } minT := slices.Min(temperatures) maxT := slices.Max(temperatures) temperaturesRange := float64(maxT - minT) for i := 0; i < 12; i++ { bars = append(bars, weatherColumn{ Temperature: temperatures[i], HasPrecipitation: precipitations[i], }) if temperaturesRange > 0 { bars[i].Scale = float64(temperatures[i]-minT) / temperaturesRange } else { bars[i].Scale = 1 } } } return &weather{ Temperature: int(responseJson.Current.Temperature), ApparentTemperature: int(responseJson.Current.ApparentTemperature), WeatherCode: responseJson.Current.WeatherCode, CurrentColumn: currentBar, SunriseColumn: sunriseBar, SunsetColumn: sunsetBar, Columns: bars, }, nil } var weatherCodeTable = map[int]string{ 0: "Clear Sky", 1: "Mainly Clear", 2: "Partly Cloudy", 3: "Overcast", 45: "Fog", 48: "Rime Fog", 51: "Drizzle", 53: "Drizzle", 55: "Drizzle", 56: "Drizzle", 57: "Drizzle", 61: "Rain", 63: "Moderate Rain", 65: "Heavy Rain", 66: "Freezing Rain", 67: "Freezing Rain", 71: "Snow", 73: "Moderate Snow", 75: "Heavy Snow", 77: "Snow Grains", 80: "Rain", 81: "Moderate Rain", 82: "Heavy Rain", 85: "Snow", 86: "Snow", 95: "Thunderstorm", 96: "Thunderstorm", 99: "Thunderstorm", } ================================================ FILE: internal/glance/widget.go ================================================ package glance import ( "bytes" "context" "errors" "fmt" "html/template" "log/slog" "math" "net/http" "sync/atomic" "time" "gopkg.in/yaml.v3" ) var widgetIDCounter atomic.Uint64 func newWidget(widgetType string) (widget, error) { if widgetType == "" { return nil, errors.New("widget 'type' property is empty or not specified") } var w widget switch widgetType { case "calendar": w = &calendarWidget{} case "calendar-legacy": w = &oldCalendarWidget{} case "clock": w = &clockWidget{} case "weather": w = &weatherWidget{} case "bookmarks": w = &bookmarksWidget{} case "iframe": w = &iframeWidget{} case "html": w = &htmlWidget{} case "hacker-news": w = &hackerNewsWidget{} case "releases": w = &releasesWidget{} case "videos": w = &videosWidget{} case "markets", "stocks": w = &marketsWidget{} case "reddit": w = &redditWidget{} case "rss": w = &rssWidget{} case "monitor": w = &monitorWidget{} case "twitch-top-games": w = &twitchGamesWidget{} case "twitch-channels": w = &twitchChannelsWidget{} case "lobsters": w = &lobstersWidget{} case "change-detection": w = &changeDetectionWidget{} case "repository": w = &repositoryWidget{} case "search": w = &searchWidget{} case "extension": w = &extensionWidget{} case "group": w = &groupWidget{} case "dns-stats": w = &dnsStatsWidget{} case "split-column": w = &splitColumnWidget{} case "custom-api": w = &customAPIWidget{} case "docker-containers": w = &dockerContainersWidget{} case "server-stats": w = &serverStatsWidget{} case "to-do": w = &todoWidget{} default: return nil, fmt.Errorf("unknown widget type: %s", widgetType) } w.setID(widgetIDCounter.Add(1)) return w, nil } type widgets []widget func (w *widgets) UnmarshalYAML(node *yaml.Node) error { var nodes []yaml.Node if err := node.Decode(&nodes); err != nil { return err } for _, node := range nodes { meta := struct { Type string `yaml:"type"` }{} if err := node.Decode(&meta); err != nil { return err } widget, err := newWidget(meta.Type) if err != nil { return fmt.Errorf("line %d: %w", node.Line, err) } if err = node.Decode(widget); err != nil { return err } *w = append(*w, widget) } return nil } type widget interface { // These need to be exported because they get called in templates Render() template.HTML GetType() string GetID() uint64 initialize() error requiresUpdate(*time.Time) bool setProviders(*widgetProviders) update(context.Context) setID(uint64) handleRequest(w http.ResponseWriter, r *http.Request) setHideHeader(bool) } type cacheType int const ( cacheTypeInfinite cacheType = iota cacheTypeDuration cacheTypeOnTheHour ) type widgetBase struct { ID uint64 `yaml:"-"` Providers *widgetProviders `yaml:"-"` Type string `yaml:"type"` Title string `yaml:"title"` TitleURL string `yaml:"title-url"` HideHeader bool `yaml:"hide-header"` CSSClass string `yaml:"css-class"` CustomCacheDuration durationField `yaml:"cache"` ContentAvailable bool `yaml:"-"` WIP bool `yaml:"-"` Error error `yaml:"-"` Notice error `yaml:"-"` templateBuffer bytes.Buffer `yaml:"-"` cacheDuration time.Duration `yaml:"-"` cacheType cacheType `yaml:"-"` nextUpdate time.Time `yaml:"-"` updateRetriedTimes int `yaml:"-"` } type widgetProviders struct { assetResolver func(string) string } func (w *widgetBase) requiresUpdate(now *time.Time) bool { if w.cacheType == cacheTypeInfinite { return false } if w.nextUpdate.IsZero() { return true } return now.After(w.nextUpdate) } func (w *widgetBase) IsWIP() bool { return w.WIP } func (w *widgetBase) update(ctx context.Context) { } func (w *widgetBase) GetID() uint64 { return w.ID } func (w *widgetBase) setID(id uint64) { w.ID = id } func (w *widgetBase) setHideHeader(value bool) { w.HideHeader = value } func (widget *widgetBase) handleRequest(w http.ResponseWriter, r *http.Request) { http.Error(w, "not implemented", http.StatusNotImplemented) } func (w *widgetBase) GetType() string { return w.Type } func (w *widgetBase) setProviders(providers *widgetProviders) { w.Providers = providers } func (w *widgetBase) renderTemplate(data any, t *template.Template) template.HTML { w.templateBuffer.Reset() err := t.Execute(&w.templateBuffer, data) if err != nil { w.ContentAvailable = false w.Error = err slog.Error("Failed to render template", "error", err) // need to immediately re-render with the error, // otherwise risk breaking the page since the widget // will likely be partially rendered with tags not closed. w.templateBuffer.Reset() err2 := t.Execute(&w.templateBuffer, data) if err2 != nil { slog.Error("Failed to render error within widget", "error", err2, "initial_error", err) w.templateBuffer.Reset() // TODO: add some kind of a generic widget error template when the widget // failed to render, and we also failed to re-render the widget with the error } } return template.HTML(w.templateBuffer.String()) } func (w *widgetBase) withTitle(title string) *widgetBase { if w.Title == "" { w.Title = title } return w } func (w *widgetBase) withTitleURL(titleURL string) *widgetBase { if w.TitleURL == "" { w.TitleURL = titleURL } return w } func (w *widgetBase) withCacheDuration(duration time.Duration) *widgetBase { w.cacheType = cacheTypeDuration if duration == -1 || w.CustomCacheDuration == 0 { w.cacheDuration = duration } else { w.cacheDuration = time.Duration(w.CustomCacheDuration) } return w } func (w *widgetBase) withCacheOnTheHour() *widgetBase { w.cacheType = cacheTypeOnTheHour return w } func (w *widgetBase) withNotice(err error) *widgetBase { w.Notice = err return w } func (w *widgetBase) withError(err error) *widgetBase { if err == nil && !w.ContentAvailable { w.ContentAvailable = true } w.Error = err return w } func (w *widgetBase) canContinueUpdateAfterHandlingErr(err error) bool { // TODO: needs covering more edge cases. // if there's partial content and we update early there's a chance // the early update returns even less content than the initial update. // need some kind of mechanism that tells us whether we should update early // or not depending on the number of things that failed during the initial // and subsequent update and how they failed - ie whether it was server // error (like gateway timeout, do retry early) or client error (like // hitting a rate limit, don't retry early). will require reworking a // good amount of code in the feed package and probably having a custom // error type that holds more information because screw wrapping errors. // alternatively have a resource cache and only refetch the failed resources, // then rebuild the widget. if err != nil { w.scheduleEarlyUpdate() if !errors.Is(err, errPartialContent) { w.withError(err) w.withNotice(nil) return false } w.withError(nil) w.withNotice(err) return true } w.withNotice(nil) w.withError(nil) w.scheduleNextUpdate() return true } func (w *widgetBase) getNextUpdateTime() time.Time { now := time.Now() if w.cacheType == cacheTypeDuration { return now.Add(w.cacheDuration) } if w.cacheType == cacheTypeOnTheHour { return now.Add(time.Duration( ((60-now.Minute())*60)-now.Second(), ) * time.Second) } return time.Time{} } func (w *widgetBase) scheduleNextUpdate() *widgetBase { w.nextUpdate = w.getNextUpdateTime() w.updateRetriedTimes = 0 return w } func (w *widgetBase) scheduleEarlyUpdate() *widgetBase { w.updateRetriedTimes++ if w.updateRetriedTimes > 5 { w.updateRetriedTimes = 5 } nextEarlyUpdate := time.Now().Add(time.Duration(math.Pow(float64(w.updateRetriedTimes), 2)) * time.Minute) nextUsualUpdate := w.getNextUpdateTime() if nextEarlyUpdate.After(nextUsualUpdate) { w.nextUpdate = nextUsualUpdate } else { w.nextUpdate = nextEarlyUpdate } return w } ================================================ FILE: main.go ================================================ package main import ( "os" "github.com/glanceapp/glance/internal/glance" ) func main() { os.Exit(glance.Main()) } ================================================ FILE: pkg/sysinfo/sysinfo.go ================================================ package sysinfo import ( "fmt" "math" "os" "runtime" "sort" "strconv" "time" "github.com/shirou/gopsutil/v4/cpu" "github.com/shirou/gopsutil/v4/disk" "github.com/shirou/gopsutil/v4/host" "github.com/shirou/gopsutil/v4/load" "github.com/shirou/gopsutil/v4/mem" "github.com/shirou/gopsutil/v4/sensors" ) type timestampJSON struct { time.Time } func (t timestampJSON) MarshalJSON() ([]byte, error) { return []byte(strconv.FormatInt(t.Unix(), 10)), nil } func (t *timestampJSON) UnmarshalJSON(data []byte) error { i, err := strconv.ParseInt(string(data), 10, 64) if err != nil { return err } t.Time = time.Unix(i, 0) return nil } type SystemInfo struct { HostInfoIsAvailable bool `json:"host_info_is_available"` BootTime timestampJSON `json:"boot_time"` Hostname string `json:"hostname"` Platform string `json:"platform"` CPU struct { LoadIsAvailable bool `json:"load_is_available"` Load1Percent uint8 `json:"load1_percent"` Load15Percent uint8 `json:"load15_percent"` TemperatureIsAvailable bool `json:"temperature_is_available"` TemperatureC uint8 `json:"temperature_c"` } `json:"cpu"` Memory struct { IsAvailable bool `json:"memory_is_available"` TotalMB uint64 `json:"total_mb"` UsedMB uint64 `json:"used_mb"` UsedPercent uint8 `json:"used_percent"` SwapIsAvailable bool `json:"swap_is_available"` SwapTotalMB uint64 `json:"swap_total_mb"` SwapUsedMB uint64 `json:"swap_used_mb"` SwapUsedPercent uint8 `json:"swap_used_percent"` } `json:"memory"` Mountpoints []MountpointInfo `json:"mountpoints"` } type MountpointInfo struct { Path string `json:"path"` Name string `json:"name"` TotalMB uint64 `json:"total_mb"` UsedMB uint64 `json:"used_mb"` UsedPercent uint8 `json:"used_percent"` } type SystemInfoRequest struct { CPUTempSensor string `yaml:"cpu-temp-sensor"` HideMountpointsByDefault bool `yaml:"hide-mountpoints-by-default"` Mountpoints map[string]MointpointRequest `yaml:"mountpoints"` } type MointpointRequest struct { Name string `yaml:"name"` Hide *bool `yaml:"hide"` } // Currently caches hostname indefinitely which isn't ideal // Potential issue with caching boot time as it may not initially get reported correctly: // https://github.com/shirou/gopsutil/issues/842#issuecomment-1908972344 type cacheableHostInfo struct { available bool hostname string platform string bootTime timestampJSON } var cachedHostInfo cacheableHostInfo func getHostInfo() (cacheableHostInfo, error) { var err error info := cacheableHostInfo{} info.hostname, err = os.Hostname() if err != nil { return info, err } info.platform, _, _, err = host.PlatformInformation() if err != nil { return info, err } bootTime, err := host.BootTime() if err != nil { return info, err } info.bootTime = timestampJSON{time.Unix(int64(bootTime), 0)} info.available = true return info, nil } func Collect(req *SystemInfoRequest) (*SystemInfo, []error) { if req == nil { req = &SystemInfoRequest{} } var errs []error addErr := func(err error) { errs = append(errs, err) } info := &SystemInfo{ Mountpoints: []MountpointInfo{}, } applyCachedHostInfo := func() { info.HostInfoIsAvailable = true info.BootTime = cachedHostInfo.bootTime info.Hostname = cachedHostInfo.hostname info.Platform = cachedHostInfo.platform } if cachedHostInfo.available { applyCachedHostInfo() } else { hostInfo, err := getHostInfo() if err == nil { cachedHostInfo = hostInfo applyCachedHostInfo() } else { addErr(fmt.Errorf("getting host info: %v", err)) } } coreCount, err := cpu.Counts(true) if err == nil { loadAvg, err := load.Avg() if err == nil { info.CPU.LoadIsAvailable = true if runtime.GOOS == "windows" { // The numbers returned here seem unreliable on Windows. Even with the CPU pegged // at close to 50% for multiple minutes, load1 is sometimes way under or way over // with no clear pattern. Dividing by core count gives numbers that are way too // low so that's likely not necessary as it is with unix. info.CPU.Load1Percent = uint8(math.Min(loadAvg.Load1*100, 100)) info.CPU.Load15Percent = uint8(math.Min(loadAvg.Load15*100, 100)) } else { info.CPU.Load1Percent = uint8(math.Min((loadAvg.Load1/float64(coreCount))*100, 100)) info.CPU.Load15Percent = uint8(math.Min((loadAvg.Load15/float64(coreCount))*100, 100)) } } else { addErr(fmt.Errorf("getting load avg: %v", err)) } } else { addErr(fmt.Errorf("getting core count: %v", err)) } memory, err := mem.VirtualMemory() if err == nil { info.Memory.IsAvailable = true info.Memory.TotalMB = memory.Total / 1024 / 1024 info.Memory.UsedMB = memory.Used / 1024 / 1024 info.Memory.UsedPercent = uint8(math.Min(memory.UsedPercent, 100)) } else { addErr(fmt.Errorf("getting memory info: %v", err)) } swapMemory, err := mem.SwapMemory() if err == nil { info.Memory.SwapIsAvailable = true info.Memory.SwapTotalMB = swapMemory.Total / 1024 / 1024 info.Memory.SwapUsedMB = swapMemory.Used / 1024 / 1024 info.Memory.SwapUsedPercent = uint8(math.Min(swapMemory.UsedPercent, 100)) } else { addErr(fmt.Errorf("getting swap memory info: %v", err)) } // currently disabled on Windows because it requires elevated privilidges, otherwise // keeps returning a single sensor with key "ACPI\\ThermalZone\\TZ00_0" which // doesn't seem to be the CPU sensor or correspond to anything useful when // compared against the temperatures Libre Hardware Monitor reports. // Also disabled on the bsd's because it's not implemented by go-psutil for them if runtime.GOOS != "windows" && runtime.GOOS != "openbsd" && runtime.GOOS != "netbsd" && runtime.GOOS != "freebsd" { sensorReadings, err := sensors.SensorsTemperatures() _, errIsWarning := err.(*sensors.Warnings) if err == nil || errIsWarning { if req.CPUTempSensor != "" { for i := range sensorReadings { if sensorReadings[i].SensorKey == req.CPUTempSensor { info.CPU.TemperatureIsAvailable = true info.CPU.TemperatureC = uint8(sensorReadings[i].Temperature) break } } if !info.CPU.TemperatureIsAvailable { addErr(fmt.Errorf("CPU temperature sensor %s not found", req.CPUTempSensor)) } } else if cpuTempSensor := inferCPUTempSensor(sensorReadings); cpuTempSensor != nil { info.CPU.TemperatureIsAvailable = true info.CPU.TemperatureC = uint8(cpuTempSensor.Temperature) } } else { addErr(fmt.Errorf("getting sensor readings: %v", err)) } } addedMountpoints := map[string]struct{}{} addMountpointInfo := func(requestedPath string, mpReq MointpointRequest) { if _, exists := addedMountpoints[requestedPath]; exists { return } isHidden := req.HideMountpointsByDefault if mpReq.Hide != nil { isHidden = *mpReq.Hide } if isHidden { return } usage, err := disk.Usage(requestedPath) if err == nil { mpInfo := MountpointInfo{ Path: requestedPath, Name: mpReq.Name, TotalMB: usage.Total / 1024 / 1024, UsedMB: usage.Used / 1024 / 1024, UsedPercent: uint8(math.Min(usage.UsedPercent, 100)), } info.Mountpoints = append(info.Mountpoints, mpInfo) addedMountpoints[requestedPath] = struct{}{} } else { addErr(fmt.Errorf("getting filesystem usage for %s: %v", requestedPath, err)) } } if !req.HideMountpointsByDefault { filesystems, err := disk.Partitions(false) if err == nil { for _, fs := range filesystems { addMountpointInfo(fs.Mountpoint, req.Mountpoints[fs.Mountpoint]) } } else { addErr(fmt.Errorf("getting filesystems: %v", err)) } } for mountpoint, mpReq := range req.Mountpoints { addMountpointInfo(mountpoint, mpReq) } sort.Slice(info.Mountpoints, func(a, b int) bool { return info.Mountpoints[a].UsedPercent > info.Mountpoints[b].UsedPercent }) return info, errs } func inferCPUTempSensor(sensors []sensors.TemperatureStat) *sensors.TemperatureStat { for i := range sensors { switch sensors[i].SensorKey { case "coretemp_package_id_0", // intel / linux "coretemp", // intel / linux "k10temp", // amd / linux "zenpower", // amd / linux "cpu_thermal": // raspberry pi / linux return &sensors[i] } } return nil }