dashworks
v2.1.2
<h1 align="center">Dashworks</h1> <p align="center"> <i>Dashworks helps you organize your self-hosted services by making them accessible from a single place</i> <br/> <img width="120" src="https://i.ibb.co/yhbt6CY/dashworks.png" /> <br/> <b><a
0/weekUpdated 1 years agoMITUnpacked: 71.8 MB
Published by KhulnaSoft DevOps
npm install dashworksDashworks
Dashworks helps you organize your self-hosted services by making them accessible from a single place
User Showcase | Live Demo | Getting Started | Documentation | GitHub
Table of Contents
- Getting Started
- ๐ Features
- โกDemo
- ๐ Getting Started
- ๐ง Configuring
- Feature Overview
- ๐จ Theming
- ๐งธ Icons
- ๐ฆ Status Indicators
- ๐ Widgets
- ๐ Authentication
- ๐ Alternate Views
- ๐ฑ๏ธ Opening Methods
- ๐ Searching and Shortcuts
- โ๏ธ Config Editor
- โ Cloud Backup & Sync
- ๐ Language Switching
- ๐ Multi-Page Support
- Community
- ๐ System Requirements
- ๐โโ๏ธ Support
- ๐ Supporting Dashworks
- ๐ Credits
- ๐งฑ Developing
- ๐๏ธ Release Schedule
- ๐ Documentation
- ๐ฃ๏ธ Roadmap
- ๐ Alternatives
- ๐ License
Features ๐
- ๐ Support for multiple pages
- ๐ฆ Real-time status monitoring for each of your apps/links
- ๐ Use widgets to display info and dynamic content from self-hosted services
- ๐ Instant search by name, domain, or tags + customizable hotkeys & keyboard shortcuts
- ๐จ Many built-in color themes, with UI color editor and support for custom CSS
- ๐งธ Many icon options - Font-Awesome, homelab icons, auto-fetching Favicon, images, emojis, etc.
- ๐ Optional authentication with multi-user access, configurable privileges, and SSO support
- ๐ Multi-language support, with 10+ human-translated languages, and more on the way
- โ Optional, encrypted, free off-site cloud backup and restore feature available
- ๐ผ A workspace view, for easily switching between multiple apps simultaneously
- ๐ฉ๏ธ A minimal view, for use as a fast-loading browser Startpage
- ๐ฑ๏ธ Choose app launch methods: new tab, same tab, clipboard, pop-up modal, or open in workspace view
- ๐ Customizable layout, sizes, text, component visibility, sort order, behavior, etc.
- ๐ผ๏ธ Options for a full-screen background image, custom nav-bar links, HTML footer, title, etc.
- ๐ Easy to setup with Docker, or on bare metal, or with 1-Click cloud deployment
- โ๏ธ Easy single-file YAML-based configuration, and option to configure app through the UI
- โจ Under active development with improvements and new features added regularly
- ๐ค Small bundle size, fully responsive UI, and PWA for basic offline access
- ๐ 100% free and open-source
- ๐ Strong focus on privacy
- ๐ And loads more...
Demo โก
Live Instances: Demo 1 (Live Demo) โ Demo 2 (Dashworks Links) โ Demo 3 (Dev Preview)
Screenshots: Checkout the Showcase, to see example dashboards from the community
Spin up your own demo:  or docker run -p 8080:80 khulnasoft/dashworks
---
Getting Started ๐
> For full setup instructions, see: Deployment
$3
You will need Docker installed on your system
``
docker run -p 8080:80 khulnasoft/dashworks
Or
`docker`
docker run -d \
-p 4000:80 \
-v /root/my-local-conf.yml:/app/public/conf.yml \
--name my-dashboard \
--restart=always \
khulnasoft/dashworks:latest
See also: examples with Docker Compose. Dashworks is also available via GHCR, and tags for other architectures (arm32v7, arm64v8, etc.) and set versions are supported
> Once you've got Dashworks running, see App Management Docs for info on using health checks, updating, backups, web-server configs, logs, performance, security, and more.
$3
You will need git, the latest or LTS version of Node.js and _(optionally)_ Yarn installed on your system.
- Clone the Repo: git clone https://github.com/KhulnaSoft/dashworks.git and cd dashworks
- Configuration: Fill in your settings in
- Install dependencies:
- Build:
- Run:
> See docs: Full list of Dashworks's commands
$3
Dashworks supports 1-Click deployments on several popular cloud platforms. To spin up a new instance, just click a link below:
- 
Deploy to Netlify
- 
Deploy to Heroku
- 
Deploy to Vercel
- 
Deploy to Render
- 
Deploy to Railway
- 
Deploy to GCP
- 
Deploy to PWD
- 
Deploy to Easypanel
> For more 1-click cloud deployments, see Cloud Deployment
---
Configuring ๐ง
> For full configuration documentation, see: Configuring
Dashworks is configured through a YAML file, located at ./public/conf.yml. In addition, you can find a complete list of available options in the Configuring Docs. The config can also be edited and saved directly through the UI.
---
Theming ๐จ
> For full theming documentation, see: Theming
Dashworks comes pre-bundled with several built-in themes, which you can preview, apply and edit through the UI. With the theme configurator and support for custom CSS, everything is in place to quickly develop your own unique-looking dashboard.
---
Icons ๐งธ
> For full iconography documentation, see: Icons
Both sections and items can have an icon associated with them, defined under the icon attribute. With several different icon packs supported, you'll be able to find the perfect thumbnail for any app or service.
The following icon types are supported:
- Favicon - Automatically fetch an apps icon from its Favicon or logo image
- Icon Packs - Use any icon from [font-awesome], [simple-icons] or [material icons]
- Emoji - Any valid emoji can be used as an icon
- Generative - Unique, auto-generated images for easily identifying services
- URL - Pass the URL of any valid image in to have it fetched and rendered
- Local - Store custom images locally and reference by filename
- Homelab Icons - Using [dashboard-icons] for logos of commonly self-hosted services
[font-awesome]: https://fontawesome.com/icons
[simple-icons]: https://simpleicons.org/
[material icons]: https://github.com/Templarian/MaterialDesign
[dashboard-icons]: https://github.com/WalkxCode/dashboard-icons
---
Status Indicators ๐ฆ
> For full monitoring documentation, see: Status Indicators
Dashworks has an optional feature to check if each app/ service is up and responding, then display a small status indicator icon. Hovering over it will show additional stats like response time and status code.
Status indicators can be globally enabled by setting appConfig.statusCheck: true or enabled/ disabled on a per-item basis. Status is checked on page load, but you can allow continuous polling by specifying a time interval between checks, in seconds under appConfig.statusCheckInterval. You can also use a different endpoint for status checking, with statusCheckUrl, and if needed, pass in custom headers under statusCheckHeaders.
---
Widgets ๐
> For full widget documentation, see: Widgets
You can display dynamic content from services in the form of widgets. There are several pre-built widgets availible for showing useful info, and integrations with commonly self-hosted services, but you can also easily create your own for almost any app.
---
Authentication ๐
> For full authentication documentation, see: Authentication
Dashworks has full support for secure single-sign-on using Keycloak for secure, easy authentication, see setup docs for a full usage guide.
There is also a basic auth feature, which doesn't require additional setup. To enable this, add an auth attribute under appConfig, containing an array of users, each with a username, SHA-256 hashed password and optional user type. Basic auth also supports several access control features, including read-only guest access and granular controls.
`yaml`
appConfig:
auth:
users:
- user: alicia
hash: 4D1E58C90B3B94BCAD9848ECCACD6D2A8C9FBC5CA913304BBA5CDEAB36FEEFA3
type: admin
Other access control systems are also supported, see the Alternative Auth Methods docs.
---
Alternate Views ๐
As well as the default homepage, there is also:
- A minimal view, valid for use as a browser start page
- A workspace view, useful for visiting many apps simultaneously
You can change the view from the UI, using the switch icon in the top-right corner, or select a default view in the config under appConfig.startingView attribute.
Example of Workspace View
Example of Minimal View
---
Opening Methods ๐ฑ๏ธ
> For full documentation on views and opening methods, see: Alternate Views
There are several different ways you can launch apps. You can specify the default opening method for any given item under the target attribute or set a site-wide default under appConfig.defaultOpeningMethod. Right-click on an item to item for all options. The following options are supported:sametab
- - The app will be launched in the current tabnewtab
- - The app will be launched in a new tab (or use Ctrl + Click)modal
- - Launch app in a resizable/ movable popup modal on the current page (or use Alt + Click)workspace
- - Changes to Workspace view and launches appclipboard
- - Copy the app's URL to your system clipboardtop
- - Opens in the top-most browsing context, useful if you're accessing Dashworks through an iframe
---
Searching and Shortcuts ๐
> For full documentation on searching, see: Searching & Shortcuts
Quickly finding and launching applications is the primary aim of Dashworks. To that end, instant search and customizable keyboard shortcuts are built-in.
To start filtering, start typingโno need to select the search bar or use any special key. Then use either the tab key or arrow keys to select and move between results, and hit enter to launch the currently selected application.
For apps that you use regularly, you can set a custom keybinding. Use the hotkey parameter on a certain item to specify a numeric key between 0 - 9. You can then launch that app by just pressing that key.
You can also add custom tags to a given item to make finding them based on keywords easier. For example, in the following example, searching for 'Movies' will show 'Plex'
`yaml`
items:
- title: Plex
hotkey: 8
icon: favicon
description: Media library
url: https://plex.lab.local
tags: [ movies, videos, music ]
To search the web directly through Dashworks, just press enter after typing your query. Options for web search are set under appConfig.webSearch. There is built-in support for 10+ search engines, or use your own custom provider or self-hosted instance. With the web search, you can also define your bangs to redirect results to any given app, website, or search engine, when the query is preceded with a certain character sequence (usually beginning in /, ! or :).
`yaml`
webSearch:
searchEngine: duckduckgo
openingMethod: newtab
searchBangs:
/r: reddit
/w: wikipedia
/s: https://whoogle.local/search?q=
':wolf': wolframalpha
':so': stackoverflow
':git': github
Hit Esc at any time to close any open apps, clear the search field, or hide any modals.
---
Config Editor โ๏ธ
> For full config documentation, see: Configuring
As well as passing in a YAML config file, you can also configure the app directly through the UI and preview changes live.
To edit any section or item, right-click on it, and select "Edit", or enter the Edit Mode (using the Pen icon in the top-right), then click any part of the page to edit. Changes will be visible immediately but will not be saved until clicking "Save to Disk" or "Save Locally".
Under the config menu, you can export, view, backup, or reset app config and edit the raw config file in a text editor with built-in schema validation. It's recommended to keep a backup of your config.
---
Cloud Backup & Sync โ
> For full backup documentation, see: Cloud Backup & Sync
Dashworks has an optional built-in feature for securely backing up your config to a hosted cloud service and then restoring it on another instance. This is useful not only for backing up your configuration off-site but also enables Dashworks to be used without having to write a YAML config file.
All data is fully E2E encrypted before being sent to the backend (done in CloudBackup.js using crypto.js 's AES method). The data is then sent to a Cloudflare worker and stored in a KV data store.
---
Language Switching ๐
> For full internationalization documentation, see: Multi-Language Support
Dashworks supports multiple languages and locales. When available, your language should be automatically detected and applied on load. But you can also select a language through the UI (under config --> Switch Language) or set appConfig.language to your language (specified as a 2-digit ISO 639-1 code), as seen below, e.g. language: de.
#### Supported Languages
- ๐ฌ๐ง English: en - _Default_ar
- ๐ฆ๐ช Arabic: - _Auto-generated_bn
- ๐ง๐ฉ Bengali: - Contributed by @soaibsafibg
- ๐ง๐ฌ Bulgarian: - Contributed by @asenovcn
- ๐จ๐ณ Chinese: - Contributed by @FormatTodaycs
- ๐จ๐ฟ Czech: - Contributed by @Tuzi555da
- ๐ฉ๐ฐ Danish: - Contributed by @lordpansarnl
- ๐ณ๐ฑ Dutch: - Contributed by @evroonfr
- ๐ซ๐ท French: - Contributed by @EVOTkde
- ๐ฉ๐ช German: - Contributed by @Niklashereel
- ๐ฌ๐ท Greek: - Contributed by @aviolarishi
- ๐ฎ๐ณ Hindi: - _Auto-generated_it
- ๐ฎ๐น Italian: - Contributed by @alexdelpreteja
- ๐ฏ๐ต Japanese: - _Auto-generated_ko
- ๐ฐ๐ท Korean: - Contributed by @boggy-csnb
- ๐ณ๐ด Norwegian Bokmรฅl: - Contributed by @rubjopl
- ๐ต๐ฑ Polish: - Contributed by @skaarj1989pt
- ๐ต๐น Portuguese: - Contributed by @LeoColmangl
- ๐ฐ๏ธ Galician: - Contributed by @pvillaverderu
- ๐ท๐บ Russian: - _Auto-generated_sk
- ๐ธ๐ฐ Slovak: - Contributed by @Smexhysl
- ๐ธ๐ฎ Slovenian: - Contributed by @UrekDes
- ๐ช๐ธ Spanish: - Contributed by @lu4tsv
- ๐ธ๐ช Swedish: - Contributed by @BOZGzh-TW
- ๐น๐ผ Traditional Chinese: - Contributed by @stanly0726tr
- ๐น๐ท Turkish: - Contributed by @imsakgpirate
- ๐ดโโ ๏ธ Pirate: - Contributed by @KhulnaSoft
#### Add your Language
I would love Dashworks to be available to everyone without language being a barrier to entry. If you've got a few minutes to spare, consider adding translations for your language. It's a quick task, and all text is in a single JSON file. Since any missing text will fall back to English, you don't need to translate it all.
---
Multi-Page Support ๐
> For full multi-page documentation, see: Pages & Sections
Within your dashboard, you can have as many sub-pages as you require. To load additional pages, specify a name, and path to a config file under pages. The config file can be either local (stored in /public), or remote (located anywhere accessible).
`yaml`
pages:
- name: Networking Services
path: 'networking.yml'
- name: Work Stuff
path: 'work.yml'
Or
`yaml`
pages:
- name: Getting Started
path: 'https://snippet.host/tvcw/raw'
- name: Homelab
path: 'https://snippet.host/tetp/raw'
- name: Browser Startpage
path: 'https://snippet.host/zcom/raw'
---
System Requirements ๐
If running on bare metal, Dashworks requires Node V 16.0.0 or later, LTS (16.13.2) is recommended.
If running in Docker container, the recommended base image is Alpine (3.15)
The hardware requirements vary depending on where and how you are running Dashworks. Generally speaking, on a bare-metal system or Docker container, 1GB of memory should be more than enough, and depending on whether you are using your own assets, then 1GB of disk space should be sufficient.
If you are using one of the 1-click cloud deployment methods, serving the app through a CDN or using a static hosting provider, then there are no specific requirements, as the built app is just a series of static JS files, and so is very light-weight.
Dashworks also wells run on low-powered ARM-based single board computers, such as a Raspberry Pi (tested on Pi 3)
Browser Support
!Chrome | !Firefox | !IE | !Opera | !Safari
--- | --- | --- | --- | --- |
Latest โ | Latest โ | 10+ โ | Latest โ | 6.1+ โ |
---
Support ๐โโ๏ธ
If you're having trouble getting Dashworks up and running, or have a question about usage or configuration, feel free to ask. The best place to do this is via the Discussions.
If you've found something which isn't working as it should, please raise a bug by opening a ticket.
It's best to check the docs, previous issues and troubleshooting guide first.
---
Supporting Dashworks ๐
> For full details and other ways you can help out, see: Contributing
If you're using Dashworks and would like to help support its development, then that would be awesome! Contributions of any type, any size, are always very much appreciated, and we will appropriately credit you for your effort.
Several areas that we need a bit of help with at the moment are:
- Translating - Help make Dashworks available to non-native English speakers by adding your language
- Donate a small amount by Sponsoring @KhulnaSoft on GitHub and receive some extra perks!
- Complete a short survey to have your say about future features
- Share your dashboard in the Showcase, to inspire others
- Spread the word by sharing Dashworks or a screenshot of your dashboard to help new users discover it
- Submit a PR to add a new feature, fix a bug, update the docs, add a theme, widget or something else
- Star Dashworks on GitHub/ DockerHub or leave an upvote / review on these platforms
Credits ๐
> For a complete list of credits, and attributions to packages used within Dashworks, see: Credits
Thank you so much to everyone who has helped with Dashworks so far; every contribution is very much appreciated.
#### Sponsors
Huge thanks to the sponsors helping to support Dashworks's development!
#### Contributors
#### Stats
---
Developing ๐งฑ
> For full development documentation, see: Developing
Before getting started, you'll need Git, Node and optionally Yarn (run npm i -g yarn) installed.
To set up the development environment:
1. Get Code: git clone https://github.com/KhulnaSoft/dashworks.git and cd dashworks
2. Install dependencies:
3. Start dev server:
4. Open the browser:
When you're ready, you can build the production app with yarn build, and then run it with yarn start
If you're new to web development, I've put together a short list of resources to help beginners get started
Repo Status:
---
Documentation ๐
> For full docs, see: Documentation Contents
#### Running Dashworks
- ๐จ Quick Start - TDLR guide on getting Dashworks up and running in under 5 minutes
- ๐ Deployment - Full guide on setting up Dashworks on various different environments
- ๐ง Configuring - Complete list of all available options in the config file
- ๐ป Management - Managing your app, updating, security, web server configuration, etc
- ๐ Troubleshooting - Common errors and problems, and how to fix them
#### Feature Docs
- ๐ก๏ธ Authentication - Guide to setting up authentication to protect your dashboard
- ๐ Alternate Views - Outline of available pages / views and item opening methods
- ๐พ Backup & Restore - Guide to backing up config with Dashworks's cloud sync feature
- ๐งธ Icons - Outline of all available icon types for sections and items, with examples
- ๐ Multi-Language Support - Switching languages, and adding a new locales
- ๐ฆ Status Indicators - Using Dashworks to monitor uptime and status of your apps
- ๐ Searching & Shortcuts - Searching, launching methods + keyboard shortcuts
- ๐จ Theming - Complete guide to applying, writing and modifying themes + styles
- ๐ Widgets - List of all dynamic content widgets, with usage guides and examples
#### Development and Contributing
- ๐งฑ Developing - Running Dashworks development server locally, and general workflow
- ๐๏ธ Development Guides - Common development tasks, to help new contributors
- ๐ Contributing - How to contribute to Dashworks
- ๐ Showcase - See how others are using Dashworks, and share your dashboard
- ๐ Credits - Shout out to the amazing people who have contributed so far
- ๐๏ธ Release Workflow - Info about releases, CI and automated tasks
#### Misc
- ๐ Privacy & Security - List of requests, potential issues, and security resources
- ๐ License - Copy of the MIT License
- โ๏ธ Legal - Licenses of direct dependencies
- ๐ Code of Conduct - Contributor Covenant Code of Conduct
- ๐ณ Changelog - Details of recent changes, and historical versions
---
Roadmap ๐ฃ๏ธ
For upcoming features that will be released in the near future, see the Current Roadmap
For past updates, see the Changelog
---
Alternatives ๐
A few self-hosted web apps serve a similar purpose to Dashworks. If you're looking for a dashboard, and Dashworks doesn't meet your needs, I highly recommend you check these projects out!
- Flame by @pawelmalak (MIT)Apache License 2.0
- HomeDash2
- Homer ()GPL-3.0 License
- Organizr ()MIT
- Heimdall ()MIT
- Smashing ()
- See more ๐ Awesome Self-Hosted
---
License ๐
Dashworks is Licensed under MIT X11
`
Copyright ยฉ 2021-2024 KhulnaSoft DevOps
Permission is hereby granted, free of charge, to any person obtaining a copy of this
software and associated documentation files (the "Software"), to deal in the Software
without restriction, including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE
OR OTHER DEALINGS IN THE SOFTWARE.
Except as contained in this notice, Dashworks shall not be used in advertising or otherwise
to promote the sale, use, or other dealings in this Software without prior written
authorization from the repo owner.
``
TDLR; _You can do whatever you like with Dashworks: use it in private or commercial settings,_
_redistribute and modify it. But you must display this license and credit the author._
_There is no warranty that this app will work as expected, and the author cannot be held_
_liable for anything that goes wrong._
For more info, see TLDR Legal's Explanation of MIT
---
Thank you for Visiting