{"id":13454712,"url":"https://github.com/glanceapp/glance","last_synced_at":"2025-05-13T16:03:34.910Z","repository":{"id":236564348,"uuid":"792861139","full_name":"glanceapp/glance","owner":"glanceapp","description":"A self-hosted dashboard that puts all your feeds in one place","archived":false,"fork":false,"pushed_at":"2025-04-29T20:05:25.000Z","size":16892,"stargazers_count":22949,"open_issues_count":167,"forks_count":864,"subscribers_count":53,"default_branch":"main","last_synced_at":"2025-04-29T21:20:47.878Z","etag":null,"topics":["aggregator","dashboard","docker","feed-reader","go","homelab","homepage","monitoring","reddit","rss","rss-reader","self-hosted","startpage","youtube"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/glanceapp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["glanceapp"]}},"created_at":"2024-04-27T18:55:38.000Z","updated_at":"2025-04-29T19:37:25.000Z","dependencies_parsed_at":"2024-05-17T12:34:25.695Z","dependency_job_id":"4508d1be-bdd6-4202-9487-bdccf5e47a79","html_url":"https://github.com/glanceapp/glance","commit_stats":null,"previous_names":["glanceapp/glance"],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glanceapp%2Fglance","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glanceapp%2Fglance/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glanceapp%2Fglance/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/glanceapp%2Fglance/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/glanceapp","download_url":"https://codeload.github.com/glanceapp/glance/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252590374,"owners_count":21772934,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aggregator","dashboard","docker","feed-reader","go","homelab","homepage","monitoring","reddit","rss","rss-reader","self-hosted","startpage","youtube"],"created_at":"2024-07-31T08:00:57.215Z","updated_at":"2025-05-05T22:45:09.429Z","avatar_url":"https://github.com/glanceapp.png","language":"Go","readme":"\u003cp align=\"center\"\u003e\u003cem\u003eWhat if you could see everything at a...\u003c/em\u003e\u003c/p\u003e\n\u003ch1 align=\"center\"\u003eGlance\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\u003ca href=\"#installation\"\u003eInstall\u003c/a\u003e • \u003ca href=\"docs/configuration.md\"\u003eConfiguration\u003c/a\u003e • \u003ca href=\"https://discord.com/invite/7KQ7Xa9kJd\"\u003eDiscord\u003c/a\u003e • \u003ca href=\"https://github.com/sponsors/glanceapp\"\u003eSponsor\u003c/a\u003e\u003c/p\u003e\n\u003cp align=\"center\"\u003e\u003ca href=\"https://github.com/glanceapp/community-widgets\"\u003eCommunity widgets\u003c/a\u003e • \u003ca href=\"docs/preconfigured-pages.md\"\u003ePreconfigured pages\u003c/a\u003e • \u003ca href=\"docs/themes.md\"\u003eThemes\u003c/a\u003e\u003c/p\u003e\n\n![](docs/images/readme-main-image.png)\n\n## Features\n### Various widgets\n* RSS feeds\n* Subreddit posts\n* Hacker News posts\n* Weather forecasts\n* YouTube channel uploads\n* Twitch channels\n* Market prices\n* Docker containers status\n* Server stats\n* Custom widgets\n* [and many more...](docs/configuration.md)\n\n### Fast and lightweight\n* Low memory usage\n* Few dependencies\n* Minimal vanilla JS\n* Single \u003c20mb binary available for multiple OSs \u0026 architectures and just as small Docker container\n* Uncached pages usually load within ~1s (depending on internet speed and number of widgets)\n\n### Tons of customizability\n* Different layouts\n* As many pages/tabs as you need\n* Numerous configuration options for each widget\n* Multiple styles for some widgets\n* Custom CSS\n\n### Optimized for mobile devices\nBecause you'll want to take it with you on the go.\n\n![](docs/images/mobile-preview.png)\n\n### Themeable\nEasily create your own theme by tweaking a few numbers or choose from one of the [already available themes](docs/themes.md).\n\n![](docs/images/themes-example.png)\n\n\u003cbr\u003e\n\n## Configuration\nConfiguration 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).\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003ePreview example configuration file\u003c/strong\u003e\u003c/summary\u003e\n\u003cbr\u003e\n\n```yaml\npages:\n  - name: Home\n    columns:\n      - size: small\n        widgets:\n          - type: calendar\n            first-day-of-week: monday\n\n          - type: rss\n            limit: 10\n            collapse-after: 3\n            cache: 12h\n            feeds:\n              - url: https://selfh.st/rss/\n                title: selfh.st\n                limit: 4\n              - url: https://ciechanow.ski/atom.xml\n              - url: https://www.joshwcomeau.com/rss.xml\n                title: Josh Comeau\n              - url: https://samwho.dev/rss.xml\n              - url: https://ishadeed.com/feed.xml\n                title: Ahmad Shadeed\n\n          - type: twitch-channels\n            channels:\n              - theprimeagen\n              - j_blow\n              - piratesoftware\n              - cohhcarnage\n              - christitustech\n              - EJ_SA\n\n      - size: full\n        widgets:\n          - type: group\n            widgets:\n              - type: hacker-news\n              - type: lobsters\n\n          - type: videos\n            channels:\n              - UCXuqSBlHAE6Xw-yeJA0Tunw # Linus Tech Tips\n              - UCR-DXc1voovS8nhAvccRZhg # Jeff Geerling\n              - UCsBjURrPoezykLs9EqgamOA # Fireship\n              - UCBJycsmduvYEL83R_U4JriQ # Marques Brownlee\n              - UCHnyfMqiRRG1u-2MsSQLbXA # Veritasium\n\n          - type: group\n            widgets:\n              - type: reddit\n                subreddit: technology\n                show-thumbnails: true\n              - type: reddit\n                subreddit: selfhosted\n                show-thumbnails: true\n\n      - size: small\n        widgets:\n          - type: weather\n            location: London, United Kingdom\n            units: metric\n            hour-format: 12h\n\n          - type: markets\n            markets:\n              - symbol: SPY\n                name: S\u0026P 500\n              - symbol: BTC-USD\n                name: Bitcoin\n              - symbol: NVDA\n                name: NVIDIA\n              - symbol: AAPL\n                name: Apple\n              - symbol: MSFT\n                name: Microsoft\n\n          - type: releases\n            cache: 1d\n            repositories:\n              - glanceapp/glance\n              - go-gitea/gitea\n              - immich-app/immich\n              - syncthing/syncthing\n```\n\u003c/details\u003e\n\n\u003cbr\u003e\n\n## Installation\n\nChoose one of the following methods:\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eDocker compose using provided directory structure (recommended)\u003c/strong\u003e\u003c/summary\u003e\n\u003cbr\u003e\n\nCreate a new directory called `glance` as well as the template files within it by running:\n\n```bash\nmkdir glance \u0026\u0026 cd glance \u0026\u0026 curl -sL https://github.com/glanceapp/docker-compose-template/archive/refs/heads/main.tar.gz | tar -xzf - --strip-components 2\n```\n\n*[click here to view the files that will be created](https://github.com/glanceapp/docker-compose-template/tree/main/root)*\n\nThen, edit the following files as desired:\n* `docker-compose.yml` to configure the port, volumes and other containery things\n* `config/home.yml` to configure the widgets or layout of the home page\n* `config/glance.yml` if you want to change the theme or add more pages\n\n\u003cdetails\u003e\n\u003csummary\u003eOther files you may want to edit\u003c/summary\u003e\n\n* `.env` to configure environment variables that will be available inside configuration files\n* `assets/user.css` to add custom CSS\n\u003c/details\u003e\n\nWhen ready, run:\n\n```bash\ndocker compose up -d\n```\n\nIf you encounter any issues, you can check the logs by running:\n\n```bash\ndocker compose logs\n```\n\n\u003chr\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eDocker compose manual\u003c/strong\u003e\u003c/summary\u003e\n\u003cbr\u003e\n\nCreate a `docker-compose.yml` file with the following contents:\n\n```yaml\nservices:\n  glance:\n    container_name: glance\n    image: glanceapp/glance\n    restart: unless-stopped\n    volumes:\n      - ./config:/app/config\n    ports:\n      - 8080:8080\n```\n\nThen, 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:\n\n```bash\nmkdir config \u0026\u0026 wget -O config/glance.yml https://raw.githubusercontent.com/glanceapp/glance/refs/heads/main/docs/glance.yml\n```\n\nFeel free to edit the `glance.yml` file to your liking, and when ready run:\n\n```bash\ndocker compose up -d\n```\n\nIf you encounter any issues, you can check the logs by running:\n\n```bash\ndocker logs glance\n```\n\n\u003chr\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eManual binary installation\u003c/strong\u003e\u003c/summary\u003e\n\u003cbr\u003e\n\nPrecompiled binaries are available for Linux, Windows and macOS (x86, x86_64, ARM and ARM64 architectures).\n\n### Linux\n\nVisit 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:\n\n```bash\n/opt/glance/glance --config /etc/glance.yml\n```\n\nTo grab a starting template for the config file, run:\n\n```bash\nwget https://raw.githubusercontent.com/glanceapp/glance/refs/heads/main/docs/glance.yml\n```\n\n### Windows\n\nDownload 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.\n\n\n\n\u003chr\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eOther\u003c/strong\u003e\u003c/summary\u003e\n\u003cbr\u003e\n\nGlance can also be installed through the following 3rd party channels:\n* [Proxmox VE Helper Script](https://community-scripts.github.io/ProxmoxVE/scripts?id=glance)\n* [NixOS package](https://search.nixos.org/packages?channel=unstable\u0026show=glance)\n* [Coolify.io](https://coolify.io/docs/services/glance/)\n\n\u003chr\u003e\n\u003c/details\u003e\n\n\u003cbr\u003e\n\n## Common issues\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eRequests timing out\u003c/strong\u003e\u003c/summary\u003e\n\nThe 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.\n\nIf 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:\n```yaml\nnetworks:\n  podman:\n    external: true\n```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eBroken layout for markets, bookmarks or other widgets\u003c/strong\u003e\u003c/summary\u003e\n\nThis is almost always caused by the browser extension Dark Reader. To fix this, disable dark mode for the domain where Glance is hosted.\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003ecannot unmarshal !!map into []glance.page\u003c/strong\u003e\u003c/summary\u003e\n\nThe 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.\n\n\u003c/details\u003e\n\n\u003cbr\u003e\n\n## FAQ\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eDoes the information on the page update automatically?\u003c/strong\u003e\u003c/summary\u003e\nNo, 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.\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eHow frequently do widgets update?\u003c/strong\u003e\u003c/summary\u003e\nNo 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.\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eCan I create my own widgets?\u003c/strong\u003e\u003c/summary\u003e\n\nYes, there are multiple ways to create custom widgets:\n* `iframe` widget - allows you to embed things from other websites\n* `html` widget - allows you to insert your own static HTML\n* `extension` widget - fetch HTML from a URL\n* `custom-api` widget - fetch JSON from a URL and render it using custom HTML\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eCan I change the title of a widget?\u003c/strong\u003e\u003c/summary\u003e\n\nYes, the title of all widgets can be changed by specifying the `title` property in the widget's configuration:\n\n```yaml\n- type: rss\n  title: My custom title\n\n- type: markets\n  title: My custom title\n\n- type: videos\n  title: My custom title\n\n# and so on for all widgets...\n```\n\u003c/details\u003e\n\n\u003cbr\u003e\n\n## Feature requests\n\nNew 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).\n\nFeature requests are tagged with one of the following:\n\n* [Roadmap](https://github.com/glanceapp/glance/labels/roadmap) - will be implemented in a future release\n* [Backlog](https://github.com/glanceapp/glance/labels/backlog) - may be implemented in the future but needs further feedback or interest from the community\n* [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\n\n\u003cbr\u003e\n\n## Building from source\n\nChoose one of the following methods:\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eBuild binary with Go\u003c/strong\u003e\u003c/summary\u003e\n\u003cbr\u003e\n\nRequirements: [Go](https://go.dev/dl/) \u003e= v1.23\n\nTo build the project for your current OS and architecture, run:\n\n```bash\ngo build -o build/glance .\n```\n\nTo build for a specific OS and architecture, run:\n\n```bash\nGOOS=linux GOARCH=amd64 go build -o build/glance .\n```\n\n[*click here for a full list of GOOS and GOARCH combinations*](https://go.dev/doc/install/source#:~:text=$GOOS%20and%20$GOARCH)\n\nAlternatively, if you just want to run the app without creating a binary, like when you're testing out changes, you can run:\n\n```bash\ngo run .\n```\n\u003chr\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eBuild project and Docker image with Docker\u003c/strong\u003e\u003c/summary\u003e\n\u003cbr\u003e\n\nRequirements: [Docker](https://docs.docker.com/engine/install/)\n\nTo build the project and image using just Docker, run:\n\n*(replace `owner` with your name or organization)*\n\n```bash\ndocker build -t owner/glance:latest .\n```\n\nIf you wish to push the image to a registry (by default Docker Hub), run:\n\n```bash\ndocker push owner/glance:latest\n```\n\n\u003chr\u003e\n\u003c/details\u003e\n\n\u003cbr\u003e\n\n## Contributing guidelines\n\n* 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\n* Please don't submit PRs for feature requests that are either in the roadmap\u003csup\u003e[1]\u003c/sup\u003e, backlog\u003csup\u003e[2]\u003c/sup\u003e or icebox\u003csup\u003e[3]\u003c/sup\u003e\n* Use `dev` for the base branch if you're adding new features or fixing bugs, otherwise use `main`\n* Avoid introducing new dependencies\n* Avoid making backwards-incompatible configuration changes\n* Avoid introducing new colors or hard-coding colors, use the standard `primary`, `positive` and `negative`\n* For icons, try to use [heroicons](https://heroicons.com/) where applicable\n* Provide a screenshot of the changes if UI related where possible\n* No `package.json`\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003e\u003csup\u003e[1] [2] [3]\u003c/sup\u003e\u003c/strong\u003e\u003c/summary\u003e\n\n[1] The feature likely already has work put into it that may conflict with your implementation\n\n[2] The demand, implementation or functionality for this feature is not yet clear\n\n[3] No plans to add this feature for the time being\n\n\u003c/details\u003e\n\n\u003cbr\u003e\n\n## Thank you\n\nTo 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.\n","funding_links":["https://github.com/sponsors/glanceapp"],"categories":["Go","Apps","置顶","Software","HarmonyOS","self-hosted","Productivity","Table of Contents"],"sub_categories":["Dashboard","9、效率工具集合","Personal Dashboards","Windows Manager","Other"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglanceapp%2Fglance","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fglanceapp%2Fglance","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fglanceapp%2Fglance/lists"}