Skip to content

armgit / dashy

Public Imported from GitHub
0

πŸš€ A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!

πŸ“ Updates config info and paths in docs

Alicia Sykes0084cb39b8ba
diff --git a/docs/authentication.md b/docs/authentication.md
index 35846b1a..252e1d79 100644
--- a/docs/authentication.md
+++ b/docs/authentication.md
@@ -14,7 +14,7 @@
- [Deploying Keycloak](#1-deploy-keycloak)
- [Setting up Keycloak](#2-setup-keycloak-users)
- [Configuring Dashy for Keycloak](#3-enable-keycloak-in-dashy-config-file)
- - [Toubleshooting Keycloak](#troubleshooting-keycloak)
+ - [Troubleshooting Keycloak](#troubleshooting-keycloak)
- [OIDC Auth](#oidc)
- [authentik](#authentik)
- [Alternative Authentication Methods](#alternative-authentication-methods)
@@ -26,7 +26,7 @@
> [!IMPORTANT]
-> Dashy's built-in auth is not indented to protect a publicly hosted instance against unauthorized access. Instead you should use an auth provider compatible with your reverse proxy, or access Dashy via your VPN, or implement your own SSO logic.
+> Dashy's built-in auth is not intended to protect a publicly hosted instance against unauthorized access. Instead you should use an auth provider compatible with your reverse proxy, or access Dashy via your VPN, or implement your own SSO logic.
>
> In cases where Dashy is only accessibly within your home network, and you just want to add a login page, then the built-in auth may be sufficient, but keep in mind that configuration can still be accessed.
diff --git a/docs/developing.md b/docs/developing.md
index 0168fc78..85a414f2 100644
--- a/docs/developing.md
+++ b/docs/developing.md
@@ -51,7 +51,7 @@ Dashy should now be being served on <http://localhost:8080/>. Hot reload is enab
#### Utils and Checks
-- **`yarn validate-config`** - If you have quite a long configuration file, you may wish to check that it's all good to go, before deploying the app. This can be done with `yarn validate-config` or `docker exec -it [container-id] yarn validate-config`. Your config file needs to be in `/user-data/conf.yml` (or within your Docker container at `/app/user-data/conf.yml`). This will first check that your YAML is valid, and then validates it against Dashy's [schema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.js).
+- **`yarn validate-config`** - If you have quite a long configuration file, you may wish to check that it's all good to go, before deploying the app. This can be done with `yarn validate-config` or `docker exec -it [container-id] yarn validate-config`. Your config file needs to be in `/user-data/conf.yml` (or within your Docker container at `/app/user-data/conf.yml`). This will first check that your YAML is valid, and then validates it against Dashy's [schema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.json).
- **`yarn health-check`** - Checks that the application is up and running on it's specified port, and outputs current status and response times. Useful for integrating into your monitoring service, if you need to maintain high system availability
#### Alternate Start Commands
@@ -330,7 +330,7 @@ Styleguides:
β”‚ β”œβ”€β”€ CloudBackup.js # Functionality for encrypting, processing and network calls
β”‚ β”œβ”€β”€ ConfigSchema.json # The schema, used to validate the users conf.yml file
β”‚ β”œβ”€β”€ ConfigAccumulator.js # Central place for managing and combining config
-β”‚ β”œβ”€β”€ ConfigHelpers.json # Collection of helper functions to process config using accumulator
+β”‚ β”œβ”€β”€ ConfigHelpers.js # Collection of helper functions to process config using accumulator
β”‚ β”œβ”€β”€ ConfigValidator.js # A helper script that validates the config file against schema
β”‚ β”œβ”€β”€ CoolConsole.js # Prints info, warning and error messages to browser console, with a cool style
β”‚ β”œβ”€β”€ defaults.js # Global constants and their default values
@@ -341,14 +341,18 @@ Styleguides:
β”‚ β”œβ”€β”€ Search.js # Helper functions for searching/ filtering items in all views
β”‚ β”œβ”€β”€ JsonToYaml.js # Function that parses and converts raw JSON into valid YAML
β”‚ β”œβ”€β”€ KeycloakAuth.js # Singleton class to manage Keycloak authentication
+β”‚ β”œβ”€β”€ OidcAuth.js # Manages OIDC authentication with external providers
+β”‚ β”œβ”€β”€ HeaderAuth.js # Handles header-based authentication via reverse proxy
β”‚ β”œβ”€β”€ languages.js # Handles fetching, switching and validating languages
β”‚ ╰── ThemeHelper.js # Function that handles the fetching and setting of user themes
╰── views # Directory of available pages, corresponding to available routes
β”œβ”€β”€ Home.vue # The home page container
β”œβ”€β”€ About.vue # About page
- β”œβ”€β”€ Login.vue # TAuthentication page
+ β”œβ”€β”€ Login.vue # Authentication page
β”œβ”€β”€ Minimal.vue # The minimal view
- ╰── Workspace.vue # The workspace view with apps in sidebar
+ β”œβ”€β”€ Workspace.vue # The workspace view with apps in sidebar
+ β”œβ”€β”€ DownloadConfig.vue # Config export page
+ ╰── 404.vue # Not found page
```
#### Visualisation of Source Directory
diff --git a/docs/development-guides.md b/docs/development-guides.md
index ffc6bd75..e7e2059e 100644
--- a/docs/development-guides.md
+++ b/docs/development-guides.md
@@ -129,7 +129,7 @@ Then, where you want to get the users value within your component, use something
If you have a default fallback value, then this would typically be specified in the [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js) file.
-You will now need to add the definition of your new attribute into the [ConfigSchema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.js). This will make it available in the UI config editor, and also ensure that the config validation check doesn't fail.
+You will now need to add the definition of your new attribute into the [ConfigSchema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.json). This will make it available in the UI config editor, and also ensure that the config validation check doesn't fail.
For example:
```json
@@ -156,7 +156,7 @@ Finally, add your new property to the [`configuring.md`](./configuring.md) API d
Checklist:
- [ ] Ensure the new attribute is actually necessary, and nothing similar already exists
-- [ ] Update the [Schema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.js) with the parameters for your new option
+- [ ] Update the [Schema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.json) with the parameters for your new option
- [ ] If required, set a default or fallback value (usually in [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js))
- [ ] Document the new value in [`configuring.md`](./configuring.md), and if required under the relevant section in the docs
- [ ] Ensure your changes are backwards compatible, and that nothing breaks if the attribute isn't specified
diff --git a/docs/icons.md b/docs/icons.md
index 67ef94fd..25d5cf1f 100644
--- a/docs/icons.md
+++ b/docs/icons.md
@@ -44,6 +44,7 @@ The following favicon APIs are supported:
- `duckduckgo` - Returns decent quality website icons, from DuckDuckGo search
- `google` - Official Google favicon API service, good support for all sites, but poor quality
- `yandex` - Lower quality icons, but useful in some regions where other services are blocked
+- `webmasterapi` - [WebMasterAPI](https://www.webmasterapi.com/) fetches website favicons via their API
- `local` - Set to local to fetch the default icon at /favicon.ico instead of using an API
If for a given service none of the APIs work in your situation, and nor does local, then the best option is to find the path of the services logo or favicon, and set the icon to the URL of the raw image. For example, `icon: https://monitoring.local/faviconx128.png`- you can find this path using the browser dev tools.
diff --git a/docs/multi-language-support.md b/docs/multi-language-support.md
index 118f7ba2..2adbf7f1 100644
--- a/docs/multi-language-support.md
+++ b/docs/multi-language-support.md
@@ -27,7 +27,7 @@ appConfig:
### Available Languages
-At the time of writing the following languages are supported: `en`, `zh-CN`, `nl`, `fr`, `de`, `es`, `sl`, `it`, `pt`, `ru`, `ar`, `hi`, `ja`, but an up-to-date list of all implemented translations can be found in [`./src/utils/languages.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/languages.js). Languages are specified by their 2-digit [ISO-639 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes), or sometimes a 4-digit code if it's a regional dialect.
+At the time of writing the following languages are supported: `en`, `ar`, `bg`, `bn`, `cs`, `da`, `de`, `el`, `es`, `fr`, `gl`, `hi`, `hu`, `it`, `ja`, `ko`, `nb`, `nl`, `pl`, `pt`, `ro`, `ru`, `sk`, `sl`, `sv`, `tr`, `uk`, `zh-CN`, `zh-TW`, but an up-to-date list of all implemented translations can be found in [`./src/utils/languages.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/languages.js). Languages are specified by their 2-digit [ISO-639 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes), or sometimes a 4-digit code if it's a regional dialect.
---
diff --git a/docs/theming.md b/docs/theming.md
index e15c356f..3296a98a 100644
--- a/docs/theming.md
+++ b/docs/theming.md
@@ -1,6 +1,6 @@
# Theming
-By default Dashy comes with 25+ built-in themes, which can be applied from the dropdown menu in the UI.
+By default Dashy comes with 40+ built-in themes, which can be applied from the dropdown menu in the UI.
![Built-in Themes](https://i.ibb.co/GV3wRss/Dashy-Themes.png)