mirror of https://github.com/lissy93/dashy
Merge pull request #700 from Lissy93/master
Update deploy_cloudflare branch from master
This commit is contained in:
Alicia Sykes
GitHub
commit
52896a4b75
|
|
@ -0,0 +1,9 @@
|
|||
# Files specified here are not required for Docker
|
||||
# so ignoring them helps to reduce the container size
|
||||
# The Docker container MUST have the following files:
|
||||
# package.json yarn.lock server.js vue.config.js src/ services/
|
||||
|
||||
node_modules
|
||||
docs
|
||||
.git
|
||||
.github
|
||||
|
|
@ -1,5 +1,24 @@
|
|||
root = true
|
||||
|
||||
# Basics - All Files
|
||||
[*]
|
||||
end_of_line = lf
|
||||
charset = utf-8
|
||||
insert_final_newline = true
|
||||
|
||||
# JS, TS and Vue
|
||||
[*.{js,jsx,ts,tsx,vue}]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
trim_trailing_whitespace = true
|
||||
insert_final_newline = true
|
||||
|
||||
# YAML, for config file
|
||||
[*.{yml,yaml}]
|
||||
indent_size = 2
|
||||
|
||||
# Markdown for docs
|
||||
[*.md]
|
||||
trim_trailing_whitespace = false
|
||||
|
||||
# Licensed under MIT, (C) 2021 Alicia Sykes <https://aliciasykes.com>
|
||||
37
.env
37
.env
|
|
@ -0,0 +1,37 @@
|
|||
# Store environmental variables here. All variables are optional.
|
||||
# Lines beginning in '#' are ignored.
|
||||
|
||||
# Can be either development, production or test
|
||||
# NODE_ENV=production
|
||||
|
||||
# The port to expose the running application on
|
||||
# PORT=4000
|
||||
|
||||
# If you've proved SSL certs, then can set HTTPS port
|
||||
# SSL_PORT=4001
|
||||
|
||||
# The host that Dashy is running on, domain or IP
|
||||
# HOST=localhost
|
||||
|
||||
# The default base path for serving up static assets
|
||||
# BASE_URL=./
|
||||
|
||||
# Optionally, specify the path of SSL private + public keys
|
||||
# SSL_PRIV_KEY_PATH=/etc/ssl/certs/dashy-priv.key
|
||||
# SSL_PUB_KEY_PATH=/etc/ssl/certs/dashy-pub.pem
|
||||
|
||||
# If SSL enabled, choose whether or not to redirect http to https
|
||||
# Defaults to true
|
||||
# REDIRECT_HTTPS=true
|
||||
|
||||
# Usually the same as BASE_URL, but accessible in frontend
|
||||
# VUE_APP_DOMAIN=https://dashy.to
|
||||
|
||||
# Should enable SRI for build script and link resources
|
||||
# INTEGRITY=true
|
||||
|
||||
# Computed automatically on build. Indicates if running in container
|
||||
# IS_DOCKER=true
|
||||
|
||||
# Again, set automatically using package.json during build time
|
||||
# VUE_APP_VERSION=2.0.0
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# Ignore list, for automated broken link checking
|
||||
|
||||
https://fonts.gstatic.com/**
|
||||
https://metager.org/meta/**
|
||||
https://developers.cloudflare.com/**
|
||||
|
||||
http://localhost**
|
||||
https://localhost**
|
||||
http://192.168**
|
||||
https://192.168**
|
||||
file:///github/**
|
||||
http://[dashy-location]**
|
||||
https://[dashy-location]**
|
||||
**.local/**
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
/src/assets/locales/fr.json
|
||||
^./src/assets/locales/de.json
|
||||
^./src/assets/locales/es.json
|
||||
^./src/assets/locales/fr.json
|
||||
^./src/assets/locales/nl.json
|
||||
^./src/assets/locales/sl.json
|
||||
^./src/assets/locales/zh-CN.json
|
||||
|
|
@ -0,0 +1,62 @@
|
|||
0n1cOn3 <0n1cOn3@gmx.ch> - 1 commits
|
||||
Alejandro <ina> - 1 commits
|
||||
Alicia <liss-bot@d0h.co> - 1 commits
|
||||
Begin <support@begin.com> - 1 commits
|
||||
David <skaarj1989@gmail.com> - 1 commits
|
||||
DeepSource <o> - 1 commits
|
||||
Devin <uh> - 1 commits
|
||||
Erwan <ira> - 1 commits
|
||||
FormatToday <616099456@qq.com> - 1 commits
|
||||
Iaroslav <ronski> - 1 commits
|
||||
Ishan <ai> - 1 commits
|
||||
Jemy <CHNEP> - 1 commits
|
||||
Jeremy <hauvi> - 1 commits
|
||||
Kieren <onnel> - 1 commits
|
||||
Leonardo <olma> - 1 commits
|
||||
PlusaN <61884717+PlusaN@users.noreply.github.com> - 1 commits
|
||||
Rune <jørnerå> - 1 commits
|
||||
Ryan <urne> - 1 commits
|
||||
Shreya <o> - 1 commits
|
||||
Singebob <jeremy.chauvin@systeme-u.fr> - 1 commits
|
||||
Steven <as> - 1 commits
|
||||
Xert <xertdev@gmail.com> - 1 commits
|
||||
deepsource-io[bot] <deepsource-io[bot]@users.noreply.github.com> - 1 commits
|
||||
icy-comet <50461557+icy-comet@users.noreply.github.com> - 1 commits
|
||||
jnach <33467747+jnach@users.noreply.github.com> - 1 commits
|
||||
tazboyz16 <tazboyz_16@yahoo.com> - 1 commits
|
||||
Alessandro <e> - 2 commits
|
||||
BOZG <sr@bozg.se> - 2 commits
|
||||
Brendan <'Lear> - 2 commits
|
||||
CHAIYEON <H> - 2 commits
|
||||
Dan <ilber> - 2 commits
|
||||
Ruben <ilv> - 2 commits
|
||||
liss-bot <87835202+liss-bot@users.noreply.github.com> - 2 commits
|
||||
ᗪєνιη <υн> - 2 commits
|
||||
Walkx <71191962+walkxcode@users.noreply.github.com> - 3 commits
|
||||
aterox <kenneth@kenneth.church> - 3 commits
|
||||
stanly0726 <37040069+stanly0726@users.noreply.github.com> - 3 commits
|
||||
Niklas <abe> - 4 commits
|
||||
Rémy <RANDI> - 4 commits
|
||||
Walkx <walkxnl@gmail.com> - 4 commits
|
||||
Alicie <gh@d0h.co> - 5 commits
|
||||
Benjamin <ontgomer> - 5 commits
|
||||
UrekD <urek.denis@gmail.com> - 5 commits
|
||||
Erik <roo> - 6 commits
|
||||
Leonardo <ovarrubia> - 6 commits
|
||||
liss-bot <liss-bot@users.noreply.github.com> - 6 commits
|
||||
Kashif <ohai> - 9 commits
|
||||
Alicia <yke> - 16 commits
|
||||
github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> - 16 commits
|
||||
snyk-bot <snyk-bot@users.noreply.github.com> - 18 commits
|
||||
aterox <church.kennetha@gmail.com> - 19 commits
|
||||
EVOTk <45015615+EVOTk@users.noreply.github.com> - 22 commits
|
||||
Alicia <yke> - 28 commits
|
||||
repo-visualizer <repo-visualizer@users.noreply.github.com> - 38 commits
|
||||
snyk-bot <snyk-bot@snyk.io> - 43 commits
|
||||
Alicia <o> - 76 commits
|
||||
Lissy93 <gh@d0h.co> - 78 commits
|
||||
liss-bot <liss-bot@d0h.co> - 87 commits
|
||||
Alicia <yke> - 113 commits
|
||||
Lissy93 <Lissy93@users.noreply.github.com> - 207 commits
|
||||
Alicia <yke> - 404 commits
|
||||
Alicia <yke> - 1488 commits
|
||||
|
|
@ -0,0 +1,648 @@
|
|||
# Changelog
|
||||
|
||||
## ✨ 2.0.9 Adds Multi-Page Support [PR #663](https://github.com/Lissy93/dashy/pull/663)
|
||||
- Fix KeyCloak API URL (#564)
|
||||
- Fix guest has config access (#590)
|
||||
- Fix collapsible content in multi-page support (#626)
|
||||
- Fix layout and item size buttons ( #629)
|
||||
- Refactor make request in RSS widget (#632)
|
||||
- Fix material-design-icons header in schema (#640)
|
||||
- Add option to hide seconds in clock widget (#644)
|
||||
- Fix pageInfo not being read in router (#645)
|
||||
- Fix startingView not honored (#646)
|
||||
- Fix Status Check default (#651)
|
||||
- Add option to hide image in SportsScores Widget (#654)
|
||||
- Add Adventure-basic theme (#655)
|
||||
- Write docs for sub-items (#657)
|
||||
- Add Font-Awesome displaying as square to troubleshooting guide (#659)
|
||||
- Show expand / collapse in context menu (#660)
|
||||
- Only deploy new release when relevant files have changed
|
||||
|
||||
## ✨ 2.0.8 Adds Multi-Page Support [PR #617](https://github.com/Lissy93/dashy/pull/617)
|
||||
- Adds support for multiple pages per-dashboard
|
||||
- Adds new attribute at root of main config file: `pages`
|
||||
- Updates router and nav-bar to automatically create paths for both local and remote configs
|
||||
|
||||
## ⚡️ 2.0.7 Improves handling of Sections and Items [PR #595](https://github.com/Lissy93/dashy/pull/595)
|
||||
- Adds functionality for sub-items / item-groups
|
||||
- Creates an item mixin, for reusing functionality
|
||||
- Item width calculated based on parent section width
|
||||
- Improved mobile support, long-press for right-click
|
||||
- Adds 2 new themes (`lissy` and `charry-blossom`)
|
||||
- Adds 2 new widgets (`mullvad-status`, and `blacklist-check`)
|
||||
|
||||
## 🐛 2.0.6 Fixes user requested issues [PR #557](https://github.com/Lissy93/dashy/pull/557)
|
||||
- Allows middle click open new tab, Re: #492
|
||||
- Implements Max redirects for status checks, Re: #494
|
||||
- Adds Gitpod config for cloud-ready IDE, Re: #497
|
||||
- Adss new screenshots to showcase, Re: #505
|
||||
- Fixes excess space below footer, Re: #522
|
||||
- Allows iframe content to be viewed full-screen, Re: #524
|
||||
- Fixes Glances widgets with Authorization headers, Re: #546
|
||||
- Adds target attribute to nav links, Re: #552
|
||||
- Removes fixed max-width on wide-screens, Re: #554
|
||||
- Adds missing type attribute to external CSS, Re: #560
|
||||
- Updates path to Keycloak API, Re: #564
|
||||
- Fixes link to @walkxhub homelab icons, Re #568
|
||||
- Fixes local image path on sub-page, Re: #570
|
||||
- Adds typecheck on edit item tags, Re: #575
|
||||
- Fixes item size in config not honored, Re: #576
|
||||
|
||||
## ✨ 2.0.5 - Bug Fixes and a few New Features
|
||||
|
||||
#### Partially revert 2.0.4, fixing several issues caused by `conf.yml` not being loaded at startup.
|
||||
This change requires a rebuild of the application when several options under `appConfig` are changed.
|
||||
Fixes #544 #555
|
||||
|
||||
#### Several other changes since 2.0.4, including:
|
||||
The `Add New Section` button on the UI editor now displays if no sections are present. #536
|
||||
When using SSL, the server can now redirect from HTTP to HTTPS. This is enabled by default when using SSL. #538
|
||||
Section context menus are now accessible on mobile, and will no longer clip off the screen. #541
|
||||
Italian translations have been added. #556
|
||||
|
||||
## ✨ 2.0.4 - Dynamic Config Loading [PR #528](https://github.com/Lissy93/dashy/pull/528)
|
||||
- `conf.yml` is now loaded dynamically and the app now only needs a browser refresh on config change, not a full rebuild!
|
||||
|
||||
## 🐛 2.0.3 - Bug Fixes [PR #488](https://github.com/Lissy93/dashy/pull/488)
|
||||
- Press enter to submit login form (Re: #483)
|
||||
- Allow disabling write to local storage and disk (Re: #485)
|
||||
- Fix malformed YAML from export config (Re: #482)
|
||||
- Allow global option for useProxy (Re: #486)
|
||||
- Look into arrow key navigation error (Re: #463)
|
||||
- Disallow displaying config (Re: #455)
|
||||
- Round values in Glances Alerts widget (Re: #454)
|
||||
- Create a CPU temp widget (Re: #452)
|
||||
- Add to docs: Keycloak in Kubernetes (Re: #479)
|
||||
- Add a widget for displaying images (Re: #487)
|
||||
|
||||
## ⬆️ 2.0.2 - Dependency Updates [PR #471](https://github.com/Lissy93/dashy/pull/471)
|
||||
- Updates Alpine version for main Dockerfile
|
||||
- Updates node_modules to latest stable versions
|
||||
|
||||
## 🐛 2.0.1 - Fixes Section Height [PR #462](https://github.com/Lissy93/dashy/pull/462)
|
||||
- Adds `cutToHeight` to config schema (Re: #461)
|
||||
- Removes the full-height CSS from colorful theme
|
||||
- Improved config validation warnings in JSON editor
|
||||
- Removes empty Keycloak block from appConfig editor
|
||||
- Adds typechecking to search and clear search for Safari
|
||||
|
||||
## ⚡️ 2.0.0 - Small Fixes and Docker Multi-Arch Build [PR #451](https://github.com/Lissy93/dashy/pull/451)
|
||||
- Fixes full-height sections for mobile and Safari (Re: #432, #442)
|
||||
- Fixes empty section visible in search (Re: #447)
|
||||
- Fixes numbers omited from tag names (Re: #430)
|
||||
- Option for custom status code in status check (Re: #456, #448)
|
||||
- Adds @stuu3k's dashboard to showcase (Re: #446)
|
||||
- Switches recover and death count in Covid widget (Re: #148)
|
||||
- Improved contrast in light material theme
|
||||
- Adds new script to lint, test, build and publish a multi-architecture Docker image to various registries
|
||||
|
||||
## 💄 1.9.9 - Minor UI + Docs Updates [PR #431](https://github.com/Lissy93/dashy/pull/431)
|
||||
- Improved theme support for widgets
|
||||
- Better widget layout in Workspace and Minimal views
|
||||
- Updates lots of the docs
|
||||
|
||||
## ✨ 1.9.8 - More Widgets and Widget Improvements [PR #425](https://github.com/Lissy93/dashy/pull/425)
|
||||
- Fixes several minor widget issues raised by users
|
||||
- Adds several new widgets, for monitoring system
|
||||
- Better widget data requests and error handling
|
||||
- Implements widget support into Workspace view
|
||||
|
||||
## 🐛 1.9.7 - Minor UI Editor Bug fixes [PR #416](https://github.com/Lissy93/dashy/pull/416)
|
||||
- Fixes unable to edit item bug (#415)
|
||||
- Fixes unable to add new app bug (#390)
|
||||
- Fixes nav links visibility (#389)
|
||||
|
||||
## ⚡️ 1.9.6 - Adds Proxy Support for Widget Requests [PR #392](https://github.com/Lissy93/dashy/pull/392)
|
||||
- Refactors widget mixin to include data requests, so that code can be shared between widgets
|
||||
- Adds a Node endpoint for proxying requests server-side, used for APIs that are not CORS enabled
|
||||
- Adds option to config file for user to force proxying of requests
|
||||
- Writes a Netlify cloud function to support proxying when the app is hosted on Netlify
|
||||
|
||||
## 🐛 1.9.5 - Bug fixes and Minor Improvements [PR #388](https://github.com/Lissy93/dashy/pull/388)
|
||||
- Adds icon.horse to supported favicon APIs
|
||||
- Fixes tile move bug, Re: #366
|
||||
- Fixes save items without title bug, Re: #377
|
||||
|
||||
## ✨ 1.9.4 - Widget Support [PR #382](https://github.com/Lissy93/dashy/pull/382)
|
||||
- Adds support for dynamic content, through widgets
|
||||
- Adds 30+ pre-built widgets for general info and self-hosted services
|
||||
- Writes docs on widget usage
|
||||
|
||||
## ⚡️ 1.9.2 - Native SSL Support + Performance Improvements [PR #326](https://github.com/Lissy93/dashy/pull/326)
|
||||
- Updates the server to use Express, removing serve-static, connect and body-parser
|
||||
- Adds native support for passing in self-signed SSL certificates and updates docs
|
||||
- Updates router to lazy-load additional pages (minimal, workspace, etc)
|
||||
- Changes default favicon API to allesedv, since faviconkit is down, and adds basic fallback
|
||||
- Updates GH action build scripts to fallback on context token when running on fork
|
||||
|
||||
## 💄 1.9.1 - Editor and Theming Fixes and Improvements [PR #319](https://github.com/Lissy93/dashy/pull/319)
|
||||
- Bug fixes for interactive editor: #310, #311, #312
|
||||
- Adds option to modify text font through the UI
|
||||
- Adds two new themes: One Dark and Adventure
|
||||
- Theming stylesheet refactor, better inheritance
|
||||
|
||||
## 🐳 1.9.0 - Alpha of Dashy-Lite Docker Container [PR #306](https://github.com/Lissy93/dashy/pull/306)
|
||||
- Create an Alpine-based container, that serves the built app up with plain NGINX, instead of Node.
|
||||
- This is much lighter, but doesn't currently support any of the server-side actions (like status-checks, and writing changes to disk)
|
||||
|
||||
## ✨ 1.8.9 - All New Interactive Config Editor [PR #298](https://github.com/Lissy93/dashy/pull/298)
|
||||
- Builds a new UI-based config editor
|
||||
- Support for sections, items, app config and page info
|
||||
- Live preview, and undoing of local changes
|
||||
- Export config or write changes to disk through UI
|
||||
|
||||
## ✨ 1.8.8 - Improved Item Targets [PR #292](https://github.com/Lissy93/dashy/pull/292)
|
||||
- Adds support for `_top` and `_parent` anchor targets on items, Re: #289
|
||||
- Adds `appConfig.defaultOpeningMethod` option to specify default target
|
||||
- Adds new icons to show items opening method on hover
|
||||
- Refactors target checking, updates item target docs and schema
|
||||
|
||||
## ⚡️ 1.8.7 - Bug Fixes and Improvements [PR #273](https://github.com/Lissy93/dashy/pull/273)
|
||||
- Clean URLs without the hash, now using history-mode routing
|
||||
- New initial main example conf.yml
|
||||
- Minor UI style updates and fixes
|
||||
- Support for single section view
|
||||
- A new theme, soft-glow
|
||||
- Container security in management docs, and other things
|
||||
- Bug fixes, including missing Firefox favicon and fix custom icon paths with base_url
|
||||
|
||||
## ⚡️ 1.8.6 - Implementation of VueX [PR: #271](https://github.com/Lissy93/dashy/pull/271)
|
||||
- New state management pattern, which should lead to a more organized code base long term, and will also make building out the new UI editor significantly easier to do in a clean and reliable way
|
||||
|
||||
## 💄 1.8.5 - Lots of Requested UI Improvements [PR #261](https://github.com/Lissy93/dashy/pull/261)
|
||||
- Adds an option for landing URL in workspace, Re: #255
|
||||
- Switches to a new API for generative icons, Re: #163
|
||||
- Adds new tab functionality to Workspace, Re: #254
|
||||
- Remove CSS validation in style editor, Re: #259
|
||||
- Cap item description at 2 lines, Re: #250
|
||||
- Adds native support for common homelab icons, using dashboard-icons
|
||||
- Improves general responsiveness of home page sections positioning
|
||||
- Updates, fixes and adds a bunch of actions for easier repo management
|
||||
|
||||
## ✨ 1.8.4 - Custom Error Pages [PR #257](https://github.com/Lissy93/dashy/pull/257)
|
||||
- Creates a 404 Not Found page
|
||||
- Routes any missing views to the 404 page
|
||||
|
||||
## ⚡️ 1.8.3 - Improved UX for Initial Load [PR #238](https://github.com/Lissy93/dashy/pull/238)
|
||||
- Removes the old splash screen
|
||||
- Adds placeholder in the HTML index, which will usually be visible on initial load
|
||||
- Show progress bar on route switcher
|
||||
|
||||
## ✨ 1.8.2 - Serverless Functions for Netlify Instances [PR #235](https://github.com/Lissy93/dashy/pull/235)
|
||||
- Previously when Dashy was deployed as a static site to Netlify, it was not possible to use several features, which required server-side code
|
||||
- This PR adds serverless cloud functions to provide most of this functionality
|
||||
|
||||
## 🩹 1.8.1 - Additional Languages, Bug Fix, and more [PR #234](https://github.com/Lissy93/dashy/pull/234)
|
||||
- Merges 5 additional languages
|
||||
- Adds RickyCZ's dashboard to showcase
|
||||
- Fixes #323, and improves status indicator tooltip
|
||||
- Define constants for endpoints
|
||||
- Updates management, translations and readme docs
|
||||
|
||||
## ⚡️ 1.7.7 - Improved Error Handling [PR #226](https://github.com/Lissy93/dashy/pull/226)
|
||||
- Errors can be viewed via the UI (Config menu --> App Info)
|
||||
- Service workers should be disabled by default
|
||||
- Also renames actions to be easier to maintain
|
||||
- Updates docs to include release schedule + merge strategy
|
||||
|
||||
## ✨ 1.7.6 - Adds Multi-Search Support with Bangs [PR #224](https://github.com/Lissy93/dashy/pull/224)
|
||||
- Adds option for user to add custom search bangs, in order to specify search engine/ target app. Re: #206
|
||||
|
||||
## 🎨 1.7.5 - Improved Language Detection & UI [PR #223](https://github.com/Lissy93/dashy/pull/223)
|
||||
- Makes the auto language detection algo smarter
|
||||
- Improves responsiveness for the language selector form
|
||||
|
||||
## 🌐 1.7.4 - Adds Spanish Translations [PR #222](https://github.com/Lissy93/dashy/pull/222)
|
||||
- Adds Spanish language file, contributed by @lu4t
|
||||
|
||||
## 👷 1.7.3 - CI with GH Actions [PR #212](https://github.com/Lissy93/dashy/pull/212)
|
||||
- Adds a series of GH actions for repository maintenance and administration
|
||||
- Auto-labels PR and issues, adds helpful info to PRs based on files changed
|
||||
- Lints, tests, builds and deploys the app when PR submitted
|
||||
- Checks app size, dependencies, security, accessibility etc when PR submitted
|
||||
- Closes incomplete, stale or spammy issues and leaves a comment
|
||||
|
||||
## ✨ 1.7.2 - Item Sort Options [PR #203](https://github.com/Lissy93/dashy/pull/203)
|
||||
- Adds option for user to specify `sortBy` to order items within a section
|
||||
- Can sort by last clicked, most used, alphabetically and more
|
||||
- And fixes UI of the item tooltip and, if specified, will show Provider in the tooltip
|
||||
- Also improves error logging and console warning message
|
||||
|
||||
## 🐛 1.7.1 - Lots of Tiny Fixes and Improvements [PR #200](https://github.com/Lissy93/dashy/pull/201)
|
||||
- Removes background in console art
|
||||
- Updates auto environmental variables
|
||||
- Icon image assets max height Force same Icon/Item Height #200
|
||||
- Adds an action to close spammy issues
|
||||
- Adds option to enable SRI integrity, plus refactos PWA into defaults
|
||||
- Updates privacy and security docs
|
||||
- Adds option for different favicon API for each app [FEATURE_REQUEST] Allow using different faviconApi for each items #196
|
||||
- Fixes loading of local SVG icons #199
|
||||
|
||||
## 🍻 1.7.0 - Documentation Website [PR #190](https://github.com/Lissy93/dashy/pull/190)
|
||||
- Builds a quick website to host the docs. No code changes, but prepares for V1.7 release
|
||||
|
||||
## ✨ 1.6.9 - Web Search Feature [PR #185](https://github.com/Lissy93/dashy/pull/185)
|
||||
- Adds ability to search the web directly from Dashy by pressing enter on the search bar
|
||||
- Adds configuration options, for setting default search engine, opening method and disabling
|
||||
- Adds text under search bar, implements into minimal view also
|
||||
|
||||
## ⚡️ 1.6.8 - Improved Loading Experience [PR #183](https://github.com/Lissy93/dashy/pull/183)
|
||||
- During app initialization, show the build progress and status message
|
||||
- While requests are being made, show loader at top of screen
|
||||
- Also adds some UI improvements to Workspace view
|
||||
|
||||
## ⚡️ 1.6.7 - Option for non-SSL status checks plus minor things [PR #182](https://github.com/Lissy93/dashy/pull/182)
|
||||
- Adds an option for user to use status checks with non-HTTPS services, Re: #181
|
||||
- Updates the .env template, plus the variables used in the server
|
||||
- Uses the v-cloak to hide text before it's finished loading
|
||||
- Fixed the parsing of the update-checker during build
|
||||
|
||||
## ⚡️ 1.6.6 - Improved Search & Shortcuts [PR #175](https://github.com/Lissy93/dashy/pull/175)
|
||||
- Refactors the search algorithm to improve performance and code reusability
|
||||
- Updates search to ignore case, special characters and minor-typos
|
||||
- Adds the option for user to specify tags, which can be used for searching
|
||||
|
||||
## ✨ 1.6.5 - Adds support for Secure Authentication using Keycloak [PR #174](https://github.com/Lissy93/dashy/pull/174)
|
||||
- Major restructure of auth config
|
||||
- Implements keycloak support, adds docs and updates schema
|
||||
|
||||
## ✨ 1.6.4 - Adds functionality for Granular Auth Control [PR #171](https://github.com/Lissy93/dashy/pull/171)
|
||||
- Enables sections to be visible for all users except for those specified
|
||||
- Enables sections to be hidden from all users except for those specified
|
||||
- Enables sections to be hidden from guests, but visible to all authenticated users
|
||||
|
||||
## ⚡️ 1.6.3 - Dependency and Build File Updates [PR #168](https://github.com/Lissy93/dashy/pull/168)
|
||||
- Removes any dependencies which are not 100% essential
|
||||
- Moves packages that are only used for building into devDependencies
|
||||
- Updates dependencies to latest version
|
||||
- Adds a .dockerignore, so that non-essential files are not included in the container
|
||||
- Updates deployment config files for Netlify, Heroku and GH actions
|
||||
- Made a brand new bug-report template, with input fields and validation!
|
||||
|
||||
## ✨ 1.6.2 - Support for Guest Access [PR #167](https://github.com/Lissy93/dashy/pull/167)
|
||||
- Adds functionality for optional read-only guest access to dashboards with authentication
|
||||
- Can be enabled by setting `appConfig.enableGuestAccess: true`
|
||||
|
||||
## 💄 1.6.1 - Adds new Theme [PR #166](https://github.com/Lissy93/dashy/issues/166)
|
||||
- Adds Dashy theme, for use in the dev dashboard
|
||||
|
||||
## ✨ 1.5.9 - New Minimal/ Startpage View [PR #155](https://github.com/Lissy93/dashy/issues/155)
|
||||
- Adds a new view, called minimal view, designed to be like a light-weight startpage
|
||||
- Implemented all the required features (filtering, opening methods, icons, etc) into minimal view
|
||||
- Adds `appConfig.startingView` into schema, for specifying the initial default view to be loaded
|
||||
|
||||
## ✨ 1.5.8 - Multi-Tasking Support in Workspace View [PR #146](https://github.com/Lissy93/dashy/pull/146)
|
||||
- Adds option to keep launched apps open in the background, to reduce friction when switching between websites, Re: #144
|
||||
- This can be enabled by setting `appConfig.enableMultiTasking: true`
|
||||
- Note that having many apps opened simultaneously, will have an impact on performance
|
||||
|
||||
## ✨ 1.5.7 - Adds Support for Material Design Icons [PR #141](https://github.com/Lissy93/dashy/pull/141)
|
||||
- Enables user to use any icon from [materialdesignicons.com](https://dev.materialdesignicons.com/icons), Re: #139
|
||||
- Also adds support for [simpleicons.org](https://simpleicons.org/)
|
||||
- Assets only loaded when needed
|
||||
- Adds docs for using MDI icons
|
||||
|
||||
## ⚡️ 1.5.6 - Refactor + Couple of small things [PR #135](https://github.com/Lissy93/dashy/pull/135)
|
||||
- The main Dockerfile now uses yarn.lock instead of package-lock.json
|
||||
- Adds a check to verify password is not empty in cloud backup screen
|
||||
- Improves responsiveness of config modals for mobile devices
|
||||
- Enables the user to use their own self-hosted Sentry instance
|
||||
- Removes the View Config tab of the Config menu, as not needed
|
||||
- Updates and fixes some typos in the readme
|
||||
|
||||
## 🌐 1.5.5 - Adds Missing Translations + Small UI Issues [PR #129](https://github.com/Lissy93/dashy/pull/129)
|
||||
- Adds missing translations to several UI elements, Re: #126
|
||||
- Fixes login translations not being picked up on page load, Re: #127
|
||||
- Fixes small text overflow glitch in config icon, Re: #123
|
||||
- Several small UI improvements: height of config editor, scrollbar on theme dropdown, page height, white-on-white on material theme, etc
|
||||
- Adds an action to auto-assign reviewer based on ./.github/CODEOWNERS file
|
||||
|
||||
## 🐳 1.5.4 - Docker ARM Support [PR #122](https://github.com/Lissy93/dashy/pull/122)
|
||||
- Adds a Dockerfile for `arm64v8` and `arm32v7`, to support Raspberry Pi and other modern ARM-based devices
|
||||
- Sets up automated workflow to publish ARM containers to DockerHub after every new release
|
||||
- Adds documentation for running Dashy on RPi/ ARM-based devices, Re: #117
|
||||
|
||||
## 🩹 1.5.3 - UI Quick Fix [PR #121](https://github.com/Lissy93/dashy/pull/121)
|
||||
- Downgrades and pins vue-material-tabs to 0.1.5, to prevent breaking changes. Fixes #118 p1
|
||||
- Sets auto-width for theme selector, so text doesn't wrap for long theme names. Fixes #119
|
||||
- Uses flex layout for config menu, so note doesn't overlap menu on small screens. Fixes #118 p2
|
||||
|
||||
## 🌐 1.5.2 - Adds Dutch Translations [PR #120](https://github.com/Lissy93/dashy/pull/120)
|
||||
- Dutch language support, contributed by @evroon
|
||||
|
||||
## 🩹 1.5.1 - UI Quick Fix [PR #116](https://github.com/Lissy93/dashy/pull/116)
|
||||
- Uses min-max width parent layout, to prevent longer languages (e.g. French) text overflow. Fixes #115
|
||||
|
||||
## 🔒 1.5.0 - Improve Robustness of Auth [PR #113](https://github.com/Lissy93/dashy/pull/113)
|
||||
- Use both username + password for generating token, so that a change in either will log the user out
|
||||
- Prevent privilege escalation by disallowing a user from modifying their user type through the UI
|
||||
- Improve the isAuthenticated check, by taking account of empty users array
|
||||
|
||||
## ✨ 1.4.8 - Optional Crash Reports [PR #112](https://github.com/Lissy93/dashy/pull/112)
|
||||
- Adds an optional, off by default method of getting crash reports
|
||||
- This can be enabled in `appConfig.enableErrorReporting`, and will not be used at all unless explicitly activated by user
|
||||
- This is needed for when a user raises a bug which is hard to fix
|
||||
- Also improves robustness of config accumulator, don't throw error when config is missing
|
||||
- Adds Privacy & Security docs
|
||||
|
||||
## ♻️ 1.4.7 - Refactor [PR #110](https://github.com/Lissy93/dashy/pull/110)
|
||||
- Moves cloud sync dialog into the config menu, and removes icon on homepage
|
||||
- Fixes typo in Default theme name, Re #106
|
||||
- Spell checks readme
|
||||
- Updates the contributor CI action, that generates list of contributors + sponsors
|
||||
|
||||
## 📝 1.4.6 - Documentation Updates [PR #108](https://github.com/Lissy93/dashy/pull/108)
|
||||
- Breaks many of the longer files into several more digestible articles
|
||||
- Writes repo pages including, Security, Code of Conduct, Legal, Updates license
|
||||
- Makes an automatically generated Credits page
|
||||
- Adds a contributing page, with several ways that users can help out
|
||||
- Implements this changelog, as requested in #87
|
||||
|
||||
## 🌐 1.4.5 - Adds German Translations [PR #107](https://github.com/Lissy93/dashy/pull/107)
|
||||
- German language support, contributed by @Niklashere
|
||||
|
||||
## ✨ 1.4.4 - Adds Support for Logo Image [PR #105](https://github.com/Lissy93/dashy/pull/105)
|
||||
- Adds option in config file for user to specify path to an image
|
||||
- If found, will display said image in the header
|
||||
|
||||
## ✨ 1.4.3 - Auto-Checks for Updates [PR #101](https://github.com/Lissy93/dashy/pull/101) and [PR #102](https://github.com/Lissy93/dashy/pull/102)
|
||||
- Write a script to compare current version with git master version
|
||||
- Periodically checks for updates, and displays message to user
|
||||
- Enables user to disable update-checks in the config file
|
||||
- Checks not using vulnerable version on project-build
|
||||
|
||||
## ✨ 1.4.2 - Adds Multi-Language Support [PR #99](https://github.com/Lissy93/dashy/pull/99)
|
||||
- Implements vue-i18n, sets object globally
|
||||
- Extracts all text to a single JSON file
|
||||
- Auto-detects users language, and applies, if availible
|
||||
- Builds a form to let user manually select their language
|
||||
- Lets users language be saved and read from local storage, or config file
|
||||
|
||||
## ✨ 1.4.1 - Adds Support for Custom Key Bindings [PR #94](https://github.com/Lissy93/dashy/pull/94)
|
||||
- Adds new attribute under item for saving numeric key binding
|
||||
- Listens for keypress, and launches corresponding item, if found
|
||||
|
||||
## ✨ 1.4.0 - Builds a Custom Theme Configurator
|
||||
- Adds property to save custom theme variables
|
||||
- Builds UI form, with color pickers, a pallette and popup
|
||||
- Integrates the saving colors, and applying saved colors functionality
|
||||
|
||||
## 🔨 1.3.9 - Enable Custom Styesheet in Docker [PR #92](https://github.com/Lissy93/dashy/pull/92)
|
||||
- Enables the user to pass a custom stylesheet in with Docker
|
||||
- Adds support for 1-Click deployment to Render.com
|
||||
|
||||
## 🌟 1.3.8 - Showcase [#91](https://github.com/Lissy93/dashy/pull/91)
|
||||
- Adds @Shadowking001's screenshot to showcase
|
||||
|
||||
## 🌟 1.3.7 - Showcase [PR #84](https://github.com/Lissy93/dashy/pull/84)
|
||||
- Adds @dtctek's screenshot to showcase
|
||||
|
||||
## ✨ 1.3.6 - Enables User to Hide Unwanted Components [PR #78](https://github.com/Lissy93/dashy/pull/78)
|
||||
- Adds several additional options to the config, allowing the user to hide structural components that they don't need
|
||||
- Including hideHeading, hideNav, hideSearch, hideSettings, hideFooter, hideSplashScreen
|
||||
|
||||
## ✨ 1.3.5 - Adds Support for Emoji Icons [PR #76](https://github.com/Lissy93/dashy/pull/76)
|
||||
- Enables user to use emojis for item and section icons
|
||||
- Adds a handler to convert Unicode, or Shortcode into an Emoji
|
||||
|
||||
## 🌟 1.3.4 - Showcase Addition [PR #75](https://github.com/Lissy93/dashy/pull/75)
|
||||
- Adds @cerealconyogurt's screenshot to the showcase
|
||||
|
||||
## 💄 1.3.3 - UI Improvements [PR #73](https://github.com/Lissy93/dashy/pull/73)
|
||||
- New style of Large item
|
||||
- 2 new color themes
|
||||
- Added CSS variables for search label and footer background
|
||||
- Improves process for auto-checking if font-awesome is needed
|
||||
- Silences non-critical warnings in production build
|
||||
- Adds new optional font-face for cyber punk
|
||||
- Shortens readme, and adds contribute links to showcase
|
||||
|
||||
## ⚡️ 1.3.0 - Custom Headers for Status Check [PR #72](https://github.com/Lissy93/dashy/pull/72)
|
||||
- Enables user to pass custom headers to the status check endpoint
|
||||
- Enables user to use a different URL for the status check request
|
||||
|
||||
## 🌟 1.2.9 - Creates a Showcase Page [PR #68](https://github.com/Lissy93/dashy/pull/68)
|
||||
- Adds a page in the docs for users to share their screenshots of their dashboard
|
||||
|
||||
## ✨ 1.2.8 - Adds Remember-Me Functionality into the Login Form [PR #66](https://github.com/Lissy93/dashy/pull/66)
|
||||
- Adds a dropdown menu in the login form with various time intervals available
|
||||
- Adds appropriate expiry into session storage, in order to keep user logged in for their desired time interval
|
||||
|
||||
## ✨ 1.2.7 - Implements a Right-Click Context Menu [#62](https://github.com/Lissy93/dashy/pull/62)
|
||||
- Built a context menu, showing all item opening methods, on right-click
|
||||
- Made a clickOutside directive, in order to close menu when user clicks away
|
||||
- Adds launching functionality, user can click to launch
|
||||
|
||||
## ⚡️ 1.2.6 - Make Font Assets Local [PR #60](https://github.com/Lissy93/dashy/pull/60)
|
||||
- Downloaded font files to assets
|
||||
- Removed all calls to font CDN, replaced with local calls
|
||||
|
||||
## 🐛 1.2.5 - Small Fixes, and Efficiency Improvements [PR #57](https://github.com/Lissy93/dashy/pull/57)
|
||||
- Adds correct license
|
||||
- Improves service workers, and adds serviceWorkerStatus local storage item
|
||||
- Adds missing statusCheck and statusCheckInterval docs into Configuring.md
|
||||
- Adds an About App page, containing info needed to raise a bug report
|
||||
- Adds TDLR license into main readme
|
||||
- Introduces app versioning
|
||||
- Adds safeguards into ConfigAccumalaror, to prevent error being thrown
|
||||
- Updates PR template
|
||||
- Improved Webpack build experience, with progress bar and completion notification
|
||||
- Adds new and improved icons for layout options
|
||||
- Make the Page Title into a home page link
|
||||
- Adds missing favicon, fixes #55
|
||||
- Adds assets to PWA manifest.json
|
||||
- Documents app commands in readme
|
||||
- Enable passing website as URL param to the workspace
|
||||
- Modified items, so that title text doesn't get shortened,
|
||||
|
||||
## ✨ 1.2.4 - Adds Support for Continuous Status Checking [#52](https://github.com/Lissy93/dashy/pull/52)
|
||||
- Enables user to re-call the status check at a specified interval
|
||||
- Processes interval in ms, and updates the traffic light when required
|
||||
|
||||
## 🐛 1.2.3 - Bug Fix [PR #49](https://github.com/Lissy93/dashy/pull/49)
|
||||
- Removes duplicate Docker env var, fixes #48
|
||||
|
||||
## ✨ 1.2.2 - Better Favicon Support
|
||||
- Enables user to force direct/ local favicon fetching
|
||||
- Adds support for additional favicon API, returning high-res app icons
|
||||
- Adds support for generative icons
|
||||
|
||||
## 🐛 1.2.1 - Bugfix [#44](https://github.com/Lissy93/dashy/pull/44)
|
||||
- Fixes footer positioning on mobile, makes sticky, fixes #42
|
||||
|
||||
## ✨ 1.2.0 - Adds Writing Config to Disk from UI Functionality [PR #43](https://github.com/Lissy93/dashy/pull/43)
|
||||
- Creates a new server endpoint for handling the backing up of a the file
|
||||
- Adds backup existing file functionality
|
||||
- Adds writing new file functionality
|
||||
- Does error checking, testing and adds some security parameters
|
||||
- Adds a radio button in the UI, so user chan choose save method
|
||||
- Process config within the UI, convert to YAML, and write changes to disk
|
||||
|
||||
## 🐛 1.1.8 - Bugfix [#40](https://github.com/Lissy93/dashy/pull/40)
|
||||
- Status check tooltip was not visible in Material themes, raised in issue #39
|
||||
|
||||
## ✨ 1.1.7 - Adds Workspace View [PR #38](https://github.com/Lissy93/dashy/pull/38)
|
||||
- Adds a new route, for the workspace view
|
||||
- Builds the sidebar, which displays the users apps
|
||||
- Loads the app into the workspace's main iframe when clicked
|
||||
- Adds some collapsing functionality, better styles, subtle animations and theme support
|
||||
|
||||
## ✨ 1.1.6 - Implements Status Indicators, and Monitoring Functionality [PR #34](https://github.com/Lissy93/dashy/pull/34)
|
||||
- Wrote a Node endpoint for pinging the users desired services
|
||||
- Added status checking functionality in frontend
|
||||
- Build small traffic-light component to display status of users services
|
||||
- Adds animations, and handles errors
|
||||
- Writes docs, and tests code
|
||||
|
||||
## ✨ 1.1.5 - Adds Authentication / Login Functionality [PR #32](https://github.com/Lissy93/dashy/pull/32)
|
||||
- Enables the user to protect their dashboard behind a login screen
|
||||
- Creates a Authentication handler to manage the hashing of passwords, and generation of a token
|
||||
- Build a quick login form, where user can input username and password
|
||||
- Adds a log out button
|
||||
|
||||
## 💄 1.1.4 - Support for Custom HTML Footer [PR #30](https://github.com/Lissy93/dashy/pull/30)
|
||||
- Enables user to insert structure for the footer defined as HTML
|
||||
|
||||
## 🚀 1.1.3 - Adds Support for 1-Click Cloud Deployments [PR #29](https://github.com/Lissy93/dashy/pull/29)
|
||||
- Support for 1-Click Deploy to Netlify
|
||||
- Support for 1-Click Deploy to Heroku
|
||||
|
||||
## 🔧 1.1.2 - Docker Efficiency Improvements [PR #26](https://github.com/Lissy93/dashy/pull/26)
|
||||
- Writes a Node health check script, and implements into the Docker container
|
||||
- Changes default port in docker-compose, as 8080 is commonly used by other apps
|
||||
- Adds the 1-Click deploy with PWD into the readme
|
||||
- Updates dependencies
|
||||
- Adds a getting started guide to the docs
|
||||
- Adds splash screen for first load
|
||||
- Deleted unused assets
|
||||
- Makes linter run as a pre-commit hook
|
||||
- Fixes lint errors in server.js and validate-config.js
|
||||
|
||||
## 🐛 1.1.1 - Bug Fixes [PR #20](https://github.com/Lissy93/dashy/pull/20) + [PR #21](https://github.com/Lissy93/dashy/pull/21)
|
||||
- Adds issue template
|
||||
- Bug fixes
|
||||
- Improves github PR and issue templates
|
||||
- Shortens readme file
|
||||
- Adds documentation in the docs folder
|
||||
- Fixes Layout tab not showing in portrait #19
|
||||
- Improves mobile performance for both the settings, config and backup pop-ups
|
||||
- Fixes issue where theme not applied on load when the settings are hidden
|
||||
- Adds minimum dimensions to modalsShortens readme file
|
||||
- Adds documentation in the docs folder
|
||||
- Adds minimum dimensions to modals
|
||||
|
||||
## 🚑️ 1.1.0 - Hotfix [#18](https://github.com/Lissy93/dashy/pull/18)
|
||||
- Implementing the JSON validator had actually broken the entire JSON editor
|
||||
- Fixed it by remove explicit use of Ajv, and using a derivative instead
|
||||
|
||||
## 📝 1.0.5 - Documentation [PR #16](https://github.com/Lissy93/dashy/pull/16)
|
||||
- Previously there was very little documentation, this release fixed that
|
||||
- Wrote specific docs for:
|
||||
- Getting Started
|
||||
- Configuring
|
||||
- Backup & Restore
|
||||
- Theming
|
||||
- Developing
|
||||
|
||||
## ✨ 1.0.0 - Implements Config Validation [PR #13](https://github.com/Lissy93/dashy/pull/13)
|
||||
- Write a JSON schema for the conf.yml file
|
||||
- Wrote a validation script to compare users config against schema
|
||||
- Adds a formatter to print helpful messages about what needs fixing
|
||||
- Implements validation process into build script
|
||||
- Implements validation process into UI config configurator's validation
|
||||
|
||||
## 🔧 0.9.5 - Brand New Docker Container [PR #12](https://github.com/Lissy93/dashy/pull/12)
|
||||
- With help from several users, a new container based on Alpine is released
|
||||
- A sample Docker Compose script is also written, and docs are updated
|
||||
- A 1-Click button for deploying to Play-with-Docker is added to the Readme
|
||||
|
||||
## ✨ 0.9.0 - Adds Hide Settings Functionality [PR #11](https://github.com/Lissy93/dashy/pull/11)
|
||||
- Enables user to hide settings from UI
|
||||
- Users preference is saved in local storage
|
||||
- User can hide other structural elements of the UI from the config
|
||||
|
||||
## 💄 0.8.5 - Adds new Built-In Themes [PR #9](https://github.com/Lissy93/dashy/pull/9)
|
||||
- Adds Minimal-Dark and Minimal-Light theme
|
||||
- Adds Material-Dark and Material-Light theme
|
||||
- Adds additional theme docs
|
||||
- Adds option for sections to have items too
|
||||
|
||||
## ✨ 0.8.0 - Implements Custom CSS Editor [PR: #8](https://github.com/Lissy93/dashy/pull/8)
|
||||
- Adds a page in the config menu
|
||||
- Adds syntax highlighting, CSS validation and sanitization
|
||||
- Saves users CSS, and applies styles on page load
|
||||
|
||||
## ✨ 0.7.5 - Adds Cloud Backup and Restore Feature [PR #6](https://github.com/Lissy93/dashy/pull/6)
|
||||
- Creates a form for entering backup ID and decryption password
|
||||
- Puts form in modal, and adds button to launch form, with custom icon
|
||||
- Implemented the cryptography stuff for end-to-end data encryption
|
||||
- Wrote and tested the backend, and deployed as a serverless function on CF workers
|
||||
- On the frontend, users input is encrypted, and passed to backend cloud function
|
||||
- Response from the backend is handles appropriately, and message displayed to the user
|
||||
- Implements the restoring from server functionality, with data integrity checks
|
||||
|
||||
## ✨ 0.7.0 - Support for Custom Nav Links [PR #4](https://github.com/Lissy93/dashy/pull/4)
|
||||
- User can add custom nav bar links from the Config Settings menu
|
||||
- Better UI styling to the config menu
|
||||
- New icons inside buttons
|
||||
|
||||
## ✨ 0.6.5 - UI Config Editor [PR #3](https://github.com/Lissy93/dashy/pull/3)
|
||||
Adds the ability for the user to edit their configuration directly from the UI
|
||||
- Edit all section and item data using a rich JSON editor
|
||||
- Download/ backup conf.yml directly from the UI
|
||||
- Edit site meta data: title, description, footer, etc
|
||||
- Reset all locally stored data to the initial state
|
||||
- Also includes a new toast component, for subtle notifications
|
||||
|
||||
## ✨ 0.6.0 - Navbar, Footer and Background Image
|
||||
- Adds option for a custom full-size background image
|
||||
- Made footer customizable
|
||||
- Fixes error being thrown when navbar links are empty
|
||||
|
||||
## ⚡️ 0.5.5 - Improved Theming
|
||||
- Makes more specific color variables, which inherit base vars
|
||||
- Makes it possible for users to write their own theme
|
||||
- Fix some color edge cases
|
||||
- Adds docs for theming
|
||||
|
||||
## ✨ 0.5.0 - Theme Support
|
||||
- Converts all SCSS variables to CSS variables
|
||||
- Implements theme switching functionality
|
||||
- Adds a dropdown menu, enabling user to select theme
|
||||
- Adds an initial theme option to `appConfig.theme`
|
||||
- Saves selected theme to local storage
|
||||
- Wrote a ton of color themes
|
||||
|
||||
## ✨ 0.4.5 - Keyboard Navigation
|
||||
- Implements arrow key navigation
|
||||
|
||||
## ✨ 0.4.0 - Font Awesome Support
|
||||
- Adds support for Font-Awesome icons
|
||||
- Auto-loads font-awesome only when needed
|
||||
- Adds support for SVG icons
|
||||
|
||||
## ✨ 0.3.5 - Opening Method
|
||||
- Shows opening method on hover
|
||||
- Opening method can be specified in config, as `item[n].target`
|
||||
|
||||
## 🔨 0.3.0 - Docker
|
||||
- Writes a Dockerfile
|
||||
|
||||
## 🎨 0.2.5 - Code Quality, Docs and UI
|
||||
- Huge code quality overhaul, now uses AirBnB style ESLint
|
||||
- Adds in-code docs, removes unneeded code, moves reusable helpers into utils dir
|
||||
- Adds a readme, records a demo gif and adds some basic deployment docs
|
||||
- Removes dependencies which are not 100% necessary
|
||||
|
||||
## ✨ 0.2.0 - Collapsible Sections
|
||||
- Implements collapsing functionality, for less used or very long sections
|
||||
- Sections can read default state from `section[n].collapsed` within config
|
||||
- After change, state of each section is stored in local storage
|
||||
|
||||
## ⚡️ 0.1.5 - Search and Navigation
|
||||
- Improves instant search functionality
|
||||
- Implements keyboard navigation for selecting items
|
||||
- Launch selected item with enter, or Ctrl + Enter to open in new tab
|
||||
|
||||
## 🎉 0.1.0 - Init
|
||||
Project started. Forked from [Lissy93/Dash](https://github.com/Lissy93/dash)
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# Code Owners helps give greater control to those who developed a feature
|
||||
# PR's which modify files that you own will be marked as trusted
|
||||
# After developing a feature, you can add yourself as it's owner
|
||||
# Each line starts with file pattern, followed by one or more owners
|
||||
# Codeowners Docs: https://github.blog/2017-07-06-introducing-code-owners/
|
||||
|
||||
# Repo Owners
|
||||
* @lissy93
|
||||
|
||||
# Translations
|
||||
src/assets/locales/fr.json @EVOTk
|
||||
|
||||
# Bot PR Permissions
|
||||
docs/assets/CONTRIBUTORS.svg @liss-bot
|
||||
|
|
@ -0,0 +1,128 @@
|
|||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||
identity and expression, level of experience, education, socio-economic status,
|
||||
nationality, personal appearance, race, religion, or sexual identity
|
||||
and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the
|
||||
overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery, and sexual attention or
|
||||
advances of any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or email
|
||||
address, without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of
|
||||
acceptable behavior and will take appropriate and fair corrective action in
|
||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||
or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||
decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when
|
||||
an individual is officially representing the community in public spaces.
|
||||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
alicia@omg.lol.
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining
|
||||
the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||
unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing
|
||||
clarity around the nature of the violation and an explanation of why the
|
||||
behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series
|
||||
of actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No
|
||||
interaction with the people involved, including unsolicited interaction with
|
||||
those enforcing the Code of Conduct, for a specified period of time. This
|
||||
includes avoiding interactions in community spaces as well as external channels
|
||||
like social media. Violating these terms may lead to a temporary or
|
||||
permanent ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including
|
||||
sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public
|
||||
communication with the community for a specified period of time. No public or
|
||||
private interaction with the people involved, including unsolicited interaction
|
||||
with those enforcing the Code of Conduct, is allowed during this period.
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within
|
||||
the community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 2.0, available at
|
||||
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||
|
||||
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
||||
enforcement ladder](https://github.com/mozilla/diversity).
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
https://www.contributor-covenant.org/faq. Translations are available at
|
||||
https://www.contributor-covenant.org/translations.
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
# Support Dashy's Development!
|
||||
|
||||
github: lissy93
|
||||
custom: ['https://notes.aliciasykes.com/tip']
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
name: "Add your Dashboard to the Showcase \U0001F5BC️"
|
||||
about: Share a screenshot of your dashboard to the Readme showcase!
|
||||
title: "[SHOWCASE_REQUEST]"
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
Please read the instructions here first:
|
||||
https://github.com/Lissy93/dashy/blob/master/docs/showcase.md#submitting-your-dashboard
|
||||
|
||||
### Complete the Following
|
||||
- **Title of Dashboard**:
|
||||
- **Link to Screenshot**:
|
||||
- **Would you like your name/ username included**: Yes/ No
|
||||
- **Link to your Website/ Profile/ Twitter** (optional)
|
||||
- **Description** (optional)
|
||||
|
||||
Either attach your screenshot here, or include a link to the CDN / image hosting service.
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
---
|
||||
name: "Bug Report \U0001F41B"
|
||||
about: Submit a bug report for an issue you've come across
|
||||
title: "[BUG]"
|
||||
labels: "\U0001F41B Bug"
|
||||
assignees: Lissy93
|
||||
|
||||
---
|
||||
|
||||
Thank you for taking the time to raise a bug, and sorry that you've had issues with Dashy 😟
|
||||
|
||||
**If applicable to your issue, please include:**
|
||||
- A description of the bug, including actual behavior and if applicable, expected behavior
|
||||
- Steps to reproduce
|
||||
- Info about your system (device, OS, browser and browser version)
|
||||
- Any console errors? If the issue happens at runtime, open up the dev tools [F12], and go to the Console tab. If the output is very long, please use [0bin](https://0bin.net/)
|
||||
- Any screenshots, if it is a frontend issue
|
||||
|
||||
**Before submitting, please ensure that:**
|
||||
- [ ] This issue has not already been raised
|
||||
- [ ] You are using the latest version of Dashy
|
||||
- [ ] You've included the relevant information above
|
||||
|
|
@ -0,0 +1,64 @@
|
|||
name: Bug Report 🐛
|
||||
description: Report something that's not working the way it's (probably) intended to
|
||||
title: '[BUG] <title>'
|
||||
labels: ['🐛 Bug']
|
||||
assignees:
|
||||
- lissy93
|
||||
body:
|
||||
- type: dropdown
|
||||
id: environment
|
||||
attributes:
|
||||
label: Environment
|
||||
description: Where are you running Dashy?
|
||||
options:
|
||||
- Self-Hosted (Docker)
|
||||
- Self-Hosted (Bare Metal)
|
||||
- Cloud Service (Static)
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: Version
|
||||
description: What version of Dashy are you running?
|
||||
placeholder: 1.6.9 ← should look like this (check config menu)
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
id: repro
|
||||
attributes:
|
||||
label: Describe the problem
|
||||
description: Please describe exactly what is not working, include the steps to reproduce, actual result and expected result
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Additional info
|
||||
description: Logs? Screenshots? Yes, please.
|
||||
placeholder: If the issue happens during build-time, include terminal logs. For run-time errors, include browser logs which you can view in the Dev Tools (F12), under the Console tab. Take care to blank out any personal info.
|
||||
validations:
|
||||
required: false
|
||||
- type: checkboxes
|
||||
id: idiot-check
|
||||
attributes:
|
||||
label: Please tick the boxes
|
||||
description: Before submitting, please ensure that
|
||||
options:
|
||||
- label: You are using a [supported](https://github.com/Lissy93/dashy/blob/master/.github/SECURITY.md#supported-versions) version of Dashy (check the first two digits of the version number)
|
||||
required: true
|
||||
- label: You've checked that this [issue hasn't already been raised](https://github.com/Lissy93/dashy/issues?q=is%3Aissue)
|
||||
required: true
|
||||
- label: You've checked the [docs](https://github.com/Lissy93/dashy/tree/master/docs#readme) and [troubleshooting](https://github.com/Lissy93/dashy/blob/master/docs/troubleshooting.md#troubleshooting) guide
|
||||
required: true
|
||||
- label: You agree to the [code of conduct](https://github.com/Lissy93/dashy/blob/master/.github/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct)
|
||||
required: true
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |-
|
||||
## Thanks 🙏
|
||||
Sorry you are having issues with Dashy, and thank you for raising this ticket - in doing so you are helping to make the app better for everyone 💪
|
||||
You should expect a reply within the next 48 hours :)
|
||||
⭐️ If you are not a bot, please star the repo before submitting your ticket.
|
||||
validations:
|
||||
required: false
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
---
|
||||
name: "Feature Request \U0001F984"
|
||||
about: Suggest an idea for future development of Dashy
|
||||
title: "[FEATURE_REQUEST]"
|
||||
labels: "\U0001F984 Feature Request"
|
||||
assignees: Lissy93
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? If so, please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Priority**:
|
||||
Low: Nice to have / Medium: Would be useful / High: The app does not function without it
|
||||
|
|
@ -0,0 +1,62 @@
|
|||
name: Feature Request ✨
|
||||
description: Suggest an idea for future development of Dashy
|
||||
title: '[FEATURE_REQUEST] <title>'
|
||||
labels: ['🦄 Feature Request']
|
||||
|
||||
body:
|
||||
|
||||
# Field 1 - Is it bug-related
|
||||
- type: textarea
|
||||
id: issue
|
||||
attributes:
|
||||
label: Is your feature request related to a problem? If so, please describe.
|
||||
description:
|
||||
placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
validations:
|
||||
required: false
|
||||
|
||||
# Field 2 - Describe feature
|
||||
- type: textarea
|
||||
id: solution
|
||||
attributes:
|
||||
label: Describe the solution you'd like
|
||||
placeholder: An outline of how you would like this to be implemented, include as much details as possible
|
||||
validations:
|
||||
required: true
|
||||
|
||||
# Field 3 - Priority
|
||||
- type: dropdown
|
||||
id: priority
|
||||
attributes:
|
||||
label: Priority
|
||||
description: How urgent is the development of this feature
|
||||
options:
|
||||
- Low (Nice-to-have)
|
||||
- Medium (Would be very useful)
|
||||
- High (The app does not function without it)
|
||||
validations:
|
||||
required: true
|
||||
|
||||
# Field 3 - Can the user implement
|
||||
- type: dropdown
|
||||
id: canImplement
|
||||
attributes:
|
||||
label: Is this something you would be keen to implement
|
||||
description: Are you raising this ticket in order to get an issue number for your PR?
|
||||
options:
|
||||
- 'No'
|
||||
- 'Maybe'
|
||||
- 'Yes!'
|
||||
validations:
|
||||
required: false
|
||||
|
||||
# Final text
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |-
|
||||
## Thanks 🙏
|
||||
Thank you for your feature suggestion, you should expect a reply within 48 hours :)
|
||||
Please note that there is no guarantee that your idea will be implemented
|
||||
If you haven't already done so, please Star the Dashy's repository on GitHub, to help other users discover it
|
||||
validations:
|
||||
required: false
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
---
|
||||
name: "Question \U0001F937♀️"
|
||||
about: Got a question about Dashy, deployment, development or usage?
|
||||
title: "[QUESTION]"
|
||||
labels: "\U0001F937♂️ Question"
|
||||
assignees: Lissy93
|
||||
|
||||
---
|
||||
|
||||
All questions are welcome :)
|
||||
In the meantime, you might find the answer to your questions in the (recently written) [docs](https://github.com/Lissy93/dashy/tree/master/docs)
|
||||
|
|
@ -0,0 +1,64 @@
|
|||
name: Question 🤷♂️
|
||||
description: Got a question about Dashy, deployment, development or usage?
|
||||
title: '[QUESTION] <title>'
|
||||
labels: ['🤷♂️ Question']
|
||||
|
||||
body:
|
||||
# Filed 1 - Intro Text
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: >
|
||||
Thanks for using Dashy! Questions are welcome, but in the future will be moving over to
|
||||
[Discussions](https://github.com/Lissy93/dashy/discussions) page.
|
||||
Quick questions should be asked [here](https://github.com/Lissy93/dashy/discussions/148) instead.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
# Field 2 - The actual question
|
||||
- type: textarea
|
||||
id: question
|
||||
attributes:
|
||||
label: Question
|
||||
description: Outline your question in a clear and concise manner
|
||||
validations:
|
||||
required: true
|
||||
|
||||
# Field 3 - Category
|
||||
- type: dropdown
|
||||
id: category
|
||||
attributes:
|
||||
label: Category
|
||||
description: What part of the application does this relate to?
|
||||
options:
|
||||
- Setup and Deployment
|
||||
- Configuration
|
||||
- App Usage
|
||||
- Development
|
||||
- Documentation
|
||||
- Alternate Views
|
||||
- Authentication
|
||||
- Using Icons
|
||||
- Widgets
|
||||
- Actions
|
||||
- Language Support
|
||||
- Search & Shortcuts
|
||||
- Status Checking
|
||||
- Theming & Layout
|
||||
validations:
|
||||
required: true
|
||||
|
||||
# Field 4 - User has RTFM first, and agrees to code of conduct, etc
|
||||
- type: checkboxes
|
||||
id: idiot-check
|
||||
attributes:
|
||||
label: Please tick the boxes
|
||||
description: Before submitting, please ensure that
|
||||
options:
|
||||
- label: You are using a [supported](https://github.com/Lissy93/dashy/blob/master/.github/SECURITY.md#supported-versions) version of Dashy (check the first two digits of the version number)
|
||||
required: true
|
||||
- label: You've checked that this [question hasn't already been raised](https://github.com/Lissy93/dashy/issues?q=is%3Aissue)
|
||||
required: true
|
||||
- label: You've checked the [docs](https://github.com/Lissy93/dashy/tree/master/docs#readme) and [troubleshooting](https://github.com/Lissy93/dashy/blob/master/docs/troubleshooting.md#troubleshooting) guide
|
||||
required: true
|
||||
- label: You agree to the [code of conduct](https://github.com/Lissy93/dashy/blob/master/.github/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct)
|
||||
required: true
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
name: Add your Dashboard to the Showcase 🌟
|
||||
description: Share a screenshot of your dashboard to the Readme showcase!
|
||||
title: '[SHOWCASE] <title>'
|
||||
labels: ['💯 Showcase']
|
||||
|
||||
body:
|
||||
# 1 - Title
|
||||
- type: input
|
||||
id: title
|
||||
attributes:
|
||||
label: Title
|
||||
description: Pick a title for your addition
|
||||
placeholder: My Awesome Dashboard
|
||||
validations:
|
||||
required: false
|
||||
# 2 - Link to Screenshot
|
||||
- type: textarea
|
||||
id: screenshot
|
||||
attributes:
|
||||
label: Screenshot
|
||||
description: Either upload your screenshot here, or include a link to a png/jpg on a CDN / image hosting service
|
||||
validations:
|
||||
required: true
|
||||
# 3 - Credit user
|
||||
- type: dropdown
|
||||
id: attribution
|
||||
attributes:
|
||||
label: Would you like your name/ username included?
|
||||
description: This will be displayed above the screenshot to your dashboard in the showcase page
|
||||
options:
|
||||
- 'Yes'
|
||||
- 'No'
|
||||
validations:
|
||||
required: true
|
||||
# 4 - Social links
|
||||
- type: input
|
||||
id: links
|
||||
attributes:
|
||||
label: Link to your Website/ Profile/ Twitter (optional)
|
||||
description: You can optionally have your name link to your profile or website. If you'd like this, include the URL to your site below
|
||||
validations:
|
||||
required: false
|
||||
# 5 - Description
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description (Optional)
|
||||
description: You can optionally also include a short description. If there's anything else you'd like to include, then put it here
|
||||
validations:
|
||||
required: false
|
||||
# 6 - All done
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |-
|
||||
## That's It!
|
||||
Thanks for sharing your dashboard :) You will receive an update to this ticket once it's added to the showcase
|
||||
validations:
|
||||
required: false
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
## ✨ 2.0.9 Adds Multi-Page Support [PR #663](https://github.com/Lissy93/dashy/pull/663)
|
||||
- Fix KeyCloak API URL (#564)
|
||||
- Fix guest has config access (#590)
|
||||
- Fix collapsible content in multi-page support (#626)
|
||||
- Fix layout and item size buttons ( #629)
|
||||
- Refactor make request in RSS widget (#632)
|
||||
- Fix material-design-icons header in schema (#640)
|
||||
- Add option to hide seconds in clock widget (#644)
|
||||
- Fix pageInfo not being read in router (#645)
|
||||
- Fix startingView not honored (#646)
|
||||
- Fix Status Check default (#651)
|
||||
- Add option to hide image in SportsScores Widget (#654)
|
||||
- Add Adventure-basic theme (#655)
|
||||
- Write docs for sub-items (#657)
|
||||
- Add Font-Awesome displaying as square to troubleshooting guide (#659)
|
||||
- Show expand / collapse in context menu (#660)
|
||||
- Only deploy new release when relevant files have changed
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,35 @@
|
|||
|
||||
Security is taken very seriously
|
||||
|
||||
## Supported Versions
|
||||
The current versions, and previous minor versions and / or the past 5 versions are supported. Releases either older than 5 versions, or from the last major version are no longer maintained or monitored, and hence the security of which cannot be guaranteed.
|
||||
|
||||
## Keeping your Instance of Dashy Secure
|
||||
See [Docs: Management - Security](/docs/management.md#securing)
|
||||
|
||||
## Reporting a Security Issue
|
||||
If you think you've found a critical issue, please send an email to `security@mail.alicia.omg.lol`, to encrypt it, you can use [`0688 F8D3 4587 D954 E9E5 1FB8 FEDB 68F5 5C02 83A7`](https://keybase.io/aliciasykes/pgp_keys.asc?fingerprint=0688f8d34587d954e9e51fb8fedb68f55c0283a7). You should receive a response within 48 hours.
|
||||
|
||||
All non-critical issues can be raised as a ticket.
|
||||
|
||||
Please include the following information:
|
||||
- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
|
||||
- Full paths of source file(s) related to the manifestation of the issue
|
||||
- The location of the affected source code (tag/branch/commit or direct URL)
|
||||
- Any special configuration required to reproduce the issue
|
||||
- Step-by-step instructions to reproduce the issue
|
||||
- Proof-of-concept or exploit code (if possible)
|
||||
- Impact of the issue, including how an attacker might exploit the issue
|
||||
|
||||
This info will help with finding and fixing the issue.
|
||||
|
||||
Please use only English.
|
||||
|
||||
## Issues That Should Not Be Raised
|
||||
Please do not raise issues in this repo which relate to Vue or Vue CLI, we're already using the latest versions of these dependencies, so any issues here to be taken up with Vue. The same applies to other dev dependencies that are at the latest version.
|
||||
|
||||
## Known Issues
|
||||
|
||||
> **01/09/2021** - [Inefficient Regular Expression Complexity](https://www.huntr.dev/bounties/1e8f07fc-c384-4ff9-8498-0690de2e8c31/) in Axios (Re: [CWE-1333](https://cwe.mitre.org/data/definitions/1333.html)).
|
||||
|
||||
This ReDos vuln, was raised and fixed by @ready-research in Axios in August 2021. The issue was resolved in [`5b45711`](https://github.com/axios/axios/commit/5b457116e31db0e88fede6c428e969e87f290929), but Snyk sometime just takes a while to show updates. Dashy is using the latest version of Axios, and so is not affected by this issue.
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
# Support
|
||||
|
||||
To report a potential vulnerability, follow the steps in **[Security](https://github.com/Lissy93/dashy/blob/master/.github/SECURITY.md#reporting-a-security-issue)**.
|
||||
|
||||
For setup and usage guides, see **[dashy.to/docs](https://dashy.to/)** or the **[GitHub](https://github.com/Lissy93/dashy)** repo.
|
||||
|
||||
To raise a bug, for something that's not working, **[Open a new Issue](https://github.com/Lissy93/dashy/issues/new/choose)**.
|
||||
|
||||
For help with getting Dashy up and running, please see the **[Discussions](https://github.com/Lissy93/dashy/discussions)**.
|
||||
|
||||
If you'd like to help support Dashy's future development, see **[Contributing](https://github.com/Lissy93/dashy/blob/master/docs/contributing.md)**.
|
||||
|
||||
To get in contact with the author, email me at **`alicia at omg dot lol`** **[[PGP]](https://keybase.io/aliciasykes/pgp_keys.asc?fingerprint=0688f8d34587d954e9e51fb8fedb68f55c0283a7)**.
|
||||
|
||||
-Thank you
|
||||
|
||||
> <sub>Prior to raising a ticket, please check the [docs](https://github.com/Lissy93/dashy/tree/master/docs#readme), [troubleshooting guide](https://github.com/Lissy93/dashy/blob/master/docs/troubleshooting.md) and [previous issues](https://github.com/Lissy93/dashy/issues?q=is%3Aissue).</sub><br><sup>If you're new here, consider also staring the repo before submitting your ticket.</sup>
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
🐛 Bug: ✅ Fixed
|
||||
🦄 Feature Request: ✅ Implemented
|
||||
🤷♂️ Question: ✅ Answered
|
||||
|
|
@ -0,0 +1,63 @@
|
|||
comment:
|
||||
footer: |
|
||||
---
|
||||
> I am a bot, and this is an automated message 🤖
|
||||
labels:
|
||||
- name: ✖️ Invalid
|
||||
labeled:
|
||||
issue:
|
||||
action: close
|
||||
body: >
|
||||
Hello @{{ issue.user.login }} your ticket has been marked as invalid.
|
||||
Please ensure you follow the issue template, provide all requested info,
|
||||
and be sure to check the docs + previous issues prior to raising tickets.
|
||||
pr:
|
||||
body: Thank you @{{ pull_request.user.login }} for suggesting this. Please follow the pull request templates.
|
||||
action: close
|
||||
|
||||
- name: 👩💻 Good First Issue
|
||||
labeled:
|
||||
issue:
|
||||
body: >
|
||||
This issue has been marked as a good first issue for first-time contributors to implement!
|
||||
This is a great way to support the project, while also improving your skills, you'll also be credited as a contributor once your PR is merged.
|
||||
If you're new to web development, [here are a collection of resources](https://dashy.to/docs/developing#resources-for-beginners)
|
||||
to help you get started. You can also find step-by-step tutorials for common tasks within Dashy, on the [Dev Guides](https://dashy.to/docs/development-guides) page.
|
||||
If you need any support at all, feel free to reach out via [GitHub Discussions](https://github.com/Lissy93/dashy/discussions).
|
||||
|
||||
- name: ❌ wontfix
|
||||
labeled:
|
||||
issue:
|
||||
action: close
|
||||
body: >
|
||||
This ticked has been marked as 'wontfix', which usually means it is out-of-scope, or not feasible at this time.
|
||||
You can still fork the project and make the changes yourself, for support in doing so, please reference the [Developing Docs](https://dashy.to/docs/developing).
|
||||
|
||||
- name: ✅ Fixed
|
||||
labeled:
|
||||
issue:
|
||||
body: >
|
||||
Hello @{{ issue.user.login }}! It looks like all or part of this issue has now been implemented :)
|
||||
If you're enjoying Dashy, please consider supporting the project- for ways to get involved, see [Contributing](https://dashy.to/docs/contributing) 💖
|
||||
|
||||
- name: ‼️ High Priority
|
||||
labeled:
|
||||
issue:
|
||||
body: >
|
||||
This ticket has been marked as high priority, and has been bumped to the top of the priority list.
|
||||
You should expect an implementation to be pushed out within the next 7 days. Thank you for your patience.
|
||||
|
||||
- name: 💀 Spam
|
||||
labeled:
|
||||
issue:
|
||||
action: close
|
||||
locking: lock
|
||||
lock_reason: spam
|
||||
body: >
|
||||
This issue has been identified as spam, and is now locked.
|
||||
Users who repeatedly raise spam issues may be blocked or reported.
|
||||
|
||||
- name: ⛔ Don't Merge
|
||||
labeled:
|
||||
pr:
|
||||
body: This PR has been temporarily blocked from merging.
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
[
|
||||
{
|
||||
"section": "Feature Requests",
|
||||
"labels": [
|
||||
"🦄 Feature Request"
|
||||
],
|
||||
"threshold": 100
|
||||
},
|
||||
{
|
||||
"section": "Bugs",
|
||||
"labels": [
|
||||
"🐛 Bug"
|
||||
],
|
||||
"threshold": 100
|
||||
},
|
||||
{
|
||||
"section": "Questions & Feedback",
|
||||
"labels": [
|
||||
"🤷♂️ Question",
|
||||
"🌈 Feedback"
|
||||
],
|
||||
"threshold": 100
|
||||
}
|
||||
]
|
||||
|
|
@ -0,0 +1,135 @@
|
|||
comment:
|
||||
on-update: edit
|
||||
header: |
|
||||
Hi {{ prAuthor }}! Thank you for contributing to Dashy! ✨
|
||||
footer: |
|
||||
---
|
||||
> I'm a bot, and this is an automated comment 🤖
|
||||
snippets:
|
||||
- id: docs-changes
|
||||
files:
|
||||
- docs/**.md
|
||||
body: |
|
||||
When making changes to the documentation, be sure to double check that:
|
||||
- Link and images URLs properly resolve
|
||||
- Your spelling and grammar is correct
|
||||
- Any markdown formatting is valid
|
||||
|
||||
- id: vue-config
|
||||
files:
|
||||
- vue.config.js
|
||||
body: >
|
||||
You're making changes to the main Vue app config. Please test the app thoroughly,
|
||||
as any misconfigurations here may cause the app to stop functioning.
|
||||
|
||||
- id: server-entry
|
||||
files:
|
||||
- server.js
|
||||
body: >
|
||||
You're making changes to the main server entry point. Please test the app thoroughly,
|
||||
as any misconfigurations here may cause the app to stop functioning.
|
||||
|
||||
- id: dependency-changes
|
||||
files:
|
||||
- yarn.lock
|
||||
body: >
|
||||
When updating dependencies, take a moment to verify that there are not security
|
||||
issues associated with any added or modified packages. If adding a new dependency,
|
||||
ensure that it is totally necessary, and check the packages size is not too large,
|
||||
as this will increase overall bundle size.
|
||||
|
||||
- id: environmental-vars
|
||||
files: [ '.env', '*.env', '.env*' ]
|
||||
body: >
|
||||
You're making changes to the main server entry point. Please test the app thoroughly,
|
||||
as any misconfigurations here may cause the app to stop functioning.
|
||||
|
||||
- id: license
|
||||
files: [ 'LICENSE', '**/**/LICENSE*' ]
|
||||
body: >
|
||||
Dashy is licensed under MIT. Your modifying the license file, which shouldn't usually
|
||||
need to be changed. Please ensure that you intended to make this update before continuing.
|
||||
|
||||
- id: cname-file
|
||||
files:
|
||||
- CNAME
|
||||
body: >
|
||||
Are you sure you want to modify the CNAME file? This may stop the documentation
|
||||
website hosted on GitHub pages from working.
|
||||
|
||||
- id: git-ignore
|
||||
files:
|
||||
- .gitignore
|
||||
body: >
|
||||
When modifying the .gitignore, please do not remove any of the existing paths,
|
||||
as this may cause files and directories to be unintentionally committed to git
|
||||
|
||||
- id: netlify-file
|
||||
files:
|
||||
- netlify.toml
|
||||
body: >
|
||||
Please ensure you've tested the app on Netlify, so that the 1-Click deployment
|
||||
does not break, before merging these changes
|
||||
|
||||
- id: heroku-ignore
|
||||
files:
|
||||
- Procfile
|
||||
body: >
|
||||
Please ensure you've tested the app on Heroku, so that the 1-Click deployment
|
||||
does not break, before merging these changes
|
||||
|
||||
- id: ignored-dist
|
||||
files:
|
||||
- dist/**/*
|
||||
body: >
|
||||
Please do not commit the built application to git. The contents of the dist
|
||||
directory will be generated after the app is compiled
|
||||
|
||||
- id: ignored-dependencies
|
||||
files:
|
||||
- node_modules/**/*
|
||||
body: >
|
||||
Please do not commit dependencies to git. Node modules will be pulled down
|
||||
when yarn is run, prior to building the app
|
||||
|
||||
- id: user-themes
|
||||
files:
|
||||
- src/styles/user-defined-themes.scss
|
||||
body: >
|
||||
Please do not commit changes to this file, as it is intended to be overridden with Docker.
|
||||
You can instead add your styles to the color-themes file, or for element-specific styles
|
||||
put it within the appropriate component. Thank you
|
||||
|
||||
- id: code-owners
|
||||
files:
|
||||
- .github/CODEOWNERS
|
||||
body: >
|
||||
Are you adding yourself as a code owner? Please specify the file path as specific
|
||||
as possible, and only assign yourself to files that you created and wish to help
|
||||
maintain (such as a language file, specific feature or widget).
|
||||
If the above is not met, your PR will be declined or modified.
|
||||
|
||||
- id: config-schema
|
||||
files:
|
||||
- src/utils/ConfigSchema.json
|
||||
body: >
|
||||
Don't forget to verify they the config validator script responds correctly to
|
||||
your new attribute.
|
||||
|
||||
- id: showcase
|
||||
files:
|
||||
- docs/showcase.md
|
||||
body: >
|
||||
Thank you for adding your dashboard to the showcase! 🌟
|
||||
|
||||
- id: translations
|
||||
files:
|
||||
- src/assets/locales/**.json
|
||||
body: >
|
||||
Thank you for contributing to Dashy's translations 💖
|
||||
|
||||
- id: themes
|
||||
files:
|
||||
- src/styles/color-themes.scss
|
||||
body: >
|
||||
Thank you for contributing to Dashy's themes 🎨
|
||||
|
|
@ -0,0 +1,145 @@
|
|||
# Config file for pull-request-badge. See: https://pullrequestbadge.com/ by @stefanbuck
|
||||
# Dynamically inserts status badges into PR description, based on certain conditions
|
||||
|
||||
# Show submitting user's username and profile link
|
||||
- label: 💕 Submitted by
|
||||
message: $payload.pull_request.user.login
|
||||
color: '#f73ae6'
|
||||
when: $payload.pull_request.author_association !== 'OWNER'
|
||||
url: 'https://github.com/$payload.pull_request.user.login'
|
||||
|
||||
# Show a badge indicating the PR category, based on tag
|
||||
- label: Type
|
||||
message: ✨ Feature
|
||||
color: '#39b0fd'
|
||||
when: $labels.includes('✨ New Feature')
|
||||
- label: Type
|
||||
message: 🐛 Fix
|
||||
color: '#39b0fd'
|
||||
when: $labels.includes('🦋 Bug Fix')
|
||||
- label: Type
|
||||
message: 📕 Docs
|
||||
color: '#39b0fd'
|
||||
when: $labels.includes('📕 Docs')
|
||||
- label: Type
|
||||
message: 🛠️ Build Changes
|
||||
color: '#39b0fd'
|
||||
when: $labels.includes('🛠️ Build Changes')
|
||||
- label: Type
|
||||
message: 🛠️ Build Changes
|
||||
color: '#39b0fd'
|
||||
when: $labels.includes('🛠️ Build Changes')
|
||||
- label: Type
|
||||
message: 🚚 Refactor
|
||||
color: '#39b0fd'
|
||||
when: $labels.includes('🚚 Refactor')
|
||||
- label: Type
|
||||
message: 💄 Stylistic Changes
|
||||
color: '#39b0fd'
|
||||
when: $labels.includes('💄 Stylistic Changes')
|
||||
- label: Type
|
||||
message: 🌟 Showcase Addition
|
||||
color: '#39b0fd'
|
||||
when: $labels.includes('💯 Showcase')
|
||||
- label: Type
|
||||
message: 🏗️ Architecture
|
||||
color: '#39b0fd'
|
||||
when: $labels.includes('🏗️ Architectural Changes')
|
||||
- label: Type
|
||||
message: 🤖 Auto Submission
|
||||
color: '#39b0fd'
|
||||
when: $labels.includes('🤖 Auto')
|
||||
- label: Type
|
||||
message: 🌐 Language Update
|
||||
color: '#39b0fd'
|
||||
when: $labels.includes('🌐 Language')
|
||||
|
||||
# Add size label based on very large or tiny PRs
|
||||
- label: PR Size
|
||||
message: Extra Large
|
||||
color: '#f9833e'
|
||||
when: '$additions > 1000'
|
||||
- label: PR Size
|
||||
message: Large
|
||||
color: '#f4b546'
|
||||
when: '$additions > 500 && $additions < 1000'
|
||||
- label: PR Size
|
||||
message: Medium
|
||||
color: '#f3ff59'
|
||||
when: '$additions > 10 && $additions < 500'
|
||||
- label: PR Size
|
||||
message: Quick
|
||||
color: '#3eef8b'
|
||||
when: '$additions < 10'
|
||||
|
||||
# Show badge indicating PR status
|
||||
- label: Status
|
||||
message: ✏️ Draft
|
||||
when: $isDraft
|
||||
color: '#ffa933'
|
||||
- label: Status
|
||||
message: 🧱 Work in Progress
|
||||
when: $payload.pull_request.title.includes('WIP')
|
||||
color: '#29e3f4'
|
||||
- label: Status
|
||||
message: ✅ Ready
|
||||
color: '#3ef963'
|
||||
when: $labels.includes('🔀 Ready for Merge')
|
||||
|
||||
# Show PR number, to destination and from destination
|
||||
- label: '#$prNumber'
|
||||
message: '$payload.pull_request.user.login /$payload.pull_request.head.ref → $payload.repository.full_name'
|
||||
color: '#ab5afc'
|
||||
url: 'https://github.com/$slug/tree/$branchName'
|
||||
|
||||
# Show total code added minus deleted
|
||||
- label: New Code
|
||||
message: 'Commits: $payload.pull_request.commits | Files Changed: $payload.pull_request.changed_files | Additions: $payload.pull_request.additions-$payload.pull_request.deletions'
|
||||
color: '#dddd00'
|
||||
|
||||
# Checks if the required sections are missing
|
||||
- label: ⚠️Missing
|
||||
message: Category
|
||||
color: '#f25265'
|
||||
when: $payload.pull_request.body.includes('Category') === false
|
||||
- label: ⚠️Missing
|
||||
message: Overview
|
||||
color: '#f25265'
|
||||
when: $payload.pull_request.body.includes('Overview') === false
|
||||
- label: ⚠️Missing
|
||||
message: Quality Checklist
|
||||
color: '#f25265'
|
||||
when: $payload.pull_request.body.includes('Code Quality Checklist') === false
|
||||
- label: ⚠️Description
|
||||
message: Incomplete
|
||||
color: '#f25265'
|
||||
when: $payload.pull_request.body.length < 25
|
||||
- label: ⚠️Missing
|
||||
message: Label
|
||||
color: '#f25265'
|
||||
when: $labels.length == 0
|
||||
|
||||
# Show note when task list has unfinished items
|
||||
- label: ⚠️Notice
|
||||
message: Unchecked Tasks
|
||||
when: $payload.pull_request.body.includes('- [ ] ')
|
||||
color: '#f25265'
|
||||
|
||||
# Show warning, when certain tags are applied
|
||||
- label: Warning
|
||||
message: ⛔ Do Not Merge
|
||||
color: '#f25265'
|
||||
when: $labels.includes("⛔ Don't Merge")
|
||||
- label: Warning
|
||||
message: 🚫 Merge Conflicts
|
||||
color: '#f25265'
|
||||
when: $labels.includes('🚫 Merge Conflicts')
|
||||
- label: Warning
|
||||
message: 🕸️ Inactive
|
||||
color: '#f25265'
|
||||
when: $labels.includes('🕸️ Inactive')
|
||||
- label: Warning
|
||||
message: 💀 Spam
|
||||
color: '#f25265'
|
||||
when: $labels.includes('💀 Spam')
|
||||
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
# PR labels and the branch patterns they should be auto-assigned to
|
||||
✨ New Feature: ['FEATURE/*', 'FEAT/*']
|
||||
🚚 Refactor: ['IMPROVMENTS/*', 'REFACTOR/*']
|
||||
🦋 Bug Fix: ['FIX/*', 'HOT-FIX/*', 'BUG-FIX/*']
|
||||
💯 Showcase: ['SHOWCASE/*', 'SHOWCASE_SUBMISSION/*']
|
||||
💄 Stylistic Changes: ['STYLES/*', 'THEME/*', 'UI/*']
|
||||
🏗️ Architectural Changes: ['ARCH/*', 'ARCHITECTURE/*']
|
||||
🛠️ Build Changes: ['DOCKER/*', 'BUILD/*', 'CI/*', 'ACTIONS/*']
|
||||
🌐 Language: ['LANG/*', 'INTERNATIONALIZATION/*', 'I18N/*', 'TEXT-UPDATE/*']
|
||||
🤖 Auto: ['AUTO/*', 'BOT/*', 'snyk-upgrade-*', 'snyk-fix-*']
|
||||
⛔ Don't Merge: ['WEBSITE/*', 'EXPERIMENT/*', 'DEPLOY/*', 'deploy_*', 'gh-pages', 'dev-demo']
|
||||
|
|
@ -20,4 +20,5 @@
|
|||
- [ ] There are no (new) build warnings or errors
|
||||
- [ ] _(If a new config option is added)_ Attribute is outlined in the schema and documented
|
||||
- [ ] _(If a new dependency is added)_ Package is essential, and has been checked out for security or performance
|
||||
- [ ] Bumps version, if new feature added
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,27 @@
|
|||
# Based on a label applied to an issue, the bot will add a comment with some additional info
|
||||
name: 🎯 Auto-Reply to Labeled Tickets
|
||||
on:
|
||||
issues:
|
||||
types:
|
||||
- labeled
|
||||
- unlabeled
|
||||
pull_request_target:
|
||||
types:
|
||||
- labeled
|
||||
- unlabeled
|
||||
permissions:
|
||||
contents: read
|
||||
issues: write
|
||||
pull-requests: write
|
||||
|
||||
jobs:
|
||||
comment:
|
||||
runs-on: ubuntu-20.04
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
- name: Label Commenter
|
||||
uses: peaceiris/actions-label-commenter@v1
|
||||
with:
|
||||
config_file: .github/issue-auto-comments.yml
|
||||
github_token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# When a PR is merged, any associated issues will have a Done label applied
|
||||
# The label will depend on the issue type, see: ./github/close-label.yml
|
||||
name: 💡 Apply Done Label
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, merged, closed]
|
||||
jobs:
|
||||
triage:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: logerfo/close-label@0.0.4
|
||||
with:
|
||||
repo-token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
# Automatically assigns the author as a reviewer to opened PRs and issues
|
||||
name: 💡 Auto-Assign Author to PR
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened]
|
||||
issues:
|
||||
types: [opened]
|
||||
jobs:
|
||||
assign-author:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Assign author
|
||||
uses: technote-space/assign-author@v1
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
# When a '/rebase' comment is added to a PR, it will be rebased from the main branch
|
||||
name: 🏗️ Automatic PR Rebase
|
||||
on:
|
||||
issue_comment:
|
||||
types: [created]
|
||||
jobs:
|
||||
rebase:
|
||||
name: Rebase
|
||||
if: >
|
||||
github.event.issue.pull_request != ''
|
||||
&& contains(github.event.comment.body, '/rebase')
|
||||
&& github.event.comment.author_association == 'MEMBER'
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
fetch-depth: 0
|
||||
- name: Rebase
|
||||
uses: cirrus-actions/rebase@1.4
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
# Creates a new tag, whenever the app version (in package.json) is updated in master
|
||||
# And marks any relevant issues as fixed
|
||||
name: 🏗️ Release Tag new Versions
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
jobs:
|
||||
tag-pre-release:
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
tag: ${{ steps.autotag.outputs.tagname }}
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: butlerlogic/action-autotag@stable
|
||||
id: autotag
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
strategy: package
|
||||
commit_message_template: "🔖 {{number}} {{message}} (by {{author}})\nSHA: {{sha}}\n."
|
||||
github-release:
|
||||
runs-on: ubuntu-latest
|
||||
needs: tag-pre-release
|
||||
if: ${{ needs.tag-pre-release.outputs.tag }}
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: ncipollo/release-action@v1
|
||||
with:
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
tag: ${{ needs.tag-pre-release.outputs.tag }}
|
||||
bodyFile: ".github/LATEST_CHANGELOG.md"
|
||||
mark-issue-fixed:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Label Fixed Issues
|
||||
uses: gh-bot/fix-labeler@master
|
||||
with:
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
label: '✅ Fixed'
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# Updates multiple issues with a certain tag, with a comment containing a given message
|
||||
name: 🎯 Broadcast Message across Issues
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
message: { required: false }
|
||||
labels: { required: false }
|
||||
jobs:
|
||||
broadcast:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: jenschelkopf/broadcast-action@master
|
||||
with:
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
# This action builds and deploys the master branch
|
||||
name: Deploy demo of current version
|
||||
name: 🏗️ Build App to Branch
|
||||
on:
|
||||
push:
|
||||
branches: [ master ]
|
||||
|
|
@ -18,6 +18,7 @@ jobs:
|
|||
npm run build
|
||||
- name: Deploy 🚀
|
||||
uses: JamesIves/github-pages-deploy-action@4.1.4
|
||||
if: ${{ github.repository_owner == 'lissy93' }}
|
||||
with:
|
||||
branch: dev-demo
|
||||
folder: dist
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# Caches artifacts, including NPM dependencies, to speed up build times
|
||||
name: 🏗️ Caching Artifacts
|
||||
on: push
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/cache@v2
|
||||
with:
|
||||
path: ~/.npm
|
||||
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-node-
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# Attempts to auto-detect weather an issue is a duplicate, and adds a comment
|
||||
name: 🎯 Issue Duplicate Check
|
||||
on:
|
||||
issues:
|
||||
types: [opened, edited]
|
||||
jobs:
|
||||
check-duplicate:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: wow-actions/potential-duplicates@v1
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
filter: ''
|
||||
exclude: '[BUG] [QUESTION] [FEEDBACK] [SHOWCASE]'
|
||||
label: '🕸️ Potential Duplicate'
|
||||
state: all
|
||||
threshold: 0.75
|
||||
reactions: 'eyes'
|
||||
comment: >
|
||||
Potential duplicates: {{#issues}}
|
||||
- [#{{ number }}] {{ title }} ({{ accuracy }}%)
|
||||
{{/issues}}
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
# Detect and label pull requests that have merge conflicts
|
||||
name: 🏗️ Check Merge Conflicts
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
jobs:
|
||||
check-conflicts:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: mschilde/auto-label-merge-conflicts@master
|
||||
with:
|
||||
CONFLICT_LABEL_NAME: "🚫 Merge Conflicts"
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
MAX_RETRIES: 5
|
||||
WAIT_MS: 5000
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
# Close any issue that does not match any of the issue templates
|
||||
name: 🎯 Close Incomplete Issues
|
||||
on:
|
||||
issues:
|
||||
types: [opened, edited]
|
||||
jobs:
|
||||
auto_close_issues:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v1
|
||||
- name: Automatically close issues that don't follow the issue template
|
||||
uses: lucasbento/auto-close-issues@v1.0.2
|
||||
with:
|
||||
github-token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
closed-issues-label: '🙁 Auto-Closed'
|
||||
issue-close-message: |
|
||||
Hello @${issue.user.login} 👋
|
||||
Unfortunately your issue does not follow the format outlined in the template, and has therefore been auto-closed.
|
||||
To ensure that all relevant info is included, please either update or recreate your issue, and complete the sub-headings provided.
|
||||
Thank you :)
|
||||
|
|
@ -0,0 +1,79 @@
|
|||
# Closes any issues that no longer have user interaction
|
||||
name: 🎯 Close Stale Issues
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: '0 1 * * *' # Run at 01:00 each day
|
||||
jobs:
|
||||
stale:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
# Comment on, then close issues that haven't been updated for ages
|
||||
- name: Close Stale Issues
|
||||
uses: actions/stale@v4
|
||||
with:
|
||||
repo-token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
days-before-stale: 30
|
||||
days-before-close: 5
|
||||
operations-per-run: 30
|
||||
remove-stale-when-updated: true
|
||||
enable-statistics: true
|
||||
stale-issue-message: >
|
||||
This issue has gone 6 weeks without an update. To keep the ticket open, please indicate that it is still relevant in a comment below.
|
||||
Otherwise it will be closed in 5 working days.
|
||||
stale-pr-message: >
|
||||
This PR is stale because it has been open 6 weeks with no activity. Either remove the stale label or comment below with a short update,
|
||||
otherwise this PR will be closed in 5 days.
|
||||
close-issue-message: >
|
||||
This issue was automatically closed because it has been stalled for over 6 weeks with no activity.
|
||||
close-pr-message: >
|
||||
This pull request was automatically closed because it has been stalled for over 6 weeks with no activity.
|
||||
stale-issue-label: '⚰️ Stale'
|
||||
close-issue-label: '🕸️ Inactive'
|
||||
stale-pr-label: '⚰️ Stale'
|
||||
close-pr-label: '🕸️ Inactive'
|
||||
exempt-issue-labels: '📌 Keep Open'
|
||||
exempt-pr-labels: '📌 Keep Open'
|
||||
labels-to-add-when-unstale: '📌 Keep Open'
|
||||
|
||||
# Comment on, then close issues that required a response from the user, but didn't get one
|
||||
- name: Close Issues without Response
|
||||
uses: actions/stale@v4
|
||||
with:
|
||||
repo-token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
days-before-stale: 5
|
||||
days-before-close: 3
|
||||
operations-per-run: 30
|
||||
remove-stale-when-updated: true
|
||||
stale-issue-message: >
|
||||
Hello! Looks like additional info is required for this issue to be addressed.
|
||||
Don't forget to provide this within the next few days to keep your ticket open.
|
||||
close-issue-message: 'Issue closed due to no response from user.'
|
||||
only-labels: '🚏 Awaiting User Response'
|
||||
labels-to-remove-when-unstale: '🚏 Awaiting User Response, 🛑 No Response'
|
||||
stale-issue-label: '🛑 No Response'
|
||||
close-issue-label: '🕸️ Inactive'
|
||||
exempt-issue-labels: '📌 Keep Open'
|
||||
exempt-pr-labels: '📌 Keep Open'
|
||||
|
||||
# Comment on issues that I should have replied to
|
||||
- name: Notify Repo Owner to Respond
|
||||
uses: actions/stale@v4
|
||||
with:
|
||||
repo-token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
days-before-stale: 7
|
||||
days-before-close: 365
|
||||
operations-per-run: 30
|
||||
remove-stale-when-updated: true
|
||||
stale-issue-message: Hey @Lissy93 - Don't forget to respond!
|
||||
stale-pr-message: Hey @Lissy93 - Don't forget to respond!
|
||||
only-labels: '👤 Awaiting Maintainer Response'
|
||||
labels-to-remove-when-unstale: '👤 Awaiting Maintainer Response'
|
||||
close-issue-message: 'Closed due to no response from repo author for over a year'
|
||||
close-pr-message: 'Closed due to no response from repo author for over a year'
|
||||
stale-issue-label: '👤 Awaiting Maintainer Response'
|
||||
stale-pr-label: '👤 Awaiting Maintainer Response'
|
||||
close-issue-label: '🕸️ Inactive'
|
||||
close-pr-label: '🕸️ Inactive'
|
||||
exempt-issue-labels: '📌 Keep Open'
|
||||
exempt-pr-labels: '📌 Keep Open'
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# Lints code merged into master branch
|
||||
name: 🌈 Lint Code Base
|
||||
on:
|
||||
pull_request:
|
||||
branches: [master]
|
||||
jobs:
|
||||
build:
|
||||
name: Lint Code Base
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Code
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Lint Code Base
|
||||
uses: github/super-linter@v4
|
||||
env:
|
||||
VALIDATE_ALL_CODEBASE: false
|
||||
DEFAULT_BRANCH: master
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
# Finds typos in the English language within the app, submits a PR with fixes
|
||||
name: 🌈 Spelling Auto-Fix
|
||||
on:
|
||||
push:
|
||||
branches: [ master ]
|
||||
pull_request:
|
||||
types: [opened]
|
||||
workflow_dispatch:
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
if: startsWith(github.head_ref, 'AUTO/') == false
|
||||
uses: actions/checkout@v2
|
||||
- name: Spell Check
|
||||
if: startsWith(github.head_ref, 'AUTO/') == false
|
||||
uses: sobolevn/misspell-fixer-action@master
|
||||
- name: Create PR
|
||||
uses: peter-evans/create-pull-request@v3.10.1
|
||||
if: startsWith(github.head_ref, 'AUTO/') == false
|
||||
with:
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
base: master
|
||||
commit-message: ':pencil2: Auto-fix typos in text'
|
||||
title: '[AUTO] Fix spelling and language'
|
||||
branch: 'AUTO/spelling-corrections'
|
||||
committer: 'Liss-Bot <alicia-gh-bot@mail.as93.net>'
|
||||
assignees: Lissy93
|
||||
reviewers: Lissy93
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
# Shows changes to any yarn.lock in PR comment
|
||||
# Useful for easily understanding dependency changes and consequences
|
||||
name: 💡 Show Dependency Changes
|
||||
on: [pull_request]
|
||||
jobs:
|
||||
check:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
- name: Yarn Lock Changes
|
||||
uses: Simek/yarn-lock-changes@main
|
||||
with:
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
collapsibleThreshold: '25'
|
||||
failOnDowngrade: 'false'
|
||||
path: 'yarn.lock'
|
||||
updateComment: 'true'
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
# Scans, builds and releases a multi-architecture docker image
|
||||
name: 🐳 Build + Publish Multi-Platform Image
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches: ['master']
|
||||
tags: [v*]
|
||||
paths:
|
||||
- '**.js'
|
||||
- 'src/**'
|
||||
- 'public/**'
|
||||
- 'services/**'
|
||||
|
||||
env:
|
||||
DH_IMAGE: ${{ secrets.DOCKER_REPO }}
|
||||
GH_IMAGE: ${{ github.repository_owner }}/${{ github.event.repository.name }}
|
||||
|
||||
jobs:
|
||||
docker:
|
||||
runs-on: ubuntu-latest
|
||||
permissions: { contents: read, packages: write }
|
||||
if: "!contains(github.event.head_commit.message, '[ci-skip]')"
|
||||
|
||||
steps:
|
||||
- name: 🛎️ Checkout Repo
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: 🔖 Get App Version
|
||||
uses: tyankatsu0105/read-package-version-actions@v1
|
||||
id: package-version
|
||||
|
||||
# - name: ✨ Validate Dockerfile
|
||||
# uses: ghe-actions/dockerfile-validator@v1
|
||||
# with:
|
||||
# dockerfile: 'Dockerfile'
|
||||
# lint: 'hadolint'
|
||||
|
||||
- name: 🗂️ Make Docker Meta
|
||||
id: meta
|
||||
uses: docker/metadata-action@v3
|
||||
with:
|
||||
images: |
|
||||
${{ env.DH_IMAGE }}
|
||||
ghcr.io/${{ env.GH_IMAGE }}
|
||||
${{ secrets.ACR_SERVER }}/${{ secrets.ACR_USERNAME }}
|
||||
tags: |
|
||||
type=ref,event=tag,prefix=release-,suffix={{tag}}
|
||||
type=semver,pattern={{raw}},value=${{ steps.package-version.outputs.version }}
|
||||
labels: |
|
||||
maintainer=Lissy93
|
||||
org.opencontainers.image.title=Dashy
|
||||
org.opencontainers.image.description=A self-hosted startpage for your server
|
||||
org.opencontainers.image.documentation=https://dashy.to/docs
|
||||
org.opencontainers.image.authors=Alicia Sykes
|
||||
org.opencontainers.image.licenses=MIT
|
||||
|
||||
- name: 🔧 Set up QEMU
|
||||
uses: docker/setup-qemu-action@v1
|
||||
|
||||
- name: 🔧 Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v1
|
||||
|
||||
- name: 🔑 Login to DockerHub
|
||||
uses: docker/login-action@v1
|
||||
with:
|
||||
username: ${{ secrets.DOCKER_USERNAME }}
|
||||
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||
|
||||
- name: 🔑 Login to GitHub Container Registry
|
||||
uses: docker/login-action@v1
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.repository_owner }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: 🔑 Login to Azure Container Registry
|
||||
uses: docker/login-action@v1
|
||||
with:
|
||||
registry: ${{ secrets.ACR_SERVER }}
|
||||
username: ${{ secrets.ACR_USERNAME }}
|
||||
password: ${{ secrets.ACR_PASSWORD }}
|
||||
|
||||
- name: 🚦 Check Registry Status
|
||||
uses: crazy-max/ghaction-docker-status@v1
|
||||
|
||||
- name: ⚒️ Build and push
|
||||
uses: docker/build-push-action@v2
|
||||
with:
|
||||
context: .
|
||||
file: ./Dockerfile
|
||||
platforms: linux/amd64,linux/arm64,linux/arm/v7
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
||||
labels: ${{ steps.meta.outputs.labels }}
|
||||
push: true
|
||||
|
||||
# - name: 💬 Set Docker Hub Description
|
||||
# uses: peter-evans/dockerhub-description@v2
|
||||
# with:
|
||||
# repository: lissy93/dashy
|
||||
# readme-filepath: ./docker/docker-readme.md
|
||||
# short-description: Dashy - A self-hosted start page for your server
|
||||
# username: ${{ secrets.DOCKER_USERNAME }}
|
||||
# password: ${{ secrets.DOCKER_USER_PASS }}
|
||||
|
||||
|
|
@ -0,0 +1,63 @@
|
|||
# Builds a Docker image from with latest tag when master branch is updated
|
||||
# The publishes it to GitHub container registry as a package
|
||||
name: 🏗️ Build + Publish Docker Image to GHCR
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches: ['master']
|
||||
tags: [v*]
|
||||
env:
|
||||
REGISTRY: ghcr.io
|
||||
IMAGE_NAME: dashy
|
||||
jobs:
|
||||
build-and-push-image:
|
||||
runs-on: ubuntu-latest
|
||||
if: "!contains(github.event.head_commit.message, '[ci-skip]')"
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
steps:
|
||||
# Fetch the code
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: Prepare
|
||||
id: prep
|
||||
run: echo ::set-output name=version::${GITHUB_REF##*/}
|
||||
|
||||
# Use QEMU for multi-architecture builds
|
||||
- name: Set up QEMU
|
||||
uses: docker/setup-qemu-action@v1
|
||||
with:
|
||||
platforms: all
|
||||
|
||||
# # Use Moby BuildKit
|
||||
# - name: Set up Docker Buildx
|
||||
# id: buildx
|
||||
# uses: docker/setup-buildx-action@v1
|
||||
# with:
|
||||
# install: true
|
||||
# version: latest
|
||||
# driver-opts: image=moby/buildkit:master
|
||||
|
||||
# Login into GH container registry
|
||||
- name: Log in to registry
|
||||
run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
|
||||
|
||||
# Build the image from default Dockerfile
|
||||
- name: Build image
|
||||
run: docker build . --file docker/Dockerfile-multi-arch --tag $IMAGE_NAME --label "runnumber=${GITHUB_RUN_ID}"
|
||||
|
||||
# Push build image
|
||||
- name: Push image
|
||||
run: |
|
||||
IMAGE_ID=ghcr.io/${{ github.repository_owner }}/$IMAGE_NAME
|
||||
IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]')
|
||||
VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
|
||||
[[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
|
||||
[ "$VERSION" == "master" ] && VERSION=latest
|
||||
echo IMAGE_ID=$IMAGE_ID
|
||||
echo VERSION=$VERSION
|
||||
docker tag $IMAGE_NAME $IMAGE_ID:$VERSION
|
||||
docker push $IMAGE_ID:$VERSION
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
# Checks for any broken links in the docs, and raises an issue if found
|
||||
name: 🌈 Broken Link Checker
|
||||
on:
|
||||
repository_dispatch:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: '0 1 1 * *' # Run monthly
|
||||
jobs:
|
||||
link-checker:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Load Excludes
|
||||
run: |
|
||||
LYCHEE_EXCLUDE=$(sed -e :a -e 'N;s/\n/ /;ta' .github/.lycheeexclude)
|
||||
echo "LYCHEE_EXCLUDE=$LYCHEE_EXCLUDE" >> $GITHUB_ENV
|
||||
|
||||
- name: Check for Broken Links
|
||||
uses: lycheeverse/lychee-action@v1.0.8
|
||||
with:
|
||||
args: --verbose -a 200,302,304,429 --exclude ${{ env.LYCHEE_EXCLUDE }} --exclude-mail --no-progress **/*.md
|
||||
env:
|
||||
GITHUB_TOKEN: ${{secrets.BOT_GITHUB_TOKEN}}
|
||||
LYCHEE_OUT: .github/broken-link-report.md
|
||||
|
||||
- name: Raise an Issue with Results
|
||||
uses: peter-evans/create-issue-from-file@v3
|
||||
with:
|
||||
token: ${{secrets.BOT_GITHUB_TOKEN}}
|
||||
title: '[DOCS] Broken Links found in Documentation'
|
||||
content-filepath: .github/broken-link-report.md
|
||||
labels: '📕 Docs, 👩💻 Good First Issue, 💤 Low Priority, 🤖 Auto'
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
name: 📕 Check Docs Domain Expiry
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: '0 1 * * 0' # At 01:00 on Sunday.
|
||||
jobs:
|
||||
check-domain:
|
||||
runs-on: ubuntu-latest
|
||||
name: Check domain
|
||||
strategy:
|
||||
matrix:
|
||||
domain:
|
||||
- https://dashy.to
|
||||
steps:
|
||||
- name: Check domain SSL and registry expire date
|
||||
id: check-domain
|
||||
uses: codex-team/action-check-domain@v1
|
||||
with:
|
||||
url: ${{ matrix.domain }}
|
||||
- name: Raise issue if domain expiring soon
|
||||
if: ${{ steps.check-domain.outputs.paid-till-days-left && steps.check-domain.outputs.paid-till-days-left < 30 }}
|
||||
uses: rishabhgupta/git-action-issue@v2
|
||||
with:
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
assignees: Lissy93
|
||||
title: '[WEBSITE] Domain Expiring Soon'
|
||||
body: >
|
||||
**Priority Notice**
|
||||
Domain, ${{ matrix.domain }} will expire in ${{ steps.check-domain.outputs.paid-till-days-left }} days.
|
||||
@Lissy93 - Please take action immediately to prevent any downtime
|
||||
|
||||
- name: Raise issue if SSL Cert expiring soon
|
||||
if: ${{ steps.check-domain.outputs.ssl-expire-days-left && steps.check-domain.outputs.ssl-expire-days-left < 14 }}
|
||||
uses: rishabhgupta/git-action-issue@v2
|
||||
with:
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
assignees: Lissy93
|
||||
title: '[WEBSITE] SSL Cert Expiring Soon'
|
||||
body: >
|
||||
**Priority Notice**
|
||||
The SSL Certificate for ${{ matrix.domain }} will expire in ${{ steps.check-domain.outputs.ssl-expire-days-left }} days, on ${{ steps.check-domain.outputs.ssl-expire-date }}.
|
||||
@Lissy93 - Please take action immediately to prevent any downtime
|
||||
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
name: Contributors
|
||||
on:
|
||||
schedule:
|
||||
- cron: '0 1 * * 0' # At 01:00 on Sunday.
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
jobs:
|
||||
contributors:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: bubkoo/contributors-list@v1
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
svgPath: docs/assets/CONTRIBUTORS.svg
|
||||
|
|
@ -0,0 +1,82 @@
|
|||
# Inserts list of contributors and community members into ./docs/credits.md
|
||||
# Also generates an SVG showing all contributors, which is embedded into readme
|
||||
name: 📊 Generate Contributor Credits
|
||||
on:
|
||||
workflow_dispatch: # Manual dispatch
|
||||
schedule:
|
||||
- cron: '0 1 * * 0' # At 01:00 on Sunday.
|
||||
jobs:
|
||||
# Job #1 - Generate an embedded SVG asset, showing all contributors
|
||||
generate-contributors:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: bubkoo/contributors-list@v1
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
svgPath: docs/assets/CONTRIBUTORS.svg
|
||||
affiliation: all
|
||||
includeBots: false
|
||||
excludeUsers: BeginCI snyk-bot
|
||||
avatarSize: 96
|
||||
userNameHeight: 20
|
||||
svgWidth: 830
|
||||
commitMessage: ':blue_heart: Updates contributor SVG'
|
||||
# Job #2 - Fetches sponsors and inserts into readme and credits page
|
||||
insert-sponsors:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout 🛎️
|
||||
uses: actions/checkout@v2
|
||||
- name: Generate Sponsors in Readme 💖
|
||||
uses: JamesIves/github-sponsors-readme-action@1.0.5
|
||||
with:
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
file: 'README.md'
|
||||
- name: Generate Sponsors in Credits 💖
|
||||
uses: JamesIves/github-sponsors-readme-action@1.0.5
|
||||
with:
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
file: 'docs/credits.md'
|
||||
# Job #3 - Update the Credits page
|
||||
insert-credits:
|
||||
runs-on: ubuntu-latest
|
||||
name: Inserts contributors into credits.md
|
||||
steps:
|
||||
- name: Contribute List - Credits Page
|
||||
uses: akhilmhdh/contributors-readme-action@v2.2
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
image_size: 80
|
||||
readme_path: docs/credits.md
|
||||
columns_per_row: 6
|
||||
commit_message: ':purple_heart: Updates contributors list'
|
||||
committer_username: liss-bot
|
||||
committer_email: liss-bot@d0h.co
|
||||
- name: Sponsors List - Readme
|
||||
uses: akhilmhdh/contributors-readme-action@v2.2
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
image_size: 80
|
||||
readme_path: README.md
|
||||
columns_per_row: 6
|
||||
commit_message: ':yellow_heart: Updates sponsors table'
|
||||
committer_username: liss-bot
|
||||
committer_email: liss-bot@d0h.co
|
||||
|
||||
make-author-list:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout 🛎️
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- uses: wow-actions/update-authors@v1
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
sort: commits
|
||||
bots: true
|
||||
path: .github/AUTHORS.txt
|
||||
commit: ':blue_heart: Makes author list'
|
||||
template: '{{name}} <{{email}}> - {{commits}} commits'
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
# Adds a comment to new PRs, showing the compressed size and size difference of new code
|
||||
# And also labels the PR based on the number of lines changes
|
||||
name: 🌈 Check PR Size
|
||||
on: [pull_request]
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
# Find and comment with compressed size
|
||||
- name: Get Compressed Size
|
||||
uses: preactjs/compressed-size-action@v2
|
||||
with:
|
||||
repo-token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
pattern: './dist/**/*.{js,css,html}'
|
||||
strip-hash: '\\b\\w{8}\\.'
|
||||
exclude: '{./dist/manifest.json,**/*.map,**/node_modules/**}'
|
||||
minimum-change-threshold: 100
|
||||
# Check number of lines of code added
|
||||
- name: Label based on Lines of Code
|
||||
uses: codelytv/pr-size-labeler@v1
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
xs_max_size: '10'
|
||||
s_max_size: '100'
|
||||
m_max_size: '500'
|
||||
l_max_size: '1000'
|
||||
s_label: '🟩 PR - Small'
|
||||
m_label: '🟨 PR - Medium'
|
||||
l_label: '🟧 PR - Large'
|
||||
xl_label: '🟥 PR - XL'
|
||||
fail_if_xl: 'false'
|
||||
message_if_xl: >
|
||||
It looks like this PR is very large (over 1000 lines).
|
||||
Try to avoid addressing multiple issues in a single PR, and
|
||||
in the future consider breaking large tasks down into smaller steps.
|
||||
This it to make reviewing, testing, reverting and general quality management easier.
|
||||
|
|
@ -0,0 +1,37 @@
|
|||
# Will add a comment and close any new issues opened by
|
||||
# users who have not yet committed to, or starred the repo
|
||||
name: 🎯 Issue Spam Control
|
||||
on:
|
||||
issues:
|
||||
types: [opened, reopened]
|
||||
jobs:
|
||||
check-user:
|
||||
if: >
|
||||
${{
|
||||
! contains( github.event.issue.labels.*.name, '📌 Keep Open') &&
|
||||
! contains( github.event.issue.labels.*.name, '🌈 Feedback') &&
|
||||
! contains( github.event.issue.labels.*.name, '💯 Showcase') &&
|
||||
github.event.comment.author_association != 'CONTRIBUTOR'
|
||||
}}
|
||||
runs-on: ubuntu-latest
|
||||
name: Close issue opened by non-stargazer
|
||||
steps:
|
||||
- name: close
|
||||
uses: uhyo/please-star-first@v1.0.1
|
||||
with:
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
message: |
|
||||
Welcome to Dashy 👋
|
||||
It's great to have you here, but unfortunately your ticket has been closed to prevent spam. Before reopening this issue, please ensure the following criteria are met.
|
||||
|
||||
Issues are sometimes closed when users:
|
||||
- Have only recently joined GitHub
|
||||
- Have not yet stared this repository
|
||||
- Have not previously interacted with the repo
|
||||
|
||||
Before you reopen this issue, please also ensure that:
|
||||
- You have checked that a similar issue does not already exist
|
||||
- You have checked the documentation for an existing solution
|
||||
- You have completed the relevant sections in the Issue template
|
||||
|
||||
Once you have verified the above standards are met, you may reopen this issue. Sorry for any inconvenience caused, I'm just a bot, and sometimes make mistakes 🤖
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
# Will translate any issues opened in foraign language, and add the English translation as a comment
|
||||
name: 🎯 Issue Translator
|
||||
on:
|
||||
issue_comment:
|
||||
types: [created]
|
||||
issues:
|
||||
types: [opened]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: tomsun28/issues-translate-action@v2.5
|
||||
with:
|
||||
BOT_GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
BOT_LOGIN_NAME: liss-bot
|
||||
IS_MODIFY_TITLE: true
|
||||
CUSTOM_BOT_NOTE: It looks like this issue isn't in English - not a problem, here's the translation! 🇬🇧
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
# Adds a label to any issues raised by a sponsor of Lissy93/Dashy
|
||||
# In order to allow their request can be prioritized
|
||||
name: 🎯 Label sponsors
|
||||
on:
|
||||
issues:
|
||||
types: [opened]
|
||||
jobs:
|
||||
build:
|
||||
name: is-sponsor-label
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: JasonEtco/is-sponsor-label-action@v1
|
||||
with:
|
||||
label: Priority Request - Sponsor 💖
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
# Applies the 'Top Issue' label to tickets with most user reactions
|
||||
name: 🎯 Label Top Issues
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: '0 1 * * *' # Run at 01:00 each day
|
||||
jobs:
|
||||
labelTopIssues:
|
||||
name: Label Top Issues
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Label Issues
|
||||
uses: adamzolyak/top-issues-action@master
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
TOP_NUMBER_OF_ISSUES: 10
|
||||
TOP_LABEL_NAME: "👍 Top 10 Issue!"
|
||||
TOP_LABEL_COLOR: FBCA04
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
# Replies with a random looks-good GIF, when a PR is reviewed with a LGTM comment
|
||||
name: 💡 Random LGTM GIF
|
||||
on:
|
||||
issue_comment: { types: [created] }
|
||||
pull_request_review: { types: [submitted] }
|
||||
jobs:
|
||||
post:
|
||||
runs-on: ubuntu-latest
|
||||
if: (!contains(github.actor, '[bot]')) # Exclude bot comment
|
||||
steps:
|
||||
- uses: ddradar/choose-random-action@v1
|
||||
id: act
|
||||
with:
|
||||
contents: |
|
||||
https://media4.giphy.com/media/11ISwbgCxEzMyY/giphy.gif
|
||||
https://media4.giphy.com/media/SgwPtMD47PV04/giphy.gif
|
||||
https://media1.giphy.com/media/3orifdxwbvVLfS3CrS/giphy.gif
|
||||
https://media4.giphy.com/media/RPwrO4b46mOdy/giphy.gif
|
||||
https://media2.giphy.com/media/3o7abGQa0aRJUurpII/giphy.gif
|
||||
https://media3.giphy.com/media/ZZrDTGSJXlHW9Y2khu/giphy.gif
|
||||
https://media3.giphy.com/media/5DQdk5oZzNgGc/giphy.gif
|
||||
https://media4.giphy.com/media/3o7abB06u9bNzA8lu8/giphy.gif
|
||||
https://media4.giphy.com/media/l2JJrEx9aRsjNruhi/giphy.gif
|
||||
- uses: ddradar/lgtm-action@v1
|
||||
with:
|
||||
image-url: ${{ steps.act.outputs.selected }}
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
# When a new comment is added to an issue, if it had the Stale or Awaiting User Response labels,
|
||||
# then those labels will be removed, providing it was not user lissy93 who added the commend.
|
||||
name: 🎯 Remove Pending Labels on Close
|
||||
on:
|
||||
issues:
|
||||
types: [closed]
|
||||
jobs:
|
||||
remove-labels:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Remove Labels when Closed
|
||||
uses: actions-cool/issues-helper@v2
|
||||
with:
|
||||
actions: remove-labels
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
issue-number: ${{ github.event.issue.number }}
|
||||
labels: '🚏 Awaiting User Response,⚰️ Stale,👤 Awaiting Maintainer Response'
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
# When a new comment is added to an issue, if it had the Stale or Awaiting User Response labels,
|
||||
# then those labels will be removed, providing it was not user lissy93 who added the commend.
|
||||
name: 🎯 Add/ Remove Awaiting Response Labels
|
||||
on:
|
||||
issue_comment:
|
||||
types: [created]
|
||||
jobs:
|
||||
remove-stale:
|
||||
runs-on: ubuntu-latest
|
||||
if: ${{ github.event.comment.author_association != 'COLLABORATOR' && github.event.comment.author_association != 'OWNER' }}
|
||||
steps:
|
||||
- name: Remove Stale labels when Updated
|
||||
uses: actions-cool/issues-helper@v2
|
||||
with:
|
||||
actions: remove-labels
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
issue-number: ${{ github.event.issue.number }}
|
||||
labels: '🚏 Awaiting User Response,⚰️ Stale'
|
||||
|
||||
add-awaiting-author:
|
||||
runs-on: ubuntu-latest
|
||||
if: ${{!github.event.issue.pull_request && github.event.comment.author_association != 'COLLABORATOR' && github.event.comment.author_association != 'OWNER' && github.event.issue.state == 'open' }}
|
||||
steps:
|
||||
- name: Add Awaiting Author labels when Updated
|
||||
uses: actions-cool/issues-helper@v2
|
||||
with:
|
||||
actions: add-labels
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
issue-number: ${{ github.event.issue.number }}
|
||||
labels: '👤 Awaiting Maintainer Response'
|
||||
|
||||
remove-awaiting-author:
|
||||
runs-on: ubuntu-latest
|
||||
if: ${{ github.event.comment.author_association == 'OWNER' }}
|
||||
steps:
|
||||
- name: Remove Awaiting Author labels when Updated
|
||||
uses: actions-cool/issues-helper@v2
|
||||
with:
|
||||
actions: remove-labels
|
||||
token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
issue-number: ${{ github.event.issue.number }}
|
||||
labels: '👤 Awaiting Maintainer Response'
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# Detects offensive language in comments and takes reaction
|
||||
name: 🎯 Mind your language
|
||||
on:
|
||||
issues:
|
||||
types: [opened]
|
||||
issue_comment:
|
||||
types: [created]
|
||||
pull_request:
|
||||
types: [opened]
|
||||
jobs:
|
||||
echo_issue_comment:
|
||||
runs-on: ubuntu-latest
|
||||
name: profanity check
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
- name: Profanity check step
|
||||
uses: tailaiw/mind-your-language-action@v1.0.3
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# Adds comments to PR, based on which files are modified
|
||||
name: 💡 PR Commenter
|
||||
on: [ pull_request_target ]
|
||||
jobs:
|
||||
pr-comment:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: exercism/pr-commenter-action@v1.3.0
|
||||
with:
|
||||
github-token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
config-file: .github/pr-auto-comments.yml
|
||||
template-variables: |
|
||||
{ "prAuthor": "${{ github.event.pull_request.user.login }}" }
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
# Labels pull requests based on their branch name
|
||||
name: 💡 PR Branch Labeler
|
||||
on: pull_request
|
||||
jobs:
|
||||
label-pr:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Label PR
|
||||
if: github.event.action == 'opened'
|
||||
uses: ffittschen/pr-branch-labeler@v1
|
||||
with:
|
||||
repo-token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# Finds any TO-DO notes within the code, and opens up an issue for it to be fixed
|
||||
name: 🌈 Open issue for Todos
|
||||
on: ["push"]
|
||||
jobs:
|
||||
build:
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- uses: "actions/checkout@master"
|
||||
- name: "TODO to Issue"
|
||||
uses: "alstr/todo-to-issue-action@v4.2"
|
||||
id: "todo"
|
||||
with:
|
||||
TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
# Adds a comment to all issues & PRs that were fixed on a new release
|
||||
name: 💡 Update Issue after Release
|
||||
on:
|
||||
release:
|
||||
types: [published]
|
||||
jobs:
|
||||
release:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: apexskier/github-release-commenter@v1
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
label-template: 🛩️ Released {release_tag}, 🔨 Fixed
|
||||
comment-template: |
|
||||
**The fix for this issue has now been released in {release_name} ✨**
|
||||
|
||||
If you haven't done so already, please [update your instance](https://github.com/Lissy93/dashy/blob/master/docs/management.md#updating) to `{release_tag}` or later. See {release_link} for full info.
|
||||
|
||||
Feel free to reach out if you need any more support. If you are enjoying Dashy, consider [supporting the project](https://github.com/Lissy93/dashy/blob/master/docs/contributing.md#contributing).
|
||||
|
|
@ -0,0 +1,92 @@
|
|||
# Generates series of diagrams and visualizations
|
||||
name: 📊 Generate Repo Stats
|
||||
on:
|
||||
workflow_dispatch: # Manual dispatch
|
||||
schedule:
|
||||
- cron: '0 1 * * 0' # At 01:00 on Sunday.
|
||||
|
||||
jobs:
|
||||
# File structure chart
|
||||
file-structure:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@master
|
||||
- name: Generate File Structure Diagram
|
||||
uses: githubocto/repo-visualizer@0.7.1
|
||||
with:
|
||||
root_path: 'src/'
|
||||
output_file: docs/assets/repo-visualization.svg
|
||||
excluded_paths: dist,node_modules
|
||||
commit_message: ':yellow_heart: Updates repo diagram'
|
||||
branch: master
|
||||
|
||||
# Hercules git branching stats
|
||||
git-stats:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@master
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Hercules
|
||||
uses: src-d/hercules@master
|
||||
- uses: actions/upload-artifact@master
|
||||
with:
|
||||
name: hercules_charts
|
||||
path: hercules_charts.tar
|
||||
|
||||
# Lowlighter metrics community metrics
|
||||
community-stats:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@master
|
||||
- name: Generate Repo Metrics
|
||||
uses: lowlighter/metrics@latest
|
||||
with:
|
||||
token: ${{ secrets.LISSY93_PAT }}
|
||||
committer_token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
committer_branch: master
|
||||
committer_message: ':purple_heart: Adds repo metrics'
|
||||
filename: docs/assets/repo-metrics.*
|
||||
template: classic
|
||||
user: Lissy93
|
||||
repo: dashy
|
||||
delay: 5
|
||||
|
||||
- name: Generate License Metrics
|
||||
uses: lowlighter/metrics@latest
|
||||
with:
|
||||
token: ${{ secrets.LISSY93_PAT }}
|
||||
committer_token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
committer_branch: master
|
||||
committer_message: ':purple_heart: Adds license metrics'
|
||||
filename: docs/assets/license-metrics.*
|
||||
template: repository
|
||||
user: Lissy93
|
||||
repo: dashy
|
||||
delay: 5
|
||||
plugin_licenses: yes
|
||||
plugin_licenses_setup: yarn build
|
||||
plugin_licenses_ratio: yes
|
||||
plugin_licenses_legal: yes
|
||||
|
||||
- name: Generate Contributor Metrics
|
||||
uses: lowlighter/metrics@latest
|
||||
with:
|
||||
token: ${{ secrets.LISSY93_PAT }}
|
||||
committer_token: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
committer_branch: master
|
||||
committer_message: ':purple_heart: Adds contributor metrics'
|
||||
filename: docs/assets/controbutor-metrics.*
|
||||
user: Lissy93
|
||||
repo: dashy
|
||||
delay: 5
|
||||
plugin_contributors: yes
|
||||
plugin_contributors_base: ""
|
||||
plugin_contributors_head: master
|
||||
plugin_contributors_ignored: bot
|
||||
plugin_contributors_contributions: yes
|
||||
plugin_contributors_sections: contributors
|
||||
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
name: 📊 Save Repo Analytics
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: '0 1 * * 0' # At 01:00 on Sunday.
|
||||
jobs:
|
||||
gen-stats:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Repo Analytics
|
||||
uses: jgehrcke/github-repo-stats@HEAD
|
||||
with:
|
||||
repository: lissy93/dashy
|
||||
databranch: DATA/repo-stats
|
||||
ghtoken: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
# Uses Snyk to check for potential vulnerabilities, then sends results to GH security tab
|
||||
name: 💡 Vulnerability Scanning
|
||||
on: push
|
||||
jobs:
|
||||
security:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@master
|
||||
- name: Run Snyk to check for vulnerabilities
|
||||
uses: snyk/actions/node@master
|
||||
continue-on-error: true
|
||||
env:
|
||||
SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
|
||||
with:
|
||||
args: --sarif-file-output=snyk.sarif
|
||||
- name: Upload result to GitHub Code Scanning
|
||||
uses: github/codeql-action/upload-sarif@v1
|
||||
with:
|
||||
sarif_file: snyk.sarif
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
# Expands any raw pasted link in comments. Useful so people know what they're clicking
|
||||
name: 🎯 Unfurl Links
|
||||
on:
|
||||
issues:
|
||||
types: [opened]
|
||||
issue_comment:
|
||||
types: [created]
|
||||
pull_request:
|
||||
types: [opened]
|
||||
jobs:
|
||||
run:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: wow-actions/unfurl-links@v1
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
raw: true
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
# Uses the contents of the ./docs directory for Dashy's GH Wiki page
|
||||
name: 📊 Wiki Sync
|
||||
on:
|
||||
workflow_dispatch: # Manual dispatch
|
||||
schedule:
|
||||
- cron: '0 1 * * 0' # At 01:00 on Sunday.
|
||||
jobs:
|
||||
update-wiki:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@master
|
||||
- name: Upload Docs to GH Wiki
|
||||
uses: docker://decathlon/wiki-page-creator-action:latest
|
||||
env:
|
||||
GH_PAT: ${{ secrets.BOT_GITHUB_TOKEN || secrets.GITHUB_TOKEN }}
|
||||
ACTION_MAIL: alicia-gh-bot@mail.as93.net
|
||||
ACTION_NAME: liss-bot
|
||||
OWNER: Lissy93
|
||||
REPO_NAME: Dashy
|
||||
MD_FOLDER: docs/
|
||||
# - name: Sync Wiki
|
||||
# uses: joeizzard/action-wiki-sync@master
|
||||
# with:
|
||||
# username: example
|
||||
# access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
# wiki_folder: ./docs
|
||||
# commit_username: 'liss-bot'
|
||||
# commit_email: 'liss-bot@d0h.co'
|
||||
# commit_message: '📕 Chore: Sync Wiki'
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
# Config for running Dashy in GitPod's cloud dev environment
|
||||
# Docs: https://www.gitpod.io/docs/references/gitpod-yml
|
||||
|
||||
# Commands to start on workspace startup
|
||||
tasks:
|
||||
- init: yarn install
|
||||
command: yarn dev
|
||||
# Ports to expose on workspace startup
|
||||
ports:
|
||||
- port: 8080 # Default dev server
|
||||
visibility: private
|
||||
onOpen: open-preview
|
||||
- port: 4000 # Default prod server
|
||||
visibility: public
|
||||
onOpen: open-preview
|
||||
prebuilds:
|
||||
# Adds 'Open in GitPod' to PRs
|
||||
addBadge: true
|
||||
addComment: false
|
||||
vscode:
|
||||
# Adds Vue.js and formatting extensions
|
||||
extensions:
|
||||
- octref.vetur
|
||||
- dbaeumer.vscode-eslint
|
||||
- streetsidesoftware.code-spell-checker
|
||||
- PKief.material-icon-theme
|
||||
- wix.vscode-import-cost
|
||||
- oderwat.indent-rainbow
|
||||
- eamodio.gitlens
|
||||
58
Dockerfile
58
Dockerfile
|
|
@ -1,30 +1,54 @@
|
|||
FROM node:lts-alpine
|
||||
FROM node:16.13.2-alpine AS BUILD_IMAGE
|
||||
|
||||
# Define some ENV Vars
|
||||
ENV PORT 80
|
||||
ENV DIRECTORY /app
|
||||
ENV IS_DOCKER true
|
||||
# Set the platform to build image for
|
||||
ARG TARGETPLATFORM
|
||||
ENV TARGETPLATFORM=${TARGETPLATFORM:-linux/amd64}
|
||||
|
||||
# Install additional tools needed if on arm64 / armv7
|
||||
RUN \
|
||||
case "${TARGETPLATFORM}" in \
|
||||
'linux/arm64') apk add --no-cache python3 make g++ ;; \
|
||||
'linux/arm/v7') apk add --no-cache python3 make g++ ;; \
|
||||
esac
|
||||
|
||||
# Create and set the working directory
|
||||
WORKDIR ${DIRECTORY}
|
||||
WORKDIR /app
|
||||
|
||||
# Copy over both 'package.json' and 'package-lock.json' (if available)
|
||||
COPY package*.json ./
|
||||
|
||||
# Install project dependencies
|
||||
RUN yarn
|
||||
# Install app dependencies
|
||||
COPY package.json yarn.lock ./
|
||||
RUN yarn install --frozen-lockfile --network-timeout 1000000
|
||||
|
||||
# Copy over all project files and folders to the working directory
|
||||
COPY . .
|
||||
COPY . ./
|
||||
|
||||
# Build initial app for production
|
||||
RUN yarn build
|
||||
|
||||
# Expose given port
|
||||
EXPOSE ${PORT}
|
||||
# Production stage
|
||||
FROM node:16.13.2-alpine
|
||||
|
||||
# Define some ENV Vars
|
||||
ENV PORT=80 \
|
||||
DIRECTORY=/app \
|
||||
IS_DOCKER=true
|
||||
|
||||
# Create and set the working directory
|
||||
WORKDIR ${DIRECTORY}
|
||||
|
||||
# Install tini for initialization and tzdata for setting timezone
|
||||
RUN apk add --no-cache tzdata tini
|
||||
|
||||
# Copy built application from build phase
|
||||
COPY --from=BUILD_IMAGE /app ./
|
||||
# Ensure only one version of conf.yml exists
|
||||
RUN rm dist/conf.yml
|
||||
|
||||
# Finally, run start command to serve up the built application
|
||||
CMD [ "yarn", "build-and-start"]
|
||||
ENTRYPOINT [ "/sbin/tini", "--" ]
|
||||
CMD [ "yarn", "build-and-start" ]
|
||||
|
||||
# Run simple healthchecks every 5 mins, to check the Dashy's everythings great
|
||||
HEALTHCHECK --interval=5m --timeout=2s --start-period=30s CMD yarn health-check
|
||||
# Expose the port
|
||||
EXPOSE ${PORT}
|
||||
|
||||
# Run simple healthchecks every 5 mins, to check that everythings still great
|
||||
HEALTHCHECK --interval=5m --timeout=2s --start-period=30s CMD yarn health-check
|
||||
32
LICENSE
32
LICENSE
|
|
@ -1,17 +1,21 @@
|
|||
Licensed under MIT X11. Copyright © 2021 Alicia Sykes <https://aliciasykes.com>
|
||||
MIT License
|
||||
|
||||
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:
|
||||
Copyright (c) 2021-2022 Alicia Sykes <https://aliciasykes.com>
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or
|
||||
substantial portions of the Software.
|
||||
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 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 SOFTWAREOR THE USE
|
||||
OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
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.
|
||||
|
|
|
|||
3
Procfile
3
Procfile
|
|
@ -1 +1,4 @@
|
|||
# Heroku config - Specifies the commands to execute when the app starts
|
||||
# See docs for more info: https://devcenter.heroku.com/articles/procfile
|
||||
|
||||
web: node server.js
|
||||
1
app.json
1
app.json
|
|
@ -12,6 +12,5 @@
|
|||
"home-lab",
|
||||
"lissy93"
|
||||
],
|
||||
"image": "heroku/nodejs",
|
||||
"stack": "heroku-20"
|
||||
}
|
||||
|
|
@ -1,25 +1,43 @@
|
|||
---
|
||||
# Welcome to Dashy! To get started, run `docker compose up`
|
||||
# Welcome to Dashy! To get started, run `docker compose up -d`
|
||||
# You can configure your container here, by modifying this file
|
||||
version: "3.8"
|
||||
services:
|
||||
dashy:
|
||||
container_name: Dashy
|
||||
|
||||
# Pull latest image from DockerHub
|
||||
image: lissy93/dashy
|
||||
|
||||
# To build from source, replace 'image: lissy93/dashy' with 'build: .'
|
||||
# build: .
|
||||
image: lissy93/dashy
|
||||
container_name: Dashy
|
||||
|
||||
# Or, to use a Dockerfile for your archtecture, uncomment the following
|
||||
# context: .
|
||||
# dockerfile: ./docker/Dockerfile-arm32v7
|
||||
|
||||
# You can also use an image with a different tag, or pull from a different registry, e.g:
|
||||
# image: ghcr.io/lissy93/dashy or image: lissy93/dashy:arm64v8
|
||||
|
||||
# Pass in your config file below, by specifying the path on your host machine
|
||||
# volumes:
|
||||
# - /root/my-config.yml:/app/public/conf.yml
|
||||
# - /path/to/my-config.yml:/app/public/conf.yml
|
||||
# - /path/to/item-icons:/app/public/item-icons
|
||||
|
||||
# Set port that web service will be served on. Keep container port as 80
|
||||
ports:
|
||||
- 4000:80
|
||||
|
||||
# Set any environmental variables
|
||||
environment:
|
||||
- NODE_ENV=production
|
||||
# Specify your user ID and group ID. You can find this by running `id -u` and `id -g`
|
||||
# - UID=1000
|
||||
# - GID=1000
|
||||
|
||||
# Specify restart policy
|
||||
restart: unless-stopped
|
||||
|
||||
# Configure healthchecks
|
||||
healthcheck:
|
||||
test: ['CMD', 'node', '/app/services/healthcheck']
|
||||
|
|
|
|||
|
|
@ -0,0 +1,43 @@
|
|||
FROM alpine:3.12 AS builder
|
||||
|
||||
# Download QEMU, see https://github.com/docker/hub-feedback/issues/1261
|
||||
RUN QEMU_URL=https://github.com/balena-io/qemu/releases/download/v5.2.0%2Bbalena4/qemu-5.2.0.balena4-arm.tar.gz \
|
||||
&& apk add curl && curl -L $QEMU_URL | tar zxvf - -C . --strip-components 1
|
||||
|
||||
# Start second (arm32v7) stage
|
||||
FROM arm32v7/alpine:3.12
|
||||
|
||||
# Add QEMU from build stage
|
||||
COPY --from=builder qemu-arm-static /usr/bin
|
||||
|
||||
# Install Node and Yarn
|
||||
RUN apk add --update --no-cache nodejs npm yarn
|
||||
|
||||
# Define some ENV Vars
|
||||
ENV PORT=80 \
|
||||
DIRECTORY=/app \
|
||||
IS_DOCKER=true
|
||||
|
||||
# Create and set the working directory
|
||||
WORKDIR ${DIRECTORY}
|
||||
|
||||
# Copy over both 'package.json' and 'package-lock.json' (if available)
|
||||
COPY package*.json ./
|
||||
|
||||
# Install project dependencies
|
||||
RUN yarn
|
||||
|
||||
# Copy over all project files and folders to the working directory
|
||||
COPY . .
|
||||
|
||||
# Build initial app for production
|
||||
RUN yarn build
|
||||
|
||||
# Expose given port
|
||||
EXPOSE ${PORT}
|
||||
|
||||
# Finally, run start command to serve up the built application
|
||||
CMD [ "yarn", "build-and-start"]
|
||||
|
||||
# Run simple healthchecks every 5 mins, to check the Dashy's everythings great
|
||||
HEALTHCHECK --interval=5m --timeout=2s --start-period=30s CMD yarn health-check
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
FROM alpine:3.12 AS builder
|
||||
|
||||
# Download QEMU, see https://github.com/docker/hub-feedback/issues/1261
|
||||
RUN QEMU_URL=https://github.com/balena-io/qemu/releases/download/v5.2.0%2Bbalena4/qemu-5.2.0.balena4-aarch64.tar.gz \
|
||||
&& apk add curl && curl -L $QEMU_URL | tar zxvf - -C . --strip-components 1
|
||||
|
||||
# Start second (arm64v8) stage
|
||||
FROM arm64v8/alpine:3.12
|
||||
|
||||
# Add QEMU from build stage
|
||||
COPY --from=builder qemu-aarch64-static /usr/bin
|
||||
|
||||
# Install Node and Yarn
|
||||
RUN apk add --update --no-cache nodejs npm yarn
|
||||
|
||||
# Define some ENV Vars
|
||||
ENV PORT=80 \
|
||||
DIRECTORY=/app \
|
||||
IS_DOCKER=true
|
||||
|
||||
# Create and set the working directory
|
||||
WORKDIR ${DIRECTORY}
|
||||
|
||||
# Copy over both 'package.json' and 'package-lock.json' (if available)
|
||||
COPY package*.json ./
|
||||
|
||||
# Install project dependencies
|
||||
RUN yarn
|
||||
|
||||
# Copy over all project files and folders to the working directory
|
||||
COPY . .
|
||||
|
||||
# Build initial app for production
|
||||
RUN yarn build
|
||||
|
||||
# Expose given port
|
||||
EXPOSE ${PORT}
|
||||
|
||||
# Finally, run start command to serve up the built application
|
||||
CMD [ "yarn", "build-and-start"]
|
||||
|
||||
# Run simple healthchecks every 5 mins, to check the Dashy's everythings great
|
||||
HEALTHCHECK --interval=5m --timeout=2s --start-period=30s CMD yarn health-check
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# -----------------------------------------------------------------------------------------
|
||||
# A light-weight alternative Docker image, using NGINX rather than Node.js to serve the app
|
||||
# This means that certain features that require server-side endpoints will not be available
|
||||
# -----------------------------------------------------------------------------------------
|
||||
|
||||
# Build Stage - Install dependencies + build the app
|
||||
FROM node:lts-alpine3.14 as build
|
||||
WORKDIR /dashy
|
||||
COPY package*.json .
|
||||
COPY yarn.lock .
|
||||
RUN yarn
|
||||
COPY . .
|
||||
RUN yarn build
|
||||
|
||||
# Production Stage - Serve up built files with NGINX
|
||||
FROM nginx:alpine as production
|
||||
COPY ./docker/nginx.conf /etc/nginx/nginx.conf
|
||||
COPY --from=build /dashy/dist /usr/share/nginx/html
|
||||
EXPOSE 80
|
||||
ENTRYPOINT ["nginx", "-g", "daemon off;"]
|
||||
|
||||
LABEL maintainer="Alicia Sykes <alicia@omg.lol>"
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
FROM node:lts-alpine3.14
|
||||
|
||||
# Define some ENV Vars
|
||||
ENV PORT=80 \
|
||||
DIRECTORY=/app \
|
||||
IS_DOCKER=true
|
||||
|
||||
# Create and set the working directory
|
||||
WORKDIR ${DIRECTORY}
|
||||
|
||||
# Copy over both 'package.json' and 'package-lock.json' (if available)
|
||||
COPY package*.json ./
|
||||
COPY yarn.lock ./
|
||||
|
||||
# Install project dependencies
|
||||
RUN yarn
|
||||
|
||||
# Copy over all project files and folders to the working directory
|
||||
COPY . .
|
||||
|
||||
# Build initial app for production
|
||||
RUN yarn build
|
||||
|
||||
# Expose given port
|
||||
EXPOSE ${PORT}
|
||||
|
||||
# Finally, run start command to serve up the built application
|
||||
CMD [ "yarn", "build-and-start"]
|
||||
|
||||
# Run simple healthchecks every 5 mins, to check the Dashy's everythings great
|
||||
HEALTHCHECK --interval=5m --timeout=2s --start-period=30s CMD yarn health-check
|
||||
|
|
@ -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.
|
||||
```
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
#!/bin/bash
|
||||
|
||||
# Used to setup QEMU to build arm images on amd64 processors.
|
||||
# Source: https://git.io/J0ezo
|
||||
|
||||
# Register qemu-*-static for all supported processors except the
|
||||
# current one, but also remove all registered binfmt_misc before
|
||||
docker run --rm --privileged multiarch/qemu-user-static:register --reset
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
worker_processes 4;
|
||||
|
||||
events { worker_connections 1024; }
|
||||
|
||||
http {
|
||||
server {
|
||||
listen 80;
|
||||
root /usr/share/nginx/html;
|
||||
include /etc/nginx/mime.types;
|
||||
|
||||
location /appui {
|
||||
try_files $uri /index.html;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
# Alternate Views & Opening Methods
|
||||
|
||||
## Views
|
||||
|
||||
Dashy has three different views:
|
||||
- Default View - This is the main homepage with sections in a grid layout
|
||||
- Workspace View - Items displayed on the side, and are launched within Dashy
|
||||
- Minimal View - A clean + simple tabbed view
|
||||
|
||||
You can switch between views using the dropdown in the top-right corner. Set your chosen Starting View with `appConfig.startingView`. Click the page title at any time to go back to your selected starting view.
|
||||
|
||||
### Default
|
||||
This is the main page that you will land on when you first launch the application. Here all of your sections (with items + widgets) are visible in a grid layout.
|
||||
|
||||
<p align="center">
|
||||
<b>Example of Default View</b><br>
|
||||
<img width="800" src="https://i.ibb.co/L8YbNNc/dashy-demo2.gif" alt="Demo" />
|
||||
</p>
|
||||
|
||||
### Workspace
|
||||
The workspace view displays your links in a sidebar on the left-hand side, and apps are launched inside an iframe without having to leave Dashy. This enables you to use all of your self-hosted apps from one place, and makes multi-tasking easy.
|
||||
|
||||
You can specify a default app to be opened when you land on the workspace, by setting `appConfig.workspaceLandingUrl: https://app-to-open/`. If this app exists within your sections.items, then the corresponding section will also be expanded.
|
||||
|
||||
You can also opt to keep previously opened websites/ apps open in the background, by setting `appConfig.enableMultiTasking: true`. This comes at the cost of performance, but does mean that your session with each app is preserved, enabling you to quickly switch between them.
|
||||
|
||||
<p align="center">
|
||||
<b>Example of Workspace View</b><br>
|
||||
<img alt="Workspace view demo" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/workspace-demo.gif" width="800" />
|
||||
</p>
|
||||
|
||||
### Minimal View
|
||||
The minimal view aims to be super fast and simple, and can be used as a browser startpage. Items are grouped into a tab view, and the last opened tab will be remembered. Similar to the main view, you can search and launch items just by typing, and right-clicking will show more options (like open in modal, workspace or new tab).
|
||||
|
||||
<p align="center">
|
||||
<b>Example of Minimal View</b><br>
|
||||
<img alt="Workspace view demo" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/minimal-view-demo.gif" width="800" />
|
||||
</p>
|
||||
|
||||
## Opening Methods
|
||||
|
||||
Dashy supports several different ways to launch your apps. The primary opening method for each app can be specified using the `target` attribute, with a value of one of the following:
|
||||
|
||||
- `sametab` - The app will be launched in the current tab
|
||||
- `newtab` - The app will be launched in a new tab
|
||||
- `top` - Opens in the top-most browsing context, useful if your accessing Dashy through an iframe
|
||||
- `modal` - Launch app in a resizable/ movable popup modal on the current page
|
||||
- `workspace` - Changes to Workspace view, and launches app
|
||||
|
||||
You can also set a default opening method, which will be applied to all items that don't have a specified target, using `appConfig.defaultOpeningMethod`, to one of the above values.
|
||||
|
||||
Even if the target is not set (or is set to `sametab`), you can still launch any given app in an alternative method. Either right-click to see all options, or use one of the keyboard shortcuts: Alt + Click will open the modal, and Ctrl + Click will open in a new tab.
|
||||
|
||||
<p align="center">
|
||||
<img width="500" src="https://i.ibb.co/vmZdSRt/dashy-context-menu-2.png" />
|
||||
</p>
|
||||
|
||||
If you don't like the custom context menu, it can be disabled by setting `appConfig.disableContextMenu: true`.
|
||||
|
||||
If you get a 'Refused to Connect' error in the modal or workspace views, then the target app has it's X-Frame-Options HTTP set to block requests from embedded content. You can easily fix this by setting this header to ALLOW, for instructions on how to do so, see the [Troubleshooting Docs](/docs/troubleshooting.md#refused-to-connect-in-modal-or-workspace-view).
|
||||
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 818 KiB After Width: | Height: | Size: 8.0 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 2.0 MiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 106 KiB |
|
|
@ -0,0 +1,7 @@
|
|||
<svg width="223px" height="30px" version="1.1" viewBox="0 0 223 30" xmlns="http://www.w3.org/2000/svg">
|
||||
<title>Artboard</title>
|
||||
<desc>Created with Sketch.</desc>
|
||||
<rect id="Rectangle" width="223" height="30" rx="8" fill="#ff5e5b" style="fill-rule:evenodd;fill:#ff8eff"/>
|
||||
<path d="m19.011 10.912c0.57462-1.6874 1.9364-2.531 4.0853-2.531 3.2234 0 4.4184 4.0247 2.7288 6.6559-1.1264 1.7541-3.3978 3.9728-6.8141 6.6559-3.4163-2.6832-5.6877-4.9018-6.8141-6.6559-1.6896-2.6312-0.49462-6.6559 2.7288-6.6559 2.1489 0 3.5107 0.84368 4.0853 2.531z" fill="#ff5e5b" style="fill:none;stroke-width:1.5;stroke:#fff"/>
|
||||
<text x="55" y="20" style="fill:#ffffff;font-family:sans-serif;font-size:16px;letter-spacing:0px;line-height:1.25;word-spacing:0px" xml:space="preserve"><tspan x="31.423412" y="20.493532" style="fill:#ffffff;font-size:16px">Sponsor me on Github</tspan></text>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 879 B |
Binary file not shown.
|
After Width: | Height: | Size: 5.6 MiB |
|
|
@ -1,10 +1,16 @@
|
|||
# Authentication
|
||||
|
||||
- [Built-In Login Feature](#authentication)
|
||||
- [Basic Auth](#built-in-auth)
|
||||
- [Setting Up Authentication](#setting-up-authentication)
|
||||
- [Hash Password](#hash-password)
|
||||
- [Logging In and Out](#logging-in-and-out)
|
||||
- [Security](#security)
|
||||
- [Guest Access](#enabling-guest-access)
|
||||
- [Per-User Access](#granular-access)
|
||||
- [Security Considerations](#security)
|
||||
- [Keycloak Auth](#keycloak)
|
||||
- [Deploying Keycloak](#1-deploy-keycloak)
|
||||
- [Setting up Keycloak](#2-setup-keycloak-users)
|
||||
- [Configuring Dashy for Keycloak](#3-enable-keycloak-in-dashy-config-file)
|
||||
- [Alternative Authentication Methods](#alternative-authentication-methods)
|
||||
- [VPN](#vpn)
|
||||
- [IP-Based Access](#ip-based-access)
|
||||
|
|
@ -12,45 +18,169 @@
|
|||
- [OAuth Services](#oauth-services)
|
||||
- [Auth on Cloud Hosting Services](#static-site-hosting-providers)
|
||||
|
||||
## Built-In Auth
|
||||
Dashy has a basic login page included, and frontend authentication. You can enable this by adding users to the `auth` section under `appConfig` in your `conf.yml`. If this section is not specified, then no authentication will be required to access the app, and it the homepage will resolve to your dashboard.
|
||||
|
||||
## Setting Up Authentication
|
||||
### Setting Up Authentication
|
||||
The `auth` property takes an array of users. Each user needs to include a username, hash and optional user type (`admin` or `normal`). The hash property is a [SHA-256 Hash](https://en.wikipedia.org/wiki/SHA-2) of your desired password.
|
||||
|
||||
For example:
|
||||
```yaml
|
||||
appConfig:
|
||||
auth:
|
||||
users:
|
||||
- user: alicia
|
||||
hash: 4D1E58C90B3B94BCAD9848ECCACD6D2A8C9FBC5CA913304BBA5CDEAB36FEEFA3
|
||||
type: admin
|
||||
- user: edward
|
||||
- user: bob
|
||||
hash: 5E884898DA28047151D0E56F8DC6292773603D0D6AABBDD62A11EF721D1542D8
|
||||
type: admin
|
||||
```
|
||||
## Hash Password
|
||||
|
||||
### Hash Password
|
||||
Dashy uses [SHA-256 Hash](https://en.wikipedia.org/wiki/Sha-256), a 64-character string, which you can generate using an online tool, such as [this one](https://passwordsgenerator.net/sha256-hash-generator/) or [CyberChef](https://gchq.github.io/CyberChef/) (which can be self-hosted/ ran locally).
|
||||
|
||||
A hash is a one-way cryptographic function, meaning that it is easy to generate a hash for a given password, but very hard to determine the original password for a given hash. This means, that so long as your password is long, strong and unique, it is safe to store it's hash in the clear. Having said that, you should never reuse passwords, hashes can be cracked by iterating over known password lists, generating a hash of each.
|
||||
|
||||
## Logging In and Out
|
||||
### Logging In and Out
|
||||
Once authentication is enabled, so long as there is no valid token in cookie storage, the application will redirect the user to the login page. When the user enters credentials in the login page, they will be checked, and if valid, then a token will be generated, and they can be redirected to the home page. If credentials are invalid, then an error message will be shown, and they will remain on the login page. Once in the application, to log out the user can click the logout button (in the top-right), which will clear cookie storage, causing them to be redirected back to the login page.
|
||||
|
||||
## Security
|
||||
Since all authentication is happening entirely on the client-side, it is vulnerable to manipulation by an adversary. An attacker could look at the source code, find the function used generate the auth token, then decode the minified JavaScript to find the hash, and manually generate a token using it, then just insert that value as a cookie using the console, and become a logged in user. Therefore, if you need secure authentication for your app, it is strongly recommended to implement this using your web server, or use a VPN to control access to Dashy. The purpose of the login page is merely to prevent immediate unauthorized access to your homepage.
|
||||
### Enabling Guest Access
|
||||
With authentication setup, by default no access is allowed to your dashboard without first logging in with valid credentials. Guest mode can be enabled to allow for read-only access to a secured dashboard by any user, without the need to log in. A guest user cannot write any changes to the config file, but can apply modifications locally (stored in their browser). You can enable guest access, by setting `appConfig.auth.enableGuestAccess: true`.
|
||||
|
||||
Addressing this is on the todo list, and there are several potential solutions:
|
||||
1. Encrypt all site data against the users password, so that an attacker can not physically access any data without the correct decryption key
|
||||
2. Use a backend service to handle authentication and configuration, with no user data returned from the server until the correct credentials are provided. However, this would require either Dashy to be run using it's Node.js server, or the use of an external service
|
||||
3. Implement authentication using a self-hosted identity management solution, such as [Keycloak for Vue](https://www.keycloak.org/securing-apps/vue)
|
||||
### Granular Access
|
||||
You can use the following properties to make certain sections or items only visible to some users, or hide sections and items from guests.
|
||||
- `hideForUsers` - Section or Item will be visible to all users, except for those specified in this list
|
||||
- `showForUsers` - Section or Item will be hidden from all users, except for those specified in this list
|
||||
- `hideForGuests` - Section or Item will be visible for logged in users, but not for guests
|
||||
|
||||
For Example:
|
||||
|
||||
```yaml
|
||||
- name: Code Analysis & Monitoring
|
||||
icon: fas fa-code
|
||||
displayData:
|
||||
cols: 2
|
||||
hideForUsers: [alicia, bob]
|
||||
items:
|
||||
...
|
||||
```
|
||||
|
||||
```yaml
|
||||
- name: Deployment Pipelines
|
||||
icon: fas fa-rocket
|
||||
displayData:
|
||||
hideForGuests: true
|
||||
items:
|
||||
- title: Hide Me
|
||||
displayData:
|
||||
hideForUsers: [alicia, bob]
|
||||
```
|
||||
|
||||
### Permissions
|
||||
Any user who is not an admin (with `type: admin`) will not be able to write changes to disk.
|
||||
|
||||
You can also prevent any user from writing changes to disk, using `preventWriteToDisk`. Or prevent any changes from being saved locally in browser storage, using `preventLocalSave`. Both properties can be found under [`appConfig`](./docs/configuring.md#appconfig-optional).
|
||||
|
||||
To disable all UI config features, including View Config, set `disableConfiguration`.
|
||||
|
||||
### Security
|
||||
With basic auth, all logic is happening on the client-side, which could mean a skilled user could manipulate the code to view parts of your configuration, including the hash. If the SHA-256 hash is of a common password, it may be possible to determine it, using a lookup table, in order to find the original password. Which can be used to manually generate the auth token, that can then be inserted into session storage, to become a valid logged in user. Therefore, you should always use a long, strong and unique password, and if you instance contains security-critical info and/ or is exposed directly to the internet, and alternative authentication method may be better. The purpose of the login page is merely to prevent immediate unauthorized access to your homepage.
|
||||
|
||||
**[⬆️ Back to Top](#authentication)**
|
||||
|
||||
---
|
||||
|
||||
## Keycloak
|
||||
|
||||
Dashy also supports using a [Keycloack](https://www.keycloak.org/) authentication server. The setup for this is a bit more involved, but it gives you greater security overall, useful for if your instance is exposed to the internet.
|
||||
|
||||
[Keycloak](https://www.keycloak.org/about.html) is a Java-based [open source](https://github.com/keycloak/keycloak), high-performance, secure authentication system, supported by [RedHad](https://www.redhat.com/en). It is easy to setup ([with Docker](https://quay.io/repository/keycloak/keycloak)), and enables you to secure multiple self-hosted applications with single-sign on using standard protocols (OpenID Connect, OAuth 2.0, SAML 2.0 and social login). It's also very customizable, you can write or use custom [themes](https://wjw465150.gitbooks.io/keycloak-documentation/content/server_development/topics/themes.html), [plugins](https://www.keycloak.org/extensions.html), [password policies](https://wjw465150.gitbooks.io/keycloak-documentation/content/server_admin/topics/authentication/password-policies.html) and more.
|
||||
The following guide will walk you through setting up Keycloak with Dashy. If you already have a Keycloak instance configured, then skip to Step 3.
|
||||
|
||||
### 1. Deploy Keycloak
|
||||
|
||||
First thing to do is to spin up a new instance of Keycloak. You will need [Docker installed](https://docs.docker.com/engine/install/), and can then choose a tag, and pull the container from [quay.io/keycloak/keycloak](https://quay.io/repository/keycloak/keycloak)
|
||||
|
||||
Use the following run command, replacing the attributes (default credentials, port and name), or incorporate this into your docker-compose file.
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
-p 8081:8080 \
|
||||
--name auth-server \
|
||||
-e KEYCLOAK_USER=admin \
|
||||
-e KEYCLOAK_PASSWORD=admin \
|
||||
quay.io/keycloak/keycloak:15.0.2
|
||||
```
|
||||
|
||||
If you need to pull from DockerHub, a non-official image is available [here](https://registry.hub.docker.com/r/jboss/keycloak). Or if you would prefer not to use Docker, you can also directly install Keycloak from source, following [this guide](https://www.keycloak.org/docs/latest/getting_started/index.html).
|
||||
|
||||
You should now be able to access the Keycloak web interface, using the port specified above (e.g. `http://127.0.0.1:8081`), login with the default credentials, and when prompted create a new password.
|
||||
|
||||
### 2. Setup Keycloak Users
|
||||
|
||||
Before we can use Keycloak, we must first set it up with some users. Keycloak uses Realms (similar to tenants) to create isolated groups of users. You must create a Realm before you will be able to add your first user.
|
||||
1. Head over to the admin console
|
||||
2. In the top-left corner there is a dropdown called 'Master', hover over it and then click 'Add Realm'
|
||||
3. Give your realm a name, and hit 'Create'
|
||||
|
||||
You can now create your first user.
|
||||
1. In the left-hand menu, click 'Users', then 'Add User'
|
||||
2. Fill in the form, including username and hit 'Save'
|
||||
3. Under the 'Credentials' tab, give the new user an initial password. They will be prompted to change this after first login
|
||||
|
||||
The last thing we need to do in the Keycloak admin console is to create a new client
|
||||
1. Within your new realm, navigate to 'Clients' on the left-hand side, then click 'Create' in the top-right
|
||||
2. Choose a 'Client ID', set 'Client Protocol' to 'openid-connect', and for 'Valid Redirect URIs' put a URL pattern to where you're hosting Dashy (if you're just testing locally, then * is fine), and do the same for the 'Web Origins' field
|
||||
3. Make note of your client-id, and click 'Save'
|
||||
|
||||
### 3. Enable Keycloak in Dashy Config File
|
||||
Now that your Keycloak instance is up and running, all that's left to do is to configure Dashy to use it. Under `appConfig`, set `auth.enableKeycloak: true`, then fill in the details in `auth.keycloak`, including: `serverUrl` - the URL where your Keycloak instance is hosted, `realm` - the name you gave your Realm, and `clientId` - the Client ID you chose.
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
appConfig:
|
||||
...
|
||||
auth:
|
||||
enableKeycloak: true
|
||||
keycloak:
|
||||
serverUrl: 'http://localhost:8081'
|
||||
realm: 'alicia-homelab'
|
||||
clientId: 'dashy'
|
||||
```
|
||||
|
||||
Note that if you are using Keycloak V 17 or older, you will also need to set `legacySupport: true` (also under `appConfig.auth.keycloak`). This is because the API endpoint was updated in later versions.
|
||||
|
||||
### 4. Add groups and roles (Optional)
|
||||
Keycloak allows you to assign users roles and groups. You can use these values to configure who can access various sections or items in Dashy.
|
||||
Keycloak server administration and configuration is a deep topic; please refer to the [server admin guide](https://www.keycloak.org/docs/latest/server_admin/index.html#assigning-permissions-and-access-using-roles-and-groups) to see details about creating and assigning roles and groups.
|
||||
Once you have groups or roles assigned to users you can configure access under each section or item `displayData.showForKeycloakUser` and `displayData.hideForKeycloakUser`.
|
||||
Both show and hide configurations accept a list of `groups` and `roles` that limit access. If a users data matches one or more items in these lists they will be allowed or excluded as defined.
|
||||
```yaml
|
||||
sections:
|
||||
- name: DeveloperResources
|
||||
displayData:
|
||||
showForKeycloakUsers:
|
||||
roles: ['canViewDevResources']
|
||||
hideForKeycloakUsers:
|
||||
groups: ['ProductTeam']
|
||||
items:
|
||||
- title: Not Visible for developers
|
||||
displayData:
|
||||
hideForKeycloakUsers:
|
||||
groups: ['DevelopmentTeam']
|
||||
```
|
||||
|
||||
Depending on how you're hosting Dashy and Keycloak, you may also need to set some HTTP headers, to prevent a CORS error. This would typically be the `Access-Control-Allow-Origin [URL-of Dashy]` on your Keycloak instance. See the [Setting Headers](https://github.com/Lissy93/dashy/blob/master/docs/management.md#setting-headers) guide in the management docs for more info.
|
||||
|
||||
Your app is now secured :) When you load Dashy, it will redirect to your Keycloak login page, and any user without valid credentials will be prevented from accessing your dashboard.
|
||||
|
||||
From within the Keycloak console, you can then configure things like time-outs, password policies, etc. You can also backup your full Keycloak config, and it is recommended to do this, along with your Dashy config. You can spin up both Dashy and Keycloak simultaneously and restore both applications configs using a `docker-compose.yml` file, and this is recommended.
|
||||
|
||||
---
|
||||
|
||||
## Alternative Authentication Methods
|
||||
|
||||
If you are self-hosting Dashy, and require secure authentication to prevent unauthorized access, you have several options:
|
||||
If you are self-hosting Dashy, and require secure authentication to prevent unauthorized access, then you can either use Keycloak, or one of the following options:
|
||||
- [Authentication Server](#authentication-server) - Put Dashy behind a self-hosted auth server
|
||||
- [VPN](#vpn) - Use a VPN to tunnel into the network where Dashy is running
|
||||
- [IP-Based Access](#ip-based-access) - Disallow access from all IP addresses, except your own
|
||||
|
|
|
|||
|
|
@ -1,35 +0,0 @@
|
|||
# README
|
||||
|
||||
## Top-level Schemas
|
||||
|
||||
* [Dashy Config Schema](./dashy-config.md) – `https://example.com/schemas/abstract`
|
||||
|
||||
## Other Schemas
|
||||
|
||||
### Objects
|
||||
|
||||
* [Untitled object in Dashy Config Schema](./dashy-config-properties-pageinfo.md) – `https://example.com/schemas/abstract#/properties/pageInfo`
|
||||
|
||||
* [Untitled object in Dashy Config Schema](./dashy-config-properties-pageinfo-properties-navlinks-items.md) – `https://example.com/schemas/abstract#/properties/pageInfo/properties/navLinks/items`
|
||||
|
||||
* [Untitled object in Dashy Config Schema](./dashy-config-properties-appconfig.md "Application configuration") – `https://example.com/schemas/abstract#/properties/appConfig`
|
||||
|
||||
* [Untitled object in Dashy Config Schema](./dashy-config-properties-sections-items.md) – `https://example.com/schemas/abstract#/properties/sections/items`
|
||||
|
||||
* [Untitled object in Dashy Config Schema](./dashy-config-properties-sections-items-properties-displaydata.md "Optional meta data for customizing a section") – `https://example.com/schemas/abstract#/properties/sections/items/properties/displayData`
|
||||
|
||||
* [Untitled object in Dashy Config Schema](./dashy-config-properties-sections-items-properties-items-items.md) – `https://example.com/schemas/abstract#/properties/sections/items/properties/items/items`
|
||||
|
||||
### Arrays
|
||||
|
||||
* [Untitled array in Dashy Config Schema](./dashy-config-properties-pageinfo-properties-navlinks.md "Quick access links, displayed in header") – `https://example.com/schemas/abstract#/properties/pageInfo/properties/navLinks`
|
||||
|
||||
* [Untitled array in Dashy Config Schema](./dashy-config-properties-appconfig-properties-cssthemes.md "Theme names to be added to the dropdown") – `https://example.com/schemas/abstract#/properties/appConfig/properties/cssThemes`
|
||||
|
||||
* [Untitled array in Dashy Config Schema](./dashy-config-properties-sections.md "Array of sections, containing items") – `https://example.com/schemas/abstract#/properties/sections`
|
||||
|
||||
* [Untitled array in Dashy Config Schema](./dashy-config-properties-sections-items-properties-items.md "Array of items to display with a section") – `https://example.com/schemas/abstract#/properties/sections/items/properties/items`
|
||||
|
||||
## Version Note
|
||||
|
||||
The schemas linked above follow the JSON Schema Spec version: `http://json-schema.org/draft-06/schema#`
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# Untitled string in Dashy Config Schema Schema
|
||||
|
||||
```txt
|
||||
https://example.com/schemas/abstract#/properties/appConfig/properties/backgroundImg
|
||||
```
|
||||
|
||||
A URL to an image asset to be displayed as background
|
||||
|
||||
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
||||
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
|
||||
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
|
||||
|
||||
## backgroundImg Type
|
||||
|
||||
`string`
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# Untitled string in Dashy Config Schema Schema
|
||||
|
||||
```txt
|
||||
https://example.com/schemas/abstract#/properties/appConfig/properties/cssThemes/items
|
||||
```
|
||||
|
||||
|
||||
|
||||
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
||||
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
|
||||
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
|
||||
|
||||
## items Type
|
||||
|
||||
`string`
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# Untitled array in Dashy Config Schema Schema
|
||||
|
||||
```txt
|
||||
https://example.com/schemas/abstract#/properties/appConfig/properties/cssThemes
|
||||
```
|
||||
|
||||
Theme names to be added to the dropdown
|
||||
|
||||
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
||||
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
|
||||
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
|
||||
|
||||
## cssThemes Type
|
||||
|
||||
`string[]`
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# Untitled string in Dashy Config Schema Schema
|
||||
|
||||
```txt
|
||||
https://example.com/schemas/abstract#/properties/appConfig/properties/customCss
|
||||
```
|
||||
|
||||
Any custom CSS overides, must be minified
|
||||
|
||||
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
||||
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
|
||||
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
|
||||
|
||||
## customCss Type
|
||||
|
||||
`string`
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
# Untitled boolean in Dashy Config Schema Schema
|
||||
|
||||
```txt
|
||||
https://example.com/schemas/abstract#/properties/appConfig/properties/enableFontAwesome
|
||||
```
|
||||
|
||||
Should load font-awesome assets
|
||||
|
||||
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
||||
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
|
||||
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
|
||||
|
||||
## enableFontAwesome Type
|
||||
|
||||
`boolean`
|
||||
|
||||
## enableFontAwesome Default Value
|
||||
|
||||
The default value is:
|
||||
|
||||
```json
|
||||
true
|
||||
```
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# Untitled string in Dashy Config Schema Schema
|
||||
|
||||
```txt
|
||||
https://example.com/schemas/abstract#/properties/appConfig/properties/externalStyleSheet/items
|
||||
```
|
||||
|
||||
|
||||
|
||||
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
||||
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
|
||||
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
|
||||
|
||||
## items Type
|
||||
|
||||
`string`
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# Untitled undefined type in Dashy Config Schema Schema
|
||||
|
||||
```txt
|
||||
https://example.com/schemas/abstract#/properties/appConfig/properties/externalStyleSheet
|
||||
```
|
||||
|
||||
URL or URLs of external stylesheets to add to dropdown/ load
|
||||
|
||||
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
||||
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
|
||||
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
|
||||
|
||||
## externalStyleSheet Type
|
||||
|
||||
any of the folllowing: `string` or `array` ([Details](dashy-config-properties-appconfig-properties-externalstylesheet.md))
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
# Untitled string in Dashy Config Schema Schema
|
||||
|
||||
```txt
|
||||
https://example.com/schemas/abstract#/properties/appConfig/properties/fontAwesomeKey
|
||||
```
|
||||
|
||||
API key for font-awesome
|
||||
|
||||
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
||||
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
|
||||
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
|
||||
|
||||
## fontAwesomeKey Type
|
||||
|
||||
`string`
|
||||
|
||||
## fontAwesomeKey Constraints
|
||||
|
||||
**pattern**: the string must match the following regular expression:
|
||||
|
||||
```regexp
|
||||
^[a-z0-9]{10}$
|
||||
```
|
||||
|
||||
[try pattern](https://regexr.com/?expression=%5E%5Ba-z0-9%5D%7B10%7D%24 "try regular expression with regexr.com")
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
# Untitled string in Dashy Config Schema Schema
|
||||
|
||||
```txt
|
||||
https://example.com/schemas/abstract#/properties/appConfig/properties/theme
|
||||
```
|
||||
|
||||
A theme to be applied by default on first load
|
||||
|
||||
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
||||
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
|
||||
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [dashy-config.schema.json*](../../out/dashy-config.schema.json "open original schema") |
|
||||
|
||||
## theme Type
|
||||
|
||||
`string`
|
||||
|
||||
## theme Default Value
|
||||
|
||||
The default value is:
|
||||
|
||||
```json
|
||||
"Callisto"
|
||||
```
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue