forked from gchq/CyberChef
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🔀 Merge pull request gchq#488 from Lissy93/FIX/general-issues
[FIX] General issues and improvements Fixes gchq#452 Fixes gchq#454 Fixes gchq#455 Fixes gchq#463 Fixes gchq#479 Fixes gchq#482 Fixes gchq#483 Fixes gchq#485 Fixes gchq#486 Fixes gchq#487
- Loading branch information
Showing
42 changed files
with
920 additions
and
294 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| <h1 align="center">Dashy</h1> | ||
| <p align="center"> | ||
| <i>Dashy 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/dashy.png" /> | ||
| <br/> | ||
| <b><a href="https://github.com/Lissy93/dashy/blob/master/docs/showcase.md">User Showcase</a></b> | <b><a href="https://demo.dashy.to">Live Demo</a></b> | <b><a href="https://github.com/Lissy93/dashy/blob/master/docs/quick-start.md">Getting Started</a></b> | <b><a href="https://dashy.to/docs">Documentation</a></b> | <b><a href="https://github.com/Lissy93/dashy">GitHub</a></b> | ||
| <br/><br/> | ||
| <a href="https://github.com/awesome-selfhosted/awesome-selfhosted#personal-dashboards"> | ||
| <img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" alt="Awesome Self-Hosted"> | ||
| </a> | ||
| <a href="https://github.com/Lissy93/dashy/blob/master/LICENSE"> | ||
| <img src="https://img.shields.io/badge/License-MIT-0aa8d2?logo=opensourceinitiative&logoColor=fff" alt="License MIT"> | ||
| </a> | ||
| <a href="https://github.com/Lissy93/dashy/blob/master/.github/CHANGELOG.md"> | ||
| <img src="https://img.shields.io/github/package-json/v/lissy93/dashy?logo=azurepipelines&color=0aa8d2" alt="Current Version"> | ||
| </a> | ||
| <a href="https://hub.docker.com/r/lissy93/dashy"> | ||
| <img src="https://img.shields.io/docker/pulls/lissy93/dashy?logo=docker&color=0aa8d2&logoColor=fff" alt="Docker Pulls"> | ||
| </a> | ||
| <a href="http://as93.link/dashy-build-status"> | ||
| <img src="https://badgen.net/github/status/lissy93/dashy?icon=github" alt="GitHub Status"> | ||
| </a> | ||
| <a href="https://snyk.io/test/github/lissy93/dashy"> | ||
| <img src="https://snyk.io/test/github/lissy93/dashy/badge.svg" alt="Known Vulnerabilities"> | ||
| </a> | ||
| </p> | ||
|
|
||
| ## Features 🌈 | ||
|
|
||
| - 🔎 Instant search by name, domain, or tags + customizable hotkeys & keyboard shortcuts | ||
| - 🎨 Multiple 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. | ||
| - 🚦 Status monitoring for each of your apps/links for basic availability and uptime checking | ||
| - 📊 Widgets for displaying info and dynamic content from your self-hosted services | ||
| - 💂 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 method, either new tab, same tab, a pop-up modal, or in the 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 configuration, either through the UI, or using a YAML file | ||
| - ✨ 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](https://demo.dashy.to) (Live Demo) ┆ [Demo 2](https://live.dashy.to) (Dashy Links) ┆ [Demo 3](https://dev.dashy.to) (Dev Preview) | ||
|
|
||
| **Screenshots**: Checkout the [Showcase](https://github.com/Lissy93/dashy/blob/master/docs/showcase.md), to see example dashboards from the community | ||
|
|
||
| **Spin up your own demo**: [](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml) or [`docker run -p 8080:80 lissy93/dashy`](./docs/quick-start.md) | ||
|
|
||
|
|
||
| <p align="center"> | ||
| <img width="800" src="https://i.ibb.co/L8YbNNc/dashy-demo2.gif" alt="Demo" /> | ||
| </p> | ||
|
|
||
|
|
||
| **[⬆️ Back to Top](#dashy)** | ||
|
|
||
| --- | ||
|
|
||
| ## Getting Started 🛫 | ||
|
|
||
| To deploy Dashy with Docker, just run `docker run -p 8080:80 lissy93/dashy`, then open `http://localhost:8080` | ||
|
|
||
| For full list of options and a Docker compose file, see the [Deployment Docs](https://github.com/Lissy93/dashy/blob/master/docs/deployment.md). | ||
|
|
||
| Dashy can also be run on bare metal using Node.js, or deployed to a cloud service, using the 1-Click deploy script. | ||
|
|
||
| --- | ||
|
|
||
| ## Documentation 📝 | ||
|
|
||
| #### Running Dashy | ||
| - **[Quick Start](https://github.com/Lissy93/dashy/blob/master/docs/quick-start.md)** - TDLR guide on getting Dashy up and running | ||
| - **[Deployment](https://github.com/Lissy93/dashy/blob/master/docs/deployment.md)** - Full guide on deploying Dashy either locally or online | ||
| - **[Configuring](https://github.com/Lissy93/dashy/blob/master/docs/configuring.md)** - Complete list of all available options in the config file | ||
| - **[App Management](https://github.com/Lissy93/dashy/blob/master/docs/management.md)** - Managing your app, updating, security, web server configuration, etc | ||
| - **[Troubleshooting](https://github.com/Lissy93/dashy/blob/master/docs/troubleshooting.md)** - Common errors and problems, and how to fix them | ||
|
|
||
| #### Feature Docs | ||
| - **[Authentication](https://github.com/Lissy93/dashy/blob/master/docs/authentication.md)** - Guide to setting up authentication to protect your dashboard | ||
| - **[Alternate Views](https://github.com/Lissy93/dashy/blob/master/docs/alternate-views.md)** - Outline of available pages / views and item opening methods | ||
| - **[Backup & Restore](https://github.com/Lissy93/dashy/blob/master/docs/backup-restore.md)** - Guide to backing up config with Dashy's cloud sync feature | ||
| - **[Icons](https://github.com/Lissy93/dashy/blob/master/docs/icons.md)** - Outline of all available icon types for sections and items, with examples | ||
| - **[Language Switching](https://github.com/Lissy93/dashy/blob/master/docs/multi-language-support.md)** - Details on how to switch language, or add a new locale | ||
| - **[Status Indicators](https://github.com/Lissy93/dashy/blob/master/docs/status-indicators.md)** - Using Dashy to monitor uptime and status of your apps | ||
| - **[Searching & Shortcuts](https://github.com/Lissy93/dashy/blob/master/docs/searching.md)** - Searching, launching methods + keyboard shortcuts | ||
| - **[Theming](https://github.com/Lissy93/dashy/blob/master/docs/theming.md)** - Complete guide to applying, writing and modifying themes + styles | ||
| - **[Widgets](https://github.com/Lissy93/dashy/blob/master/docs/widgets.md)** - List of all dynamic content widgets, with usage guides and examples | ||
|
|
||
| #### Development and Contributing | ||
| - **[Developing](https://github.com/Lissy93/dashy/blob/master/docs/developing.md)** - Running Dashy development server locally, and general workflow | ||
| - **[Development Guides](https://github.com/Lissy93/dashy/blob/master/docs/development-guides.md)** - Common development tasks, to help new contributors | ||
| - **[Contributing](https://github.com/Lissy93/dashy/blob/master/docs/contributing.md)** - How you can help keep Dashy alive | ||
| - **[Showcase](https://github.com/Lissy93/dashy/blob/master/docs/showcase.md)** - See how others are using Dashy, and share your dashboard | ||
| - **[Credits](https://github.com/Lissy93/dashy/blob/master/docs/credits.md)** - List of people and projects that have made Dashy possible | ||
| - **[Release Workflow](https://github.com/Lissy93/dashy/blob/master/docs/release-workflow.md)** - Info about releases, CI and automated tasks | ||
|
|
||
| --- | ||
|
|
||
| ## License 📜 | ||
|
|
||
| Dashy is Licensed under [MIT X11](https://en.wikipedia.org/wiki/MIT_License) | ||
|
|
||
| ``` | ||
| Copyright © 2021 Alicia Sykes <https://aliciasykes.com> | ||
| 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, Dashy 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. | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.