diff --git a/.github/CHANGELOG.md b/.github/CHANGELOG.md
index 53d16209..fbb44661 100644
--- a/.github/CHANGELOG.md
+++ b/.github/CHANGELOG.md
@@ -1,5 +1,13 @@
# Changelog
+## ⚡️ 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
diff --git a/Dockerfile b/Dockerfile
index 5814f880..9cde9c99 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -10,6 +10,7 @@ WORKDIR ${DIRECTORY}
# Copy over both 'package.json' and 'package-lock.json' (if available)
COPY package*.json ./
+COPY yarn.lock ./
# Install project dependencies
RUN yarn
diff --git a/README.md b/README.md
index 67b6d267..be551c04 100644
--- a/README.md
+++ b/README.md
@@ -40,7 +40,7 @@
@@ -58,18 +58,19 @@
- Instant search by name, domain and tags - just start typing
- Full customizable keyboard shortcuts for navigation, filtering and launching apps
-- Multiple built-in color themes, with UI color configurator and support for custom CSS
-- Easy to customize every part of your dashboard, layout, icon sizes, behavior and colors etc
-- Many options for icons, including Font-Awesome support, auto-fetching service favicon, images and emojis
+- Multiple built-in color themes, with UI color editor and support for custom CSS
+- Customizable layout, sizes, text, component visibility, behavior and colors etc
+- Many options for icons, including Font-Awesome support, auto-fetching favicon, images and emojis
- Option to show service status for each of your apps / links, for basic availability and uptime monitoring
-- Multiple ways of opening apps, either in your browser, a pop-up modal or workspace view
+- Choose how to launch apps, either in your browser, a pop-up modal or workspace view
- Option for full-screen background image, custom nav-bar links, html footer, title, and more
- Encrypted cloud backup and restore feature available
- Optional authentication, requiring admins and non-privileged users to log in
-- Easy single-file YAML-based configuration, which can also be configured directly through the UI
- Small bundle size, fully responsive UI and PWA makes the app easy to use on any device
- Easy to setup with Docker, or on bare metal, or with 1-Click cloud deployment
-- Multi-language support, with additional languages coming soon
+- Multi-language support, with more languages being added regularly
+- Easy single-file YAML-based configuration, or configure app directly through the UI
+- Strong focus on privacy
- Plus lots more...
## Demo ⚡
@@ -348,9 +349,9 @@ Dashy has the ability to support multiple languages and locales. When available,
#### Supported Languages
- 🇬🇧 **English**: `en`
-- 🇩🇪 **German**: `de`
-- 🇳🇱 **Dutch**: `nl`
-- 🇲🇫 **French**: `fr`
+- 🇩🇪 **German**: `de` - Contributed by **[@Niklashere](https://github.com/Niklashere)**
+- 🇳🇱 **Dutch**: `nl` - Contributed by **[@evroon](https://github.com/evroon)**
+- 🇲🇫 **French**: `fr` - Contributed by **[@EVOTk](https://github.com/EVOTk)**
#### Add your Language
It would be awesome for open source projects to be available to everyone, without language being a barrier to entry for non-native English speakers. If you have a few minutes to sapir, you're help with translating it would be very much appreciated.
@@ -394,7 +395,7 @@ pageInfo:
> For general discussions, check out the **[Discussions Board](https://github.com/Lissy93/dashy/discussions)**
-If you're having trouble getting things up and running, feel free to ask a question. The best way to do so is in the [discussion](https://github.com/Lissy93/dashy/discussions), or if you think you think the issue is on Dashy's side, you can [raise a ticket](https://github.com/Lissy93/dashy/issues/new/choose). It's best to check the [docs](./docs) and [previous questions](https://github.com/Lissy93/dashy/issues?q=label%3A%22%F0%9F%A4%B7%E2%80%8D%E2%99%82%EF%B8%8F+Question%22+) first, as you'll likley find the solution there.
+If you're having trouble getting things up and running, feel free to ask a question. The best way to do so is in the [discussion](https://github.com/Lissy93/dashy/discussions), or if you think you think the issue is on Dashy's side, you can [raise a ticket](https://github.com/Lissy93/dashy/issues/new/choose). It's best to check the [docs](./docs) and [previous questions](https://github.com/Lissy93/dashy/issues?q=label%3A%22%F0%9F%A4%B7%E2%80%8D%E2%99%82%EF%B8%8F+Question%22+) first, as you'll likely find the solution there.
**[⬆️ Back to Top](#dashy)**
@@ -406,7 +407,8 @@ Found a bug, or something that isn't working as you'd expect? Please raise it as
- [Submit a Feature Request 🦄](https://github.com/Lissy93/dashy/issues/new?assignees=Lissy93&labels=%F0%9F%A6%84+Feature+Request&template=feature-request---.md&title=%5BFEATURE_REQUEST%5D)
- [Share Feedback 🌈](https://github.com/Lissy93/dashy/issues/new?assignees=&labels=%F0%9F%8C%88+Feedback&template=share-feedback---.md&title=%5BFEEDBACK%5D)
-**Issue Status** [  ](https://isitmaintained.com/project/lissy93/dashy)
+**Issue Status** [  ](https://isitmaintained.com/project/lissy93/dashy) [
+](https://github.com/Lissy93/dashy/discussions)
**[⬆️ Back to Top](#dashy)**
@@ -436,7 +438,8 @@ Thank you so much to everyone who has helped with Dashy so far, every contributi
#### Sponsors
Huge thanks to the sponsors helping to support Dashy's development!
-
+
+
#### Contributors
@@ -472,11 +475,12 @@ Like most Git repos, we are following the [Github Flow](https://guides.github.co
Branch names are specified in the following format: `[TYPE]/[TICKET]_[TITLE]`. E.g. `FEATURE/420_Awesome-feature` or `FIX/690_login-server-error`.
-Most commits have been using git commit emojis, see [gitmoji.dev](https://gitmoji.dev/) for what each emoji indicates.
+Most commit messages use git [commit emojis](https://gist.github.com/parmentf/035de27d6ed1dce0b36a) - e.g. ✨ = New feature, 🐛 = Bug fix, 💄 = UI stuff, 🚧 = Work in progress, 🔖 = New release, and so on. Take a look at [gitmoji.dev](https://gitmoji.dev/) for a list of what each emoji indicates
Before you submit your pull request, please ensure you've checked off all the boxes in the template. For your PR to be merged, it must:
- Must be backwards compatible
-- The build, lint and tests (run by GH actions) must pass
+- Any new features should be documented
+- The build, lint and tests (run by GH actions) should all pass (there are some exceptions)
- There must not be any merge conflicts
If you're new to web development, I've put together a short [list of resources](https://github.com/Lissy93/dashy/blob/master/docs/developing.md#resources-for-beginners), to help beginners get started
@@ -525,9 +529,9 @@ If you're new to web development, I've put together a short [list of resources](
---
-## 🛣️ Roadmap
+## Roadmap 🛣️
-> For past and future app updates, see: [**Changelog**](./docs/changelog.md)
+> For past and future app updates, see: [**Changelog**](/.github/CHANGELOG.md)
The following features and tasks are planned for the near future.
@@ -543,7 +547,10 @@ The following features and tasks are planned for the near future.
## Alternatives 🙌
There are a few self-hosted web apps, that serve a similar purpose to Dashy. If you're looking for a dashboard, and Dashy doesn't meet your needs, I highly recommend you check these projects out!
-[HomeDash2](https://lamarios.github.io/Homedash2), [Homer](https://github.com/bastienwirtz/homer) (`Apache License 2.0`), [Organizr](https://organizr.app/) (`GPL-3.0 License`) and [Heimdall](https://github.com/linuxserver/Heimdall) (`MIT License`)
+- [HomeDash2](https://lamarios.github.io/Homedash2)
+- [Homer](https://github.com/bastienwirtz/homer) (`Apache License 2.0`)
+- [Organizr](https://organizr.app/) (`GPL-3.0 License`)
+- [Heimdall](https://github.com/linuxserver/Heimdall) (`MIT License`)
**[⬆️ Back to Top](#dashy)**
@@ -590,9 +597,15 @@ For more info, see TLDR Legal's [Explanation of MIT](https://tldrlegal.com/licen
diff --git a/docs/assets/CONTRIBUTORS.svg b/docs/assets/CONTRIBUTORS.svg
index 2e54d14b..ad273b7c 100644
--- a/docs/assets/CONTRIBUTORS.svg
+++ b/docs/assets/CONTRIBUTORS.svg
@@ -6,10 +6,13 @@
+
+
+
-
+
-
+
\ No newline at end of file
diff --git a/docs/configuring.md b/docs/configuring.md
index 8879b082..291a5593 100644
--- a/docs/configuring.md
+++ b/docs/configuring.md
@@ -74,6 +74,7 @@ To disallow any changes from being written to disk via the UI config editor, set
**`hideComponents`** | `object` | _Optional_ | A list of key page components (header, footer, search, settings, etc) that are present by default, but can be removed using this option. See [`appConfig.hideComponents`](#appconfighideComponents-optional)
**`allowConfigEdit`** | `boolean` | _Optional_ | Should prevent / allow the user to write configuration changes to the conf.yml from the UI. When set to `false`, the user can only apply changes locally using the config editor within the app, whereas if set to `true` then changes can be written to disk directly through the UI. Defaults to `true`. Note that if authentication is enabled, the user must be of type `admin` in order to apply changes globally.
**`enableErrorReporting`** | `boolean` | _Optional_ | Enable reporting of unexpected errors and crashes. This is off by default, and **no data will ever be captured unless you explicitly enable it**. Turning on error reporting helps previously unknown bugs get discovered and fixed. Dashy uses [Sentry](https://github.com/getsentry/sentry) for error reporting. Defaults to `false`.
+**`sentryDsn`** | `boolean` | _Optional_ | If you need to monitor errors in your instance, then you can use Sentry to collect and process bug reports. Sentry can be self-hosted, or used as SaaS, once your instance is setup, then all you need to do is pass in the DSN here, and enable error reporting. You can learn more on the [Sentry DSN Docs](https://docs.sentry.io/product/sentry-basics/dsn-explainer/). Note that this will only ever be used if `enableErrorReporting` is explicitly enabled.
**`disableUpdateChecks`** | `boolean` | _Optional_ | If set to true, Dashy will not check for updates. Defaults to `false`.
**`disableServiceWorker`** | `boolean` | _Optional_ | Service workers cache web applications to improve load times and offer basic offline functionality, and are enabled by default in Dashy. The service worker can sometimes cause older content to be cached, requiring the app to be hard-refreshed. If you do not want SW functionality, or are having issues with caching, set this property to `true` to disable all service workers.
**`disableContextMenu`** | `boolean` | _Optional_ | If set to `true`, the custom right-click context menu will be disabled. Defaults to `false`.
diff --git a/docs/contributing.md b/docs/contributing.md
index 1d5064ef..8109f432 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -10,6 +10,10 @@ Contributing to the code or documentation is super helpful. You can fix a bug, a
## Add Translations
If you speak another language, then adding translations would be really helpful, and you will be credited in the readme for your work. Multi-language support makes Dashy accessible for non-English speakers, which I feel is important. This is a very quick and easy task, as all application text is located in [`locales/en.json`](https://github.com/Lissy93/dashy/blob/master/src/assets/locales/en.json), so adding a new language is as simple as copying this file and translating the values. You don't have to translate it all, as any missing attributes will just fallback to English. For a full tutorial, see the [Multi-Language Support Docs](https://github.com/Lissy93/dashy/blob/master/docs/multi-language-support.md).
+## Improve the Docs
+Found a typo, or something that isn't as clear as it could be? Maybe I've missed something off altogether, or you hit a roadblock that took you a while to figure out. Submitting a pull request to add to or improve the documentation will help future users get Dashy up and running more easily.
+All content is located either in the [`./README.md`](/README.md) or [`/docs/`](/docs) directory, and synced to the Wiki and website using a GH [action](/actions/workflows/wiki-sync.yml).
+
## Raise a bug
If you've found a bug, then please do raise it as an issue. This will help me know if there's something that needs fixing. Try and include as much detail as possible, such as your environment, steps to reproduce, any console output and maybe an example screenshot or recording if necessary. You can [Raise a Bug here](https://github.com/Lissy93/dashy/issues/new?assignees=Lissy93&labels=%F0%9F%90%9B+Bug&template=bug-report---.md&title=%5BBUG%5D) 🐛.
@@ -33,11 +37,12 @@ Dashy is still a relatively young project, and as such not many people know of i
[](https://t.me/share/url?url=https%3A%2F%2Fgithub.com%2Flissy93%2Fdashy&text=Check%20out%20Dashy%2C%20the%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80)
[](mailto:info@example.com?&subject=Check%20out%20Dashy%20-%20The%20self-hosted%20dashboard%20for%20your%20homelab%20%F0%9F%9A%80&cc=&bcc=&body=https://github.com/lissy93/dashy)
-## Leave a review
+## Star, Upvote or Leave a Review
Dashy is on the following platforms, and if you could spare a few seconds to give it an upvote or review, this will also help new users find it.
[](https://www.producthunt.com/posts/dashy)
[](https://alternativeto.net/software/dashy/about/)
+[](https://github.com/Lissy93/dashy/stargazers)
## Make a small donation
@@ -47,10 +52,15 @@ Please only do this is you can definitely afford to. Don't feel any pressure to
Sponsoring will give you several perks, from $1 / £0.70 per month, as well as a sponsor badge on your profile, you can also be credited on the readme, with a link to your website/ profile/ socials, get priority support, have your feature ideas implemented, plus lots more. For more info, see [@Lissy93's Sponsor Page](https://github.com/sponsors/Lissy93).
-You can also send one-off small contriutions using crypto:
+
+ You can also send a one-off small contribution using crypto
+
+
## Request a feature via BountySource
BountySource is a platform for sponsoring the development of certain features on open source projects. If there is a feature you'd like implemented into Dashy, but either isn't high enough priority or is deemed to be more work than it's worth, then you can instead contribute a bounty towards it's development. You won't pay a penny until your proposal is fully built, and you are satisfied with the result. This helps support the developers, and makes Dashy better for everyone.
@@ -69,7 +79,7 @@ appConfig:
All reporting is **disabled** by default, and no data will ever be sent to any external endpoint without your explicit consent. In fact, the error tracking package will not even be imported unless you have actively enabled it. All statistics are anonomized and stored securely. For more about privacy and security, see the [Sentry Docs](https://sentry.io/security/).
## Follow for More
-If you've enjoyed Dashy, you can follow the me to get updates about other projects that I am working on. Or [subscribe to my mailing list](https://notes.aliciasykes.com/subscribe) for very occasional blog post updates.
+If you've enjoyed Dashy, you can follow the me to get updates about other projects that I am working on.
[](https://twitter.com/Lissy_Sykes)
[](https://github.com/Lissy93)
@@ -79,10 +89,14 @@ If you've enjoyed Dashy, you can follow the me to get updates about other projec
[](https://aliciasykes.com)
[](https://notes.aliciasykes.com/)
+If you like, you could also consider [subscribing to my mailing list](https://notes.aliciasykes.com/subscribe) for very occasional blog post updates, or even [nominating me (`@lissy93`)](https://stars.github.com/nominate/) on the GitHub Star Programme.
+
---
### Contributors
+For a full list of Dashy's contributors, see the [Credits Page](/docs/credits.md)
+
### Star-Gazers Over Time
diff --git a/docs/credits.md b/docs/credits.md
index 9571e785..75477ffd 100644
--- a/docs/credits.md
+++ b/docs/credits.md
@@ -39,6 +39,13 @@
Erik Vroon
+
-
+ 
+ 
@@ -59,7 +66,8 @@
diff --git a/docs/deployment.md b/docs/deployment.md
index e91cf72f..cc5c3ad2 100644
--- a/docs/deployment.md
+++ b/docs/deployment.md
@@ -10,7 +10,7 @@ docker run -p 8080:80 lissy93/dashy
See [Management Docs](./docs/management.md) for info about securing, monitoring, updating, health checks, auto starting, web server configuration, etc
-Once you've got Dashy up and running, you'll want to configure it with your own content. You can either reference the [configuring docs]() or follow this [step-by-step guide]().
+Once you've got Dashy up and running, you'll want to configure it with your own content, for this you can reference the [configuring docs](./docs/configuring.md).
## Deployment Methods
@@ -100,12 +100,6 @@ If you do not want to use Docker, you can run Dashy directly on your host system
4. Build: `yarn build`
5. Run: `yarn start`
-### Run as executable
-
-### Install with NPM
-
-### Use managed instance
-
### Deploy to cloud service
If you don't have a home server, then fear not - Dashy can be deployed to pretty much any cloud provider. The above Docker and NPM guides will work exactly the same on a VPS, but I've also setup some 1-Click deploy links for 10+ of the most common cloud providers, to make things easier. Note that if your instance is exposed to the internet, it will be your responsibility to adequately secure it.
diff --git a/docs/privacy.md b/docs/privacy.md
index 39259c73..ff43538b 100644
--- a/docs/privacy.md
+++ b/docs/privacy.md
@@ -31,12 +31,14 @@ The status check util will ping your services directly, and does not rely on any
When the application loads, it checks for updates. The results of which are displayed in the config menu of the UI. This was implemented because using a very outdated version of Dashy may have unfixed issues. Your version is fetched from the source (local request), but the latest version is fetched from GitHub, which is an external request. This can be disabled by setting `appConfig.disableUpdateChecks: true`
### Anonymous Error Reporting
-Error reporting is disabled by default, and no data will ever be sent without your explicit consent. In fact, the error tracking method will not even be imported unless you have actively enabled it. [Sentry](https://github.com/getsentry/sentry) is used for this, it's an open source error tracking and performance monitoring tool, which is used to identify any errors which occur in the production app (if you enable it).
+Error reporting is disabled by default, and no data will ever be sent without your explicit consent. In fact, the error tracking method will not even be imported unless you have actively enabled it. [Sentry](https://github.com/getsentry/sentry) is used for this, it's an open source error tracking and performance monitoring tool, which is used to identify any issues which occur in the production app (if you enable it).
The crash report includes the file or line of code that triggered the error, and a 2-layer deep stack trace. Reoccurring errors will also include the following user information: OS type (Mac, Windows, Linux, Android or iOS) and browser type (Firefox, Chrome, IE, Safari). Data scrubbing is enabled. IP address will not be stored. If any potentially identifiable data ever finds its way into a crash report, it will be automatically and permanently erased. All statistics collected are anonomized and stored securely, and ae automatically deleted after 14 days. For more about privacy and security, see the [Sentry Docs](https://sentry.io/security/).
Enabling anonymous error reporting helps me to discover bugs I was unaware of, and then fix them, in order to make Dashy more reliable long term. Error reporting is activated by setting `appConfig.enableErrorReporting: true`.
+If you need to monitor bugs yourself, then you can [self-host your own Sentry Server](https://develop.sentry.dev/self-hosted/), and use it by setting `appConfig.sentryDsn` to your Sentry instances [Data Source Name](https://docs.sentry.io/product/sentry-basics/dsn-explainer/), then just enable error reporting in Dashy.
+
---
## Dependencies
@@ -58,6 +60,7 @@ There is very little complexity involved with Dashy, and therefore the attack su
- Enable and configure firewall rules
- Implement security, malware and traffic scanning
- Setup malicious traffic detection
+- Understand the [Docker attack fronts](https://docs.docker.com/engine/security/), and follow [Docker Security Best Practices](https://snyk.io/blog/10-docker-image-security-best-practices/)
This is covered in more detail in [App Management](/docs/management.md).
diff --git a/docs/readme.md b/docs/readme.md
index b6a2d859..334cb7b5 100644
--- a/docs/readme.md
+++ b/docs/readme.md
@@ -21,7 +21,7 @@
- [Status Indicators](/docs/status-indicators.md) - Using Dashy to monitor uptime and status of your apps
- [Theming](/docs/theming.md) - Complete guide to applying, writing and modifying themes and styles
-#### Misc
+### Misc
- [Privacy & Security](/docs/privacy.md) - List of requests, potential issues, and security resources
- [License](/LICENSE) - Copy of the MIT License
- [Legal](/.github/LEGAL.md) - Licenses of direct dependencies
diff --git a/package.json b/package.json
index 3985e7a2..21bea866 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "Dashy",
- "version": "1.5.5",
+ "version": "1.5.6",
"license": "MIT",
"main": "server",
"scripts": {
@@ -74,6 +74,7 @@
],
"rules": {
"import/no-unresolved": "off",
+ "import/extensions": "off",
"arrow-parens": 0,
"no-else-return": 0
},
diff --git a/src/assets/locales/en.json b/src/assets/locales/en.json
index 6a3a6175..f52aa0ab 100644
--- a/src/assets/locales/en.json
+++ b/src/assets/locales/en.json
@@ -26,7 +26,7 @@
"logout-message": "Logged Out"
},
"config": {
- "main-tab": "Config",
+ "main-tab": "Main Menu",
"view-config-tab": "View Config",
"edit-config-tab": "Edit Config",
"custom-css-tab": "Custom Styles",
@@ -142,6 +142,7 @@
"restore-id-label": "Restore ID",
"restore-password-label": "Password",
"restore-button": "Restore",
+ "backup-missing-password": "Missing Password",
"backup-error-unknown": "Unable to process request",
"backup-error-password": "Incorrect password. Please enter your current password.",
"backup-success-msg": "Completed Successfully",
diff --git a/src/assets/locales/fr.json b/src/assets/locales/fr.json
index 66ad6037..6d89e834 100644
--- a/src/assets/locales/fr.json
+++ b/src/assets/locales/fr.json
@@ -26,7 +26,7 @@
"logout-message": "Déconnexion"
},
"config": {
- "main-tab": "Configuration",
+ "main-tab": "Menu principal",
"view-config-tab": "Afficher la configuration",
"edit-config-tab": "Modifier la configuration",
"custom-css-tab": "Styles personnalisés",
@@ -142,6 +142,7 @@
"restore-id-label": "Identifiant de sauvegarde",
"restore-password-label": "Mot de passe",
"restore-button": "Restaurer",
+ "backup-missing-password": "Mot de passe manquant",
"backup-error-unknown": "Impossible de traiter la demande",
"backup-error-password": "Mot de passe incorrect. Veuillez saisir votre mot de passe actuel.",
"backup-success-msg": "Sauvegarde effectuée avec succès",
diff --git a/src/components/Configuration/CloudBackupRestore.vue b/src/components/Configuration/CloudBackupRestore.vue
index 36b00f8d..9703d534 100644
--- a/src/components/Configuration/CloudBackupRestore.vue
+++ b/src/components/Configuration/CloudBackupRestore.vue
@@ -96,7 +96,9 @@ export default {
},
checkPass() {
const savedHash = localStorage[localStorageKeys.BACKUP_HASH] || undefined;
- if (!savedHash) {
+ if (!this.backupPassword) {
+ this.showErrorMsg(this.$t('cloud-sync.backup-missing-password'));
+ } else if (!savedHash) {
this.makeBackup();
} else if (savedHash === this.makeHash(this.backupPassword)) {
this.makeUpdate();
diff --git a/src/components/Configuration/ConfigContainer.vue b/src/components/Configuration/ConfigContainer.vue
index 37cc397c..d1ebbd42 100644
--- a/src/components/Configuration/ConfigContainer.vue
+++ b/src/components/Configuration/ConfigContainer.vue
@@ -10,15 +10,15 @@
{{ $t('config.download-config-button') }}
-