How to Use GIST_ID and CONFIG_FILES

GIST_ID

• Set this to the ID of a public GitHub Gist that contains your text-based configuration files (such as .yml, .css, .js, etc.).
• The app will automatically download all files in /app/config.

CONFIG_FILES

• Use this as an alternative to GIST_ID when you want to provide direct URLs to your config files.
• Provide a comma-separated list of URLs; each file will be downloaded and stored in /app/config.

If GIST_ID is set and non-empty:

• Only the files from the Gist will be downloaded.
• The value in CONFIG_FILES will be completely ignored — no files from it will be downloaded. This ensures there's no duplication or confusion about the source of config files.

Features

Various widgets

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

Fast and lightweight

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

Tons of customizability

• Different layouts
• As many pages/tabs as you need
• Numerous configuration options for each widget
• Multiple styles for some widgets
• Custom CSS

Optimized for mobile devices

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

mobile-preview

Themeable

Easily create your own theme by tweaking a few numbers or choose from one of the already available themes.

themes-example

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.

Feature requests are tagged with one of the following:

• Roadmap - will be implemented in a future release
• Backlog - may be implemented in the future but needs further feedback or interest from the community
• 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