mirror of https://github.com/Lissy93/dashy.git
Fix formatting in documentation
Removed trailing whitespaces and extra newlines. Added some missing punctuation. Replaced unicode characters that aren't commonly used with the more common character. The replaced unicode characters are - ’ (U+2019) to ' (U+0027) - “ (U+201C) to " (U+0022) - ” (U+201D) to " (U+0022)
This commit is contained in:
David Alasow
parent
bb1e6fa7c9
commit
99463413b1
|
|
@ -49,7 +49,7 @@ Dashy supports several different ways to launch your apps. The primary opening m
|
|||
|
||||
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.
|
||||
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" />
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@
|
|||
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
|
||||
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.
|
||||
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
|
||||
|
|
@ -118,7 +118,7 @@ You should now be able to access the Keycloak web interface, using the port spec
|
|||
|
||||
### 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.
|
||||
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'
|
||||
|
|
@ -189,8 +189,8 @@ If you are self-hosting Dashy, and require secure authentication to prevent unau
|
|||
- [Password Protection (for cloud providers)](#static-site-hosting-providers) - Enable password-protection on your site
|
||||
|
||||
### Authentication Server
|
||||
##### Authelia
|
||||
[Authelia](https://www.authelia.com/) is an open-source full-featured authentication server, which can be self-hosted and either on bare metal, in a Docker container or in a Kubernetes cluster. It allows for fine-grained access control rules based on IP, path, users etc, and supports 2FA, simple password access or bypass policies for your domains.
|
||||
##### Authelia
|
||||
[Authelia](https://www.authelia.com/) is an open-source full-featured authentication server, which can be self-hosted and either on bare metal, in a Docker container or in a Kubernetes cluster. It allows for fine-grained access control rules based on IP, path, users etc, and supports 2FA, simple password access or bypass policies for your domains.
|
||||
|
||||
- `git clone https://github.com/authelia/authelia.git`
|
||||
- `cd authelia/examples/compose/lite`
|
||||
|
|
@ -230,7 +230,7 @@ server {
|
|||
```
|
||||
|
||||
##### Caddy
|
||||
In Caddy, [Request Matchers](https://caddyserver.com/docs/caddyfile/matchers) can be used to filter requests
|
||||
In Caddy, [Request Matchers](https://caddyserver.com/docs/caddyfile/matchers) can be used to filter requests
|
||||
```
|
||||
dashy.site {
|
||||
@public_networks not remote_ip [your-ip]
|
||||
|
|
@ -244,9 +244,9 @@ Most web servers make password protecting certain apps very easy. Note that you
|
|||
##### Apache
|
||||
First crate a `.htaccess` file in Dashy's route directory. Specify the auth type and path to where you want to store the password file (usually the same folder). For example:
|
||||
```
|
||||
AuthType Basic
|
||||
AuthName "Please Sign into Dashy"
|
||||
AuthUserFile /path/dashy/.htpasswd
|
||||
AuthType Basic
|
||||
AuthName "Please Sign into Dashy"
|
||||
AuthUserFile /path/dashy/.htpasswd
|
||||
require valid-user
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ All data is encrypted before being sent to the backend. In Dashy, this is done i
|
|||
Once you've got Dashy configured to your preference, open the Backup & Restore menu (click the Cloud icon in the top-right corner). Here you will be prompted to choose a password, which will be used to encrypt your data. If you forget this password, there will be no way to recover your config. After clicking 'Backup' your data will be encrypted, compressed and sent to the hosted cloud service. A backup ID will be returned (in the format of xxxx-xxxx-xxxx-xxxx), this is what you use, along with your password to restore the backup on another system, so take note of it. To update a backup, return to this menu, enter your password, and click 'Update Backup'.
|
||||
|
||||
### Restoring a Backup
|
||||
To restore a backup, navigate to the Backup & Restore menu, and under restore, enter your backup ID, and the password you chose. Your config file will be downloaded, decrypted and applied to local storage.
|
||||
To restore a backup, navigate to the Backup & Restore menu, and under restore, enter your backup ID, and the password you chose. Your config file will be downloaded, decrypted and applied to local storage.
|
||||
|
||||
### Privacy & Security
|
||||
|
||||
|
|
|
|||
|
|
@ -219,7 +219,7 @@ For more info, see the **[Authentication Docs](/docs/authentication.md)**
|
|||
**`tags`** | `string[]` | _Optional_ | A list of tags, which can be used for improved search
|
||||
**`statusCheck`** | `boolean` | _Optional_ | When set to `true`, Dashy will ping the URL associated with the current service, and display its status as a dot next to the item. The value here will override `appConfig.statusCheck` so you can turn off or on checks for a given service. Defaults to `appConfig.statusCheck`, falls back to `false`
|
||||
**`statusCheckUrl`** | `string` | _Optional_ | If you've enabled `statusCheck`, and want to use a different URL to what is defined under the item, then specify it here
|
||||
**`statusCheckHeaders`** | `object` | _Optional_ | If you're endpoint requires any specific headers for the status checking, then define them here
|
||||
**`statusCheckHeaders`** | `object` | _Optional_ | If you're endpoint requires any specific headers for the status checking, then define them here
|
||||
**`statusCheckAllowInsecure`** | `boolean` | _Optional_ | By default, any request to insecure content will be blocked. Setting this option to `true` will disable the `rejectUnauthorized` option, enabling you to ping non-HTTPS services for the current item. Defaults to `false`
|
||||
**`statusCheckAcceptCodes`** | `string` | _Optional_ | If your service's response code is anything other than 2xx, then you can opt to specify an alternative success code. E.g. if you expect your server to return 403, but still want the status indicator to be green, set this value to `403`
|
||||
**`statusCheckMaxRedirects`** | `number` | _Optional_ | If your service redirects to another page, and you would like status checks to follow redirects, then specify the maximum number of redirects here. Defaults to `0` / will not follow redirects
|
||||
|
|
@ -254,7 +254,7 @@ For more info, see the **[Authentication Docs](/docs/authentication.md)**
|
|||
**`useProxy`** | `boolean` | _Optional_ | Some widgets make API requests to services that are not CORS-enabled. For these instances, you will need to route requests through a proxy, Dashy has a built in CORS-proxy, which you can use by setting this option to `true`. Defaults to `false`. See the [Proxying Requests Docs](/docs/widgets.md#proxying-requests) for more info
|
||||
**`timeout`** | `number` | _Optional_ | Request timeout in milliseconds, defaults to ½ a second (`500`)
|
||||
**`ignoreErrors`** | `boolean` | _Optional_ | Prevent an error message being displayed, if a network request or something else fails. Useful for false-positives
|
||||
**`label`** | `string` | _Optional_ | Add custom label to a given widget. Useful for identification, if there are multiple of the same type of widget in a single section
|
||||
**`label`** | `string` | _Optional_ | Add custom label to a given widget. Useful for identification, if there are multiple of the same type of widget in a single section
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
|
|
@ -325,7 +325,7 @@ If you're new to YAML, it's pretty straight-forward. The format is exactly the s
|
|||
### Config Saving Methods
|
||||
When updating the config through the JSON editor in the UI, you have two save options: **Local** or **Write to Disk**.
|
||||
- Changes saved locally will only be applied to the current user through the browser, and will not apply to other instances - you either need to use the cloud sync feature, or manually update the conf.yml file.
|
||||
- On the other-hand, if you choose to write changes to disk, then your main `conf.yml` file will be updated, and changes will be applied to all users, and visible across all devices. For this functionality to work, you must be running Dashy with using the Docker container, or the Node server. A backup of your current configuration will also be saved in the same directory.
|
||||
- On the other-hand, if you choose to write changes to disk, then your main `conf.yml` file will be updated, and changes will be applied to all users, and visible across all devices. For this functionality to work, you must be running Dashy with using the Docker container, or the Node server. A backup of your current configuration will also be saved in the same directory.
|
||||
|
||||
### Preventing Changes
|
||||
|
||||
|
|
@ -355,7 +355,7 @@ sections: # An array of sections
|
|||
- title: Demo
|
||||
description: A live demo
|
||||
icon: far fa-rocket
|
||||
url: https://dashy-demo-1.netlify.app
|
||||
url: https://dashy-demo-1.netlify.app
|
||||
- name: Section 2 - Local Services
|
||||
items:
|
||||
- title: Firewall
|
||||
|
|
@ -373,4 +373,3 @@ If you need any help, feel free to [Raise an Issue](https://github.com/Lissy93/d
|
|||
Happy Configuring 🤓🔧
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ Sponsoring will give you several perks - for $1 / £0.75 per month, you'll get a
|
|||
|
||||
## Enable Anonymous Bug Reports
|
||||
|
||||
Bug reports helps me to discover bugs I was unaware of, and then fix them, in order to make Dashy more reliable long term. This is a simple, yet really helpful step you can take to help improve Dashy. [Sentry](https://github.com/getsentry/sentry) is an open source error tracking and performance monitoring tool, which enables the identification any errors which occur in the production app (only if you enable it).
|
||||
Bug reports helps me to discover bugs I was unaware of, and then fix them, in order to make Dashy more reliable long term. This is a simple, yet really helpful step you can take to help improve Dashy. [Sentry](https://github.com/getsentry/sentry) is an open source error tracking and performance monitoring tool, which enables the identification any errors which occur in the production app (only if you enable it).
|
||||
|
||||
To enable error reporting:
|
||||
```yaml
|
||||
|
|
@ -122,4 +122,3 @@ For a full list of Dashy's contributors, see the [Credits Page](/docs/credits.md
|
|||
### Star-Gazers Over Time
|
||||
|
||||
[](https://seladb.github.io/StarTrack-js/#/preload?r=Lissy93,dashy)
|
||||
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ For all available options, and to learn more, see the [Docker Run Docs](https://
|
|||
|
||||
Dashy is also available through GHCR: `docker pull ghcr.io/lissy93/dashy:latest`
|
||||
|
||||
If you're deploying Dashy on a modern ARM-based board, such as a Raspberry Pi (2+), then you'll need to use one of Dashy's ARM images. Set the base image + tag to either `lissy93/dashy:arm64v8` or `lissy93/dashy:arm32v7`, depending on your system architecture. You can also use the `multi-arch` image, which should work on all system architectures.
|
||||
If you're deploying Dashy on a modern ARM-based board, such as a Raspberry Pi (2+), then you'll need to use one of Dashy's ARM images. Set the base image + tag to either `lissy93/dashy:arm64v8` or `lissy93/dashy:arm32v7`, depending on your system architecture. You can also use the `multi-arch` image, which should work on all system architectures.
|
||||
|
||||
The image defaults to `:latest`, but you can instead specify a specific version, e.g. `docker pull lissy93/dashy:release-1.5.0`
|
||||
|
||||
|
|
@ -128,11 +128,11 @@ Installing dashy is really simply and fast:
|
|||
2. Go to ```File Station``` and open the ```docker``` folder. Inside the docker folder, create one new folder and name it ```dashy```.
|
||||
> Note: Be careful to enter only lowercase, not uppercase letters.
|
||||
3. Go to Control Panel / Task Scheduler / Create / Scheduled Task / User-defined script.
|
||||
4. Once you click on ```User-defined``` script a new window will open.
|
||||
4. Once you click on ```User-defined``` script a new window will open.
|
||||
5. Follow the instructions below:
|
||||
6. General: In the Task field type in Install dashy. Uncheck “Enabled” option. Select root User.
|
||||
7. Schedule: Select Run on the following date then select “Do not repeat“.
|
||||
8. Task Settings: Check “Send run details by email“, add your email then copy paste the code below in the Run command area. After that click OK.
|
||||
6. General: In the Task field type in Install dashy. Uncheck "Enabled" option. Select root User.
|
||||
7. Schedule: Select Run on the following date then select "Do not repeat".
|
||||
8. Task Settings: Check "Send run details by email", add your email then copy paste the code below in the Run command area. After that click OK.
|
||||
|
||||
```
|
||||
docker run -d \
|
||||
|
|
@ -247,7 +247,7 @@ https://render.com/deploy?repo=https://github.com/lissy93/dashy/tree/deploy_rend
|
|||
#### Scalingo
|
||||
[](https://my.scalingo.com/deploy?source=https://github.com/lissy93/dashy#master)
|
||||
|
||||
[Scalingo](https://scalingo.com/) is a scalable container-based cloud platform as a service. It's focus is on compliance and uptime, and is geared towards enterprise users. Scalingo is also not free, although they do have a 3-day free trial that does not require a payment method
|
||||
[Scalingo](https://scalingo.com/) is a scalable container-based cloud platform as a service. It's focus is on compliance and uptime, and is geared towards enterprise users. Scalingo is also not free, although they do have a 3-day free trial that does not require a payment method.
|
||||
|
||||
To deploy Dashy to Scalingo, use the following link
|
||||
```
|
||||
|
|
@ -295,13 +295,13 @@ However without Dashy's node server, there are a couple of features that will be
|
|||
Dashy works well on a Raspberry Pi (tested on Pi 3 and later), but should also run well on any system.
|
||||
|
||||
### Docker
|
||||
Initial app build causes a spike in resource usage, but once the built app is running it is fairly steady. For this reason, Dashy works best with a minimum of 1GB of memory, and 1GB of disk space.
|
||||
Initial app build causes a spike in resource usage, but once the built app is running it is fairly steady. For this reason, Dashy works best with a minimum of 1GB of memory, and 1GB of disk space.
|
||||
|
||||
### Bare Metal
|
||||
Minimum 526mb mem, 2GB disk space,
|
||||
Minimum 526mb mem, 2GB disk space.
|
||||
|
||||
### CDN / Cloud Deploy
|
||||
No specific requirements. The built application alone (without the Node server) is very light-weight, and can be handled smoothly by pretty much any CDN or cloud deployment service (see [this list](/docs/deployment.md#deploy-to-cloud-service) or natively supported cloud providers).
|
||||
No specific requirements. The built application alone (without the Node server) is very light-weight, and can be handled smoothly by pretty much any CDN or cloud deployment service (see [this list](/docs/deployment.md#deploy-to-cloud-service) or natively supported cloud providers).
|
||||
|
||||
If you're using your own icons, or other assets, additional disk space will be required for those resources.
|
||||
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ Dashy should now be being served on http://localhost:8080/. Hot reload is enable
|
|||
#### Notes
|
||||
- If you are using NPM, replace `yarn` with `npm run`
|
||||
- If you are using Docker, precede each command with `docker exec -it [container-id]`. Container ID can be found by running `docker ps`
|
||||
- You can manage the app using the [Vue-CLI Service](https://cli.vuejs.org/guide/cli-service.html), with `npx vue-cli-service [command]`. Or to start the Vue Management UI, run `npx vue ui`, and open `http://localhost:8000`
|
||||
- You can manage the app using the [Vue-CLI Service](https://cli.vuejs.org/guide/cli-service.html), with `npx vue-cli-service [command]`. Or to start the Vue Management UI, run `npx vue ui`, and open `http://localhost:8000`
|
||||
|
||||
### Environmental Variables
|
||||
All environmental variables are optional. Currently there are not many environmental variables used, as most of the user preferences are stored under `appConfig` in the `conf.yml` file.
|
||||
|
|
@ -158,7 +158,7 @@ New to Web Development? Glad you're here! Dashy is a pretty simple app, so it sh
|
|||
- [Git cheat sheet](http://git-cheatsheet.com/)
|
||||
- [Basics of using NPM](https://www.freecodecamp.org/news/what-is-npm-a-node-package-manager-tutorial-for-beginners/)
|
||||
|
||||
As well as Node, Git and Docker- you'll also need an IDE (e.g. [VS Code](https://code.visualstudio.com/) or [Vim](https://www.vim.org/)) and a terminal (Windows users may find [WSL](https://docs.microsoft.com/en-us/windows/wsl/) more convenient).
|
||||
As well as Node, Git and Docker- you'll also need an IDE (e.g. [VS Code](https://code.visualstudio.com/) or [Vim](https://www.vim.org/)) and a terminal (Windows users may find [WSL](https://docs.microsoft.com/en-us/windows/wsl/) more convenient).
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -175,13 +175,13 @@ The most significant things to note are:
|
|||
- The final element in all objects must be preceded with a comma
|
||||
- Maximum line length is 100
|
||||
- There must be exactly one blank line between sections, before function names, and at the end of the file
|
||||
- With conditionals, put else on the same line as your if block’s closing brace
|
||||
- With conditionals, put else on the same line as your if block's closing brace
|
||||
- All multiline blocks must use braces
|
||||
- Avoid console statements in the frontend
|
||||
|
||||
Styleguides:
|
||||
- Vue: [Vue styleguide](https://vuejs.org/v2/style-guide/)
|
||||
- JavaScript: [github.com/airbnb/javascript](https://github.com/airbnb/javascript)
|
||||
- JavaScript: [github.com/airbnb/javascript](https://github.com/airbnb/javascript)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -213,7 +213,7 @@ Styleguides:
|
|||
├── assets # Static non-compiled assets
|
||||
│ ├── fonts # .ttf font files
|
||||
│ ├── locales # All app text, each language in a separate JSON file
|
||||
│ ╰── interface-icons # SVG icons used in the app
|
||||
│ ╰── interface-icons # SVG icons used in the app
|
||||
├── components # All front-end Vue web components
|
||||
│ ├── Charts # Charting components for dynamically displaying widget data
|
||||
│ │ ├── Gauge.vue # A speed-dial style chart for showing 0 - 100 values
|
||||
|
|
@ -250,7 +250,7 @@ Styleguides:
|
|||
│ │ ├── Item.vue # Main link item, which is displayed within an item group
|
||||
│ │ ├── ItemGroup.vue # Item group is a section containing icons
|
||||
│ │ ├── ItemIcon.vue # The icon used by both items and sections
|
||||
│ │ ├── ItemOpenMethodIcon.vue # A small icon, visible on hover, indicating opening method
|
||||
│ │ ├── ItemOpenMethodIcon.vue # A small icon, visible on hover, indicating opening method
|
||||
│ │ ├── ItemContextMenu.vue # The right-click menu, for showing Item opening methods and info
|
||||
│ │ ├── SectionContextMenu.vue # The right-click menu, for showing Section edit/ open options
|
||||
│ │ ╰── StatusIndicator.vue # Traffic light dot, showing if app is online or down
|
||||
|
|
@ -356,4 +356,3 @@ When running the build command, several warnings appear. These are not errors, a
|
|||
`WARN A new version of sass-loader is available. Please upgrade for best experience.` - Currently we're using an older version of SASS loader, since the more recent releases do not seem to be compatible with the Vue CLI's webpack configuration.
|
||||
|
||||
`WARN asset size limit: The following asset(s) exceed the recommended size limit (244 KiB).` - For the PWA to support Windows 10, a splash screen asset is required, and is quite large. This throws a warning, however PWA assets are not loaded until needed, so shouldn't have any impact on application performance. A similar warning is thrown for the Raleway font, and that is looking to be addressed.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Development Guides
|
||||
|
||||
A series of short tutorials, to guide you through the most common development tasks.
|
||||
A series of short tutorials, to guide you through the most common development tasks.
|
||||
|
||||
Sections:
|
||||
- [Creating a new theme](#creating-a-new-theme)
|
||||
|
|
@ -18,10 +18,10 @@ Sections:
|
|||
Adding a new theme is really easy. There's two things you need to do: Pass the theme name to Dashy, so that it can be added to the theme selector dropdown menu, and then write some styles!
|
||||
|
||||
##### 1. Add Theme Name
|
||||
Choose a snappy name for you're theme, and add it to the `builtInThemes` array inside [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js#L27).
|
||||
Choose a snappy name for you're theme, and add it to the `builtInThemes` array inside [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js#L27).
|
||||
|
||||
##### 2. Write some Styles!
|
||||
Put your theme's styles inside [`color-themes.scss`](https://github.com/Lissy93/dashy/blob/master/src/styles/color-themes.scss).
|
||||
Put your theme's styles inside [`color-themes.scss`](https://github.com/Lissy93/dashy/blob/master/src/styles/color-themes.scss).
|
||||
Create a new block, and make sure that `data-theme` matches the theme name you chose above. For example:
|
||||
|
||||
```css
|
||||
|
|
@ -91,7 +91,7 @@ export const languages = [
|
|||
```
|
||||
You can also add your new language to the readme, under the [Language Switching](https://github.com/Lissy93/dashy#language-switching-) section, and optionally include your name/ username if you'd like to be credited for your work. Done!
|
||||
|
||||
If you are not comfortable with making pull requests, or do not want to modify the code, then feel free to instead send the translated file to me, and I can add it into the application. I will be sure to credit you appropriately.
|
||||
If you are not comfortable with making pull requests, or do not want to modify the code, then feel free to instead send the translated file to me, and I can add it into the application. I will be sure to credit you appropriately.
|
||||
|
||||
# Adding a new option in the config file
|
||||
|
||||
|
|
@ -144,7 +144,7 @@ or
|
|||
Finally, add your new property to the [`configuring.md`](./configuring.md) API docs. Put it under the relevant section, and be sure to include field name, data type, a description and mention that it is optional. If your new feature needs more explaining, then you can also document it under the relevant section elsewhere in the documentation.
|
||||
|
||||
Checklist:
|
||||
- [ ] Ensure the new attribute is actually necessary, and nothing similar already exists
|
||||
- [ ] 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
|
||||
- [ ] 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
|
||||
|
|
@ -219,7 +219,7 @@ export default {
|
|||
},
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
Finally, in the markup of your component, just add a `v-if` statement, referencing your computed value
|
||||
```vue
|
||||
<header v-if="isVisible">
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ Font-Awesome has a wide variety of free icons, but you can also use their pro ic
|
|||
---
|
||||
|
||||
## Simple Icons
|
||||
[SimpleIcons.org](https://simpleicons.org/) is a collection of 2000+ high quality, free and open source brand and logo SVG icons. Usage of which is very similar to font-awesome icons. First find the glyph you want to use on the [website](https://simpleicons.org/), then just set your icon the the simple icon slug, prefixed with `si-`.
|
||||
[SimpleIcons.org](https://simpleicons.org/) is a collection of 2000+ high quality, free and open source brand and logo SVG icons. Usage of which is very similar to font-awesome icons. First find the glyph you want to use on the [website](https://simpleicons.org/), then just set your icon the the simple icon slug, prefixed with `si-`.
|
||||
|
||||
<p align="center">
|
||||
<img width="580" src="https://i.ibb.co/MVhkXfC/simple-icons-example.png" />
|
||||
|
|
@ -136,11 +136,11 @@ sections:
|
|||
- name: Material Design Icons Example
|
||||
items:
|
||||
- title: Alien Icon
|
||||
icon: mdi-alien
|
||||
icon: mdi-alien
|
||||
- title: Fire Icon
|
||||
icon: mdi-fire
|
||||
icon: mdi-fire
|
||||
- title: Dino Icon
|
||||
icon: mdi-google-downasaur
|
||||
icon: mdi-google-downasaur
|
||||
```
|
||||
|
||||
<p align="center">
|
||||
|
|
|
|||
|
|
@ -143,7 +143,7 @@ You can make a backup of any running container really easily, using [`docker com
|
|||
Note that this will not include any data in docker volumes, and the process here is a bit different. Since these files exist on your host system, if you have an existing backup solution implemented, you can incorporate and volume files within that system.
|
||||
|
||||
### Backing Up Volumes
|
||||
[offen/docker-volume-backup](https://github.com/offen/docker-volume-backup) is a useful tool for periodic Docker volume backups, to any S3-compatible storage provider. It's run as a light-weight Docker container, and is easy to setup, and also supports GPG-encryption, email notification, and routing away older backups.
|
||||
[offen/docker-volume-backup](https://github.com/offen/docker-volume-backup) is a useful tool for periodic Docker volume backups, to any S3-compatible storage provider. It's run as a light-weight Docker container, and is easy to setup, and also supports GPG-encryption, email notification, and routing away older backups.
|
||||
|
||||
To get started, create a docker-compose similar to the example below, and then start the container. For more info, check out their [documentation](https://github.com/offen/docker-volume-backup), which is very clear.
|
||||
|
||||
|
|
@ -201,7 +201,7 @@ Enabling HTTPS with an SSL certificate is recommended, especially if you are hos
|
|||
### Auto-SSL
|
||||
If you are using [NGINX Proxy Manager](https://nginxproxymanager.com/), then SSL is supported out of the box. Once you've added your proxy host and web address, then set the scheme to HTTPS, then under the SSL Tab select "Request a new SSL certificate" and follow the on-screen instructions.
|
||||
|
||||
If you're hosting Dashy behind Cloudflare, then they offer [free and easy SSL](https://www.cloudflare.com/en-gb/learning/ssl/what-is-an-ssl-certificate/)- all you need to do is enable it under the SSL/TLS tab. Or if you are using shared hosting, you may find [this tutorial](https://www.sitepoint.com/a-guide-to-setting-up-lets-encrypt-ssl-on-shared-hosting/) helpful.
|
||||
If you're hosting Dashy behind Cloudflare, then they offer [free and easy SSL](https://www.cloudflare.com/en-gb/learning/ssl/what-is-an-ssl-certificate/)- all you need to do is enable it under the SSL/TLS tab. Or if you are using shared hosting, you may find [this tutorial](https://www.sitepoint.com/a-guide-to-setting-up-lets-encrypt-ssl-on-shared-hosting/) helpful.
|
||||
|
||||
### Getting a Self-Signed SSL Certificate
|
||||
[Let's Encrypt](https://letsencrypt.org/docs/) is a global Certificate Authority, providing free SSL/TLS Domain Validation certificates in order to enable secure HTTPS access to your website. They have good browser/ OS [compatibility](https://letsencrypt.org/docs/certificate-compatibility/) with their ISRG X1 and DST CA X3 root certificates, support [Wildcard issuance](https://community.letsencrypt.org/t/acme-v2-production-environment-wildcards/55578) done via ACMEv2 using the DNS-01 and have [Multi-Perspective Validation](https://letsencrypt.org/2020/02/19/multi-perspective-validation.html). Let's Encrypt provide [CertBot](https://certbot.eff.org/) an easy app for generating and setting up an SSL certificate.
|
||||
|
|
@ -325,7 +325,7 @@ headers / {
|
|||
|
||||
```
|
||||
location / {
|
||||
add_header Access-Control-Allow-Origin *;
|
||||
add_header Access-Control-Allow-Origin *;
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -380,7 +380,7 @@ request_header_access Authorization allow all
|
|||
|
||||
### WireGuard
|
||||
|
||||
Using a VPN is one of the easiest ways to provide secure, full access to your local network from remote locations. [WireGuard](https://www.wireguard.com/) is a reasonably new open source VPN protocol, that was designed with ease of use, performance and security in mind. Unlike OpenVPN, it doesn't need to recreate the tunnel whenever connection is dropped, and it's also much easier to setup, using shared keys instead.
|
||||
Using a VPN is one of the easiest ways to provide secure, full access to your local network from remote locations. [WireGuard](https://www.wireguard.com/) is a reasonably new open source VPN protocol, that was designed with ease of use, performance and security in mind. Unlike OpenVPN, it doesn't need to recreate the tunnel whenever connection is dropped, and it's also much easier to setup, using shared keys instead.
|
||||
|
||||
- **Install Wireguard** - See the [Install Docs](https://www.wireguard.com/install/) for download links + instructions
|
||||
- On Debian-based systems, it's `sudo apt install wireguard`
|
||||
|
|
@ -457,7 +457,7 @@ A useful tool for getting WG setup is [Algo](https://github.com/trailofbits/algo
|
|||
|
||||
SSH (or [Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell)) is a secure tunnel that allows you to connect to a remote host. Unlike the VPN methods, an SSH connection does not require an intermediary, and will not be affected by your IP changing. However it only allows you to access a single service at a time. SSH was really designed for terminal access, but because of the latter mentioned benefits it's useful to setup, as a fallback option.
|
||||
|
||||
Directly SSH'ing into your home, would require you to open a port (usually 22), which would be terrible for security, and is not recommended. However a reverse SSH connection is initiated from inside your network. Once the connection is established, the port is redirected, allowing you to use the established connection to SSH into your home network.
|
||||
Directly SSH'ing into your home, would require you to open a port (usually 22), which would be terrible for security, and is not recommended. However a reverse SSH connection is initiated from inside your network. Once the connection is established, the port is redirected, allowing you to use the established connection to SSH into your home network.
|
||||
|
||||
The issue you've probably spotted, is that most public, corporate, and institutional networks will block SSH connections. To overcome this, you'd have to establish a server outside of your homelab that your homelab's device could SSH into to establish the reverse SSH connection. You can then connect to that remote server (the _mothership_), which in turn connects to your home network.
|
||||
|
||||
|
|
@ -482,13 +482,13 @@ Done :)
|
|||
|
||||
### TCP Tunnel
|
||||
|
||||
If you're running Dashy on your local network, behind a firewall, but need to temporarily share it with someone external, this can be achieved quickly and securely using [Ngrok](https://ngrok.com/). It’s basically a super slick, encrypted TCP tunnel that provides an internet-accessible address that anyone use to access your local service, from anywhere.
|
||||
If you're running Dashy on your local network, behind a firewall, but need to temporarily share it with someone external, this can be achieved quickly and securely using [Ngrok](https://ngrok.com/). It's basically a super slick, encrypted TCP tunnel that provides an internet-accessible address that anyone use to access your local service, from anywhere.
|
||||
|
||||
To get started, [Download](https://ngrok.com/download) and install Ngrok for your system, then just run `ngrok http [port]` (replace the port with the http port where Dashy is running, e.g. 8080). When [using https](https://ngrok.com/docs#http-local-https), specify the full local url/ ip including the protocol.
|
||||
|
||||
Some Ngrok features require you to be authenticated, you can [create a free account](https://dashboard.ngrok.com/signup) and generate a token in [your dashboard](https://dashboard.ngrok.com/auth/your-authtoken), then run `ngrok authtoken [token]`.
|
||||
Some Ngrok features require you to be authenticated, you can [create a free account](https://dashboard.ngrok.com/signup) and generate a token in [your dashboard](https://dashboard.ngrok.com/auth/your-authtoken), then run `ngrok authtoken [token]`.
|
||||
|
||||
It's recommended to use authentication for any publicly accessible service. Dashy has an [Auth](/docs/authentication.md) feature built in, but an even easier method it to use the [`-auth`](https://ngrok.com/docs#http-auth) switch. E.g. `ngrok http -auth=”username:password123” 8080`
|
||||
It's recommended to use authentication for any publicly accessible service. Dashy has an [Auth](/docs/authentication.md) feature built in, but an even easier method it to use the [`-auth`](https://ngrok.com/docs#http-auth) switch. E.g. `ngrok http -auth="username:password123" 8080`
|
||||
|
||||
By default, your web app is assigned a randomly generated ngrok domain, but you can also use your own custom domain. Under the [Domains Tab](https://dashboard.ngrok.com/endpoints/domains) of your Ngrok dashboard, add your domain, and follow the CNAME instructions. You can now use your domain, with the [`-hostname`](https://ngrok.com/docs#http-custom-domains) switch, e.g. `ngrok http -region=us -hostname=dashy.example.com 8080`. If you don't have your own domain name, you can instead use a custom sub-domain (e.g. `alicia-dashy.ngrok.io`), using the [`-subdomain`](https://ngrok.com/docs#custom-subdomain-names) switch.
|
||||
|
||||
|
|
@ -512,7 +512,7 @@ For locally running services, a domain can be set up directly in the DNS records
|
|||
|
||||
If you're using Pi-Hole, a similar thing can be done in the `/etc/dnsmasq.d/03-custom-dns.conf` file, add a line like: `address=/dashy.example.com/192.168.2.0` for each of your services.
|
||||
|
||||
If you're running OPNSense/ PfSense, then this can be done through the UI with Unbound, it's explained nicely in [this article](https://homenetworkguy.com/how-to/use-custom-domain-name-in-internal-network/), by Dustin Casto.
|
||||
If you're running OPNSense/ PfSense, then this can be done through the UI with Unbound, it's explained nicely in [this article](https://homenetworkguy.com/how-to/use-custom-domain-name-in-internal-network/), by Dustin Casto.
|
||||
|
||||
### Using NGINX
|
||||
If you're using NGINX, then you can use your own domain name, with a config similar to the below example.
|
||||
|
|
@ -592,7 +592,7 @@ Running a container with admin privileges gives it more power than it needs, and
|
|||
Note that if you're facing permission issues on Debian-based systems, you may need to add your user to the Docker group. First create the group: `sudo groupadd docker`, then add your (non-root) user: `sudo usermod −aG docker [my-username]`, finally `newgrp docker` to refresh.
|
||||
|
||||
### Specify a User
|
||||
One of the best ways to prevent privilege escalation attacks, is to configure the container to use an unprivileged user. This also means that any files created by the container and mounted, will be owned by the specified user (and not root), which makes things much easier.
|
||||
One of the best ways to prevent privilege escalation attacks, is to configure the container to use an unprivileged user. This also means that any files created by the container and mounted, will be owned by the specified user (and not root), which makes things much easier.
|
||||
|
||||
You can specify a user, using the [`--user` param](https://docs.docker.com/engine/reference/run/#user), and should include the user ID (`UID`), which can be found by running `id -u`, and the and the group ID (`GID`), using `id -g`.
|
||||
|
||||
|
|
@ -608,11 +608,11 @@ services:
|
|||
image: lissy93/dashy
|
||||
user: ${CURRENT_UID}
|
||||
ports: [ 4000:80 ]
|
||||
```
|
||||
```
|
||||
|
||||
And then to set the variable, and start the container, run: `CURRENT_UID=$(id -u):$(id -g) docker-compose up`
|
||||
|
||||
### Limit capabilities
|
||||
### Limit capabilities
|
||||
Docker containers run with a subset of [Linux Kernal's Capabilities](https://man7.org/linux/man-pages/man7/capabilities.7.html) by default. It's good practice to drop privilege permissions that are not needed for any given container.
|
||||
|
||||
With Docker run, you can use the `--cap-drop` flag to remove capabilities, you can also use `--cap-drop=all` and then define just the required permissions using the `--cap-add` option. For a list of available capabilities, see the [Privilege Capabilities Docs](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities).
|
||||
|
|
@ -635,7 +635,7 @@ services:
|
|||
- SETUID
|
||||
- DAC_OVERRIDE
|
||||
- NET_BIND_SERVICE
|
||||
```
|
||||
```
|
||||
|
||||
### Prevent new Privilages being Added
|
||||
To prevent processes inside the container from getting additional privileges, pass in the `--security-opt=no-new-privileges:true` option to the Docker run command (see [docs](https://docs.docker.com/engine/reference/run/#security-configuration)).
|
||||
|
|
@ -675,7 +675,7 @@ You can also prevent a container from writing any changes to volumes on your hos
|
|||
Logging is important, as it enables you to review events in the future, and in the case of a compromise this will let get an idea of what may have happened. The default log level is `INFO`, and this is also the recommendation, use `--log-level info` to ensure this is set.
|
||||
|
||||
### Verify Image before Pulling
|
||||
Only use trusted images, from verified/ official sources. If an app is open source, it is more likely to be safe, as anyone can verify the code. There are also tools available for scanning containers,
|
||||
Only use trusted images, from verified/ official sources. If an app is open source, it is more likely to be safe, as anyone can verify the code. There are also tools available for scanning containers,
|
||||
|
||||
Unless otherwise configured, containers can communicate among each other, so running one bad image may lead to other areas of your setup being compromised. Docker images typically contain both original code, as well as up-stream packages, and even if that image has come from a trusted source, the up-stream packages it includes may not have.
|
||||
|
||||
|
|
@ -697,7 +697,7 @@ Docker supports several modules that let you write your own security profiles.
|
|||
|
||||
[AppArmor](https://www.apparmor.net/)is a kernel module that proactively protects the operating system and applications from external or internal threats, by enabling you to restrict programs' capabilities with per-program profiles. You can specify either a security policy by name, or by file path with the `apparmor` flag in docker run. Learn more about writing profiles, [here](https://gitlab.com/apparmor/apparmor/-/wikis/QuickProfileLanguage).
|
||||
|
||||
[Seccomp](https://en.wikipedia.org/wiki/Seccomp) (Secure Computing Mode) is a sandboxing facility in the Linux kernel that acts like a firewall for system calls (syscalls). It uses Berkeley Packet Filter (BPF) rules to filter syscalls and control how they are handled. These filters can significantly limit a containers access to the Docker Host’s Linux kernel - especially for simple containers/applications. It requires a Linux-based Docker host, with secomp enabled, and you can check for this by running `docker info | grep seccomp`. A great resource for learning more about this is [DockerLabs](https://training.play-with-docker.com/security-seccomp/).
|
||||
[Seccomp](https://en.wikipedia.org/wiki/Seccomp) (Secure Computing Mode) is a sandboxing facility in the Linux kernel that acts like a firewall for system calls (syscalls). It uses Berkeley Packet Filter (BPF) rules to filter syscalls and control how they are handled. These filters can significantly limit a containers access to the Docker Host's Linux kernel - especially for simple containers/applications. It requires a Linux-based Docker host, with secomp enabled, and you can check for this by running `docker info | grep seccomp`. A great resource for learning more about this is [DockerLabs](https://training.play-with-docker.com/security-seccomp/).
|
||||
|
||||
|
||||
**[⬆️ Back to Top](#management)**
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ Dashy is using [vue-i18n](https://vue-i18n.intlify.dev/guide/) to manage multi-l
|
|||
Adding a new language is pretty straightforward, with just three steps:
|
||||
|
||||
##### 1. Create a new Language File
|
||||
Create a new JSON file in `./src/assets/locales` for your language.
|
||||
Create a new JSON file in `./src/assets/locales` for your language.
|
||||
|
||||
You should name it with the 2-digit [ISO-639 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for your locale (e.g. for German `de.json`, French `fr.json` or Spanish `es.json`) - You can find a list of all ISO codes at [iso.org](https://www.iso.org/obp/ui).
|
||||
If your language is a specific dialect or regional translation, then use the Posfix [CLDR](http://cldr.unicode.org/) format, where, e.g. `en-GB.json` (British English), `es-MX.json` (Spanish, in Mexico) or `zh-CN.json` (Chinese, simplified) - A list of which can be found [here](https://github.com/unicode-org/cldr-json/blob/master/cldr-json/cldr-core/availableLocales.json)
|
||||
|
|
@ -84,7 +84,7 @@ export const languages = [
|
|||
```
|
||||
You can also add your new language to the readme, under the [Language Switching](https://github.com/Lissy93/dashy#language-switching-) section and optionally include your name/ username if you'd like to be credited for your work. Done!
|
||||
|
||||
If you are not comfortable with making pull requests, or do not want to modify the code, then feel free to instead send the translated file to me, and I can add it into the application. I will be sure to credit you appropriately.
|
||||
If you are not comfortable with making pull requests, or do not want to modify the code, then feel free to instead send the translated file to me, and I can add it into the application. I will be sure to credit you appropriately.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
You can have additional pages within your dashboard, with each having it's own config file. The config files for sub-pages can either be stored locally, or hosted separately. A link to each additional page will be displayed in the navigation bar.
|
||||
|
||||
You can edit additional pages using the interactive editor, exactly the same was as your primary page (so long as it's local). But please save changes to one page, before you start editing the next.
|
||||
You can edit additional pages using the interactive editor, exactly the same was as your primary page (so long as it's local). But please save changes to one page, before you start editing the next.
|
||||
|
||||
### Using Local Sub-Pages
|
||||
|
||||
|
|
|
|||
|
|
@ -83,7 +83,7 @@ Dashy has a primitive [web search feature](https://github.com/Lissy93/dashy/blob
|
|||
This feature can be disabled under appConfig, with `webSearch: { disableWebSearch: 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 code isn't even 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, used to identify any issues 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 code isn't even 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, 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/).
|
||||
|
||||
|
|
@ -164,7 +164,7 @@ The following section outlines all data that is stored in the browsers, as cooki
|
|||
#### Cookies
|
||||
> [Cookies](https://en.wikipedia.org/wiki/HTTP_cookie) will expire after their pre-defined lifetime
|
||||
|
||||
- `AUTH_TOKEN` - A unique token, generated from a hash of users credentials, to verify they are authenticated. Only used when auth is enabled
|
||||
- `AUTH_TOKEN` - A unique token, generated from a hash of users credentials, to verify they are authenticated. Only used when auth is enabled.
|
||||
|
||||
#### Session Storage
|
||||
> [Session storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage) is deleted when the current session ends (tab / window is closed)
|
||||
|
|
@ -229,7 +229,7 @@ This is covered in more detail in [App Management](/docs/management.md).
|
|||
## Security Features
|
||||
|
||||
#### Subresource Integrity
|
||||
[Subresource Integrity](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) or SRI is a security feature that enables browsers to verify that resources they fetch are delivered without unexpected manipulation. It works by allowing you to provide a cryptographic hash that a fetched resource must match. This prevents the app from loading any resources that have been manipulated, by verifying the files hashes. It safeguards against the risk of an attacker injecting arbitrary malicious content into any files served up via a CDN.
|
||||
[Subresource Integrity](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) or SRI is a security feature that enables browsers to verify that resources they fetch are delivered without unexpected manipulation. It works by allowing you to provide a cryptographic hash that a fetched resource must match. This prevents the app from loading any resources that have been manipulated, by verifying the files hashes. It safeguards against the risk of an attacker injecting arbitrary malicious content into any files served up via a CDN.
|
||||
|
||||
Dashy supports SRI, and it is recommended to enable this if you are hosting your dashboard via a public CDN. To enable SRI, set the `INTEGRITY` environmental variable to `true`.
|
||||
|
||||
|
|
|
|||
|
|
@ -101,7 +101,7 @@ If you need any help or support in getting Dashy running, head over to the [Disc
|
|||
|
||||
If you're enjoying Dashy, and have a few minutes to spare, please do take a moment to look at the [Contributing Page](https://github.com/Lissy93/dashy/blob/master/docs/contributing.md). Huge thanks to [everyone](https://github.com/Lissy93/dashy/blob/master/docs/credits.md) who has already helped out!
|
||||
|
||||
Enjoy your dashboard :)
|
||||
Enjoy your dashboard :)
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
- [App Management](/docs/management.md) - Managing your app, updating, security, web server configuration, etc
|
||||
- [Troubleshooting](/docs/troubleshooting.md) - Common errors and problems, and how to fix them
|
||||
|
||||
### Development and Contributing
|
||||
### Development and Contributing
|
||||
- [Developing](/docs/developing.md) - Running Dashy development server locally, and general workflow
|
||||
- [Development Guides](/docs/development-guides.md) - Common development tasks, to help new contributors
|
||||
- [Contributing](/docs/contributing.md) - How you can help keep Dashy alive
|
||||
|
|
|
|||
|
|
@ -104,7 +104,7 @@ When you submit your PR, include the required info, by filling out the PR templa
|
|||
|
||||
## Automated Workflows
|
||||
|
||||
Dashy makes heavy use of [GitHub Actions](https://github.com/features/actions) to fully automate the checking, testing, building, deploying of the project, as well as administration tasks like management of issues, tags, releases and documentation. The following section outlines each workflow, along with a link the the action file, current status and short description. A lot of these automations were made possible using community actions contributed to GH marketplace by some amazing people.
|
||||
Dashy makes heavy use of [GitHub Actions](https://github.com/features/actions) to fully automate the checking, testing, building, deploying of the project, as well as administration tasks like management of issues, tags, releases and documentation. The following section outlines each workflow, along with a link the the action file, current status and short description. A lot of these automations were made possible using community actions contributed to GH marketplace by some amazing people.
|
||||
|
||||
|
||||
### Code Processing
|
||||
|
|
@ -155,4 +155,4 @@ Action | Description
|
|||
**Generate Credits** <br/>[](https://github.com/Lissy93/dashy/actions/workflows/generate-credits.yml) | Generates a report, including contributors, collaborators, sponsors, bots and helpful users. Will then insert a markdown table with thanks to these GitHub users and links to their profiles into the Credits page, as well as a summary of sponsors and top contributors into the main readme
|
||||
**Wiki Sync** <br/>[](https://github.com/Lissy93/dashy/actions/workflows/wiki-sync.yml) | Generates and publishes the repositories wiki page using the markdown files within the docs directory
|
||||
|
||||
---
|
||||
---
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ You can navigate through your items or search results using the keyboard. You ca
|
|||
You can launch a elected app by hitting <kbd>Enter</kbd>. This will open the app using your default opening method, specified in `target` (either `newtab`, `sametab`, `modal`, `top` or `workspace`). You can also use <kbd>Alt</kbd> + <kbd>Enter</kbd> to open the app in a pop-up modal, or <kbd>Ctrl</kbd> + <kbd>Enter</kbd> to open it in a new tab. For all available opening methods, just right-click on an item, to bring up the context menu.
|
||||
|
||||
## Tags
|
||||
By default, items are filtered by the `title` attribute, as well as the hostname (extracted from `url`), the `provider` and `description`. If you need to find results based on text which isn't included in these attributes, then you can add `tags` to a given item.
|
||||
By default, items are filtered by the `title` attribute, as well as the hostname (extracted from `url`), the `provider` and `description`. If you need to find results based on text which isn't included in these attributes, then you can add `tags` to a given item.
|
||||
|
||||
```yaml
|
||||
items:
|
||||
|
|
@ -59,7 +59,7 @@ Set your default search engine using the `webSearch.searchEngine` property. This
|
|||
### Using Custom Search Engine
|
||||
You can also use a custom search engine, that isn't included in the above list (like a self-hosted instance of [Whoogle](https://github.com/benbusby/whoogle-search) or [Searx](https://searx.github.io/searx/)). Set `searchEngine: custom`, and then specify the URL (plus query params) to you're search engine under `customSearchEngine`.
|
||||
|
||||
For example:
|
||||
For example:
|
||||
```yaml
|
||||
appConfig:
|
||||
webSearch:
|
||||
|
|
@ -73,7 +73,7 @@ In a similar way to opening apps, you can specify where you would like search re
|
|||
### Using Bangs
|
||||
An insanely useful feature of DDG is [Bangs](https://duckduckgo.com/bang), where you type a specific character combination at the start of your search query, and it will be redirected the that website, such as '!w Docker' will display the Docker wikipedia page. Dashy has a similar feature, enabling you to define your own custom bangs to redirect search results to a specific app, website or search engine.
|
||||
|
||||
This is done under the `searchBangs` property, with a list of key value pairs. The key is what you will type, and the value is the destination, either as an identifier or a URL with query parameters.
|
||||
This is done under the `searchBangs` property, with a list of key value pairs. The key is what you will type, and the value is the destination, either as an identifier or a URL with query parameters.
|
||||
|
||||
For example:
|
||||
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@
|
|||
### The Dragons Lair
|
||||
> By [dr460nf1r3](https://github.com/dr460nf1r3) <sup>via [#684](https://github.com/Lissy93/dashy/issues/684)</sup>
|
||||
|
||||
> My new startpage featuring the stuff I use most. And of course dragons!
|
||||
> My new startpage featuring the stuff I use most. And of course dragons!
|
||||
|
||||
|
||||
|
||||
|
|
@ -178,8 +178,8 @@
|
|||
|
||||
---
|
||||
|
||||
### Crypto Dash
|
||||
> Example usage of widgets to monitor cryptocurrencies news, prices and data. Config is [available here](https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10#file-example-8-dashy-crypto-widgets-conf-yml)
|
||||
### Crypto Dash
|
||||
> Example usage of widgets to monitor cryptocurrencies news, prices and data. Config is [available here](https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10#file-example-8-dashy-crypto-widgets-conf-yml)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
# Status Indicators
|
||||
|
||||
Dashy has an optional feature that can display a small icon next to each of your running services, indicating it's current status. This can be useful if you are using Dashy as your homelab's start page, as it gives you an overview of the health of each of your running services. The status feature will show response time, response code, online/ offline check and if applicable, a relevant error message
|
||||
Dashy has an optional feature that can display a small icon next to each of your running services, indicating it's current status. This can be useful if you are using Dashy as your homelab's start page, as it gives you an overview of the health of each of your running services. The status feature will show response time, response code, online/ offline check and if applicable, a relevant error message.
|
||||
|
||||
<p align="center">
|
||||
<img width="800" src="/docs/assets/status-check-demo.gif" />
|
||||
</p>
|
||||
|
||||
## Enabling Status Indicators
|
||||
By default, this feature is off. If you do not want this feature, just don't add the `statusCheck` to your conf.yml file, then no requests will be made.
|
||||
By default, this feature is off. If you do not want this feature, just don't add the `statusCheck` to your conf.yml file, then no requests will be made.
|
||||
|
||||
To enable status checks, you can either turn it on for all items, by setting `appConfig.statusCheck: true`, like:
|
||||
```yaml
|
||||
|
|
@ -40,7 +40,7 @@ sections:
|
|||
## Continuous Checking
|
||||
By default, with status indicators enabled Dashy will check an applications status on page load, and will not keep indicators updated. This is usually desirable behavior. However, if you do want the status indicators to continue to poll your running services, this can be enabled by setting the `statusCheckInterval` attribute. Here you define an interval as an integer in seconds, and Dashy will poll your apps every x seconds. Note that if this number is very low (below 5 seconds), you may notice the app running slightly slower.
|
||||
|
||||
The following example, will instruct Dashy to continuously check the status of your services every 20 seconds
|
||||
The following example, will instruct Dashy to continuously check the status of your services every 20 seconds.
|
||||
|
||||
```
|
||||
appConfig:
|
||||
|
|
@ -49,7 +49,7 @@ appConfig:
|
|||
```
|
||||
|
||||
## Using a Different Endpoint
|
||||
By default, the status checker will use the URL of each application being checked. In some situations, you may want to use a different endpoint for status checking. Similarly, some services provide a dedicated path for uptime monitoring.
|
||||
By default, the status checker will use the URL of each application being checked. In some situations, you may want to use a different endpoint for status checking. Similarly, some services provide a dedicated path for uptime monitoring.
|
||||
|
||||
You can set the `statusCheckUrl` property on any given item in order to do this. The status checker will then ping that endpoint, instead of the apps main `url` property.
|
||||
|
||||
|
|
@ -87,11 +87,11 @@ Currently, the status check needs a page to be rendered, so if this URL in your
|
|||
|
||||
For further troubleshooting, use an application like [Postman](https://postman.com) to diagnose the issue. Set the parameter to `GET`, and then make a call to: `https://[url-of-dashy]/status-check/?&url=[service-url]`. Where the service URL must have first been encoded (e.g. with `encodeURIComponent()` or [urlencoder.io](https://www.urlencoder.io/))
|
||||
|
||||
If you're serving Dashy though a CDN, instead of using the Node server or Docker image, then the Node endpoint that makes requests will not be available to you, and all requests will fail. A workaround for this may be implemented in the future, but in the meantime, your only option is to use the Docker or Node deployment method.
|
||||
If you're serving Dashy though a CDN, instead of using the Node server or Docker image, then the Node endpoint that makes requests will not be available to you, and all requests will fail. A workaround for this may be implemented in the future, but in the meantime, your only option is to use the Docker or Node deployment method.
|
||||
|
||||
## How it Works
|
||||
|
||||
When the app is loaded, if `appConfig.statusCheck: true` is set, or if any items have the `statusCheck: true` enabled, then Dashy will make a request, to `https://[your-host-name]/status-check?url=[address-or-servce]` (may al include GET params for headers and the secure flag), which in turn will ping that running service, and respond with a status code. Response time is calculated from the difference between start and end time of the request.
|
||||
When the app is loaded, if `appConfig.statusCheck: true` is set, or if any items have the `statusCheck: true` enabled, then Dashy will make a request, to `https://[your-host-name]/status-check?url=[address-or-servce]` (may al include GET params for headers and the secure flag), which in turn will ping that running service, and respond with a status code. Response time is calculated from the difference between start and end time of the request.
|
||||
|
||||
When the response completes, an indicator will display next to each item. The color denotes the status: Yellow while waiting for the response to return, green if request was successful, red if it failed, and grey if it was unable to make the request all together.
|
||||
|
||||
|
|
|
|||
|
|
@ -193,5 +193,3 @@ These colors represent intent, and so are not often changed, but you can do so i
|
|||
- `--neutral` - Neutral color, usually grey / `#272f4d`
|
||||
- `--white` - Just white / `#fff`
|
||||
- `--black` - Just black / `#000`
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@
|
|||
|
||||
## `Refused to Connect` in Modal or Workspace View
|
||||
|
||||
This is not an issue with Dashy, but instead caused by the target app preventing direct access through embedded elements.
|
||||
This is not an issue with Dashy, but instead caused by the target app preventing direct access through embedded elements.
|
||||
|
||||
As defined in [RFC-7034](https://datatracker.ietf.org/doc/html/rfc7034), for any web content to be accessed through an embedded element, it must have the [`X-Frame-Options`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) HTTP header set to `ALLOW`. If you are getting a `Refused to Connect` error then this header is set to `DENY` (or `SAMEORIGIN` and it's on a different host). Thankfully, for self-hosted services, it is easy to set these headers.
|
||||
|
||||
|
|
@ -77,7 +77,7 @@ header {
|
|||
In Apache, you can use the [`mod_headers`](https://httpd.apache.org/docs/current/mod/mod_headers.html) module to set the `X-Frame-Options` in your config file. This file is usually located somewhere like `/etc/apache2/httpd.conf
|
||||
|
||||
```
|
||||
Header set X-Frame-Options: "ALLOW-FROM http://[dashy-location]/"
|
||||
Header set X-Frame-Options: "ALLOW-FROM http://[dashy-location]/"
|
||||
```
|
||||
|
||||
### LightHttpd
|
||||
|
|
@ -90,7 +90,7 @@ Content-Security-Policy: frame-ancestors 'self' https://[dashy-location]/
|
|||
|
||||
## 404 On Static Hosting
|
||||
|
||||
If you're seeing Dashy's 404 page on initial load/ refresh, and then the main app when you go back to Home, then this is likely caused by the Vue router, and if so can be fixed in one of two ways.
|
||||
If you're seeing Dashy's 404 page on initial load/ refresh, and then the main app when you go back to Home, then this is likely caused by the Vue router, and if so can be fixed in one of two ways.
|
||||
|
||||
The first solution is to switch the routing mode, from HTML5 `history` mode to `hash` mode, by setting `appConfig.routingMode` to `hash`.
|
||||
|
||||
|
|
@ -100,7 +100,7 @@ If this works, but you wish to continue using HTML5 history mode, then a bit of
|
|||
|
||||
## 404 after Launch from Mobile Home Screen
|
||||
|
||||
Similar to the above issue, if you get a 404 after using iOS and Android's “Add to Home Screen” feature, then this is caused by Vue router.
|
||||
Similar to the above issue, if you get a 404 after using iOS and Android's "Add to Home Screen" feature, then this is caused by Vue router.
|
||||
It can be fixed by setting `appConfig.routingMode` to `hash`
|
||||
|
||||
See also: [#628](https://github.com/Lissy93/dashy/issues/628), [#762](https://github.com/Lissy93/dashy/issues/762)
|
||||
|
|
@ -246,13 +246,13 @@ See also: #479, #409, #507, #491, #341, #520
|
|||
```
|
||||
Error response from daemon: OCI runtime create failed: container_linux.go:380:
|
||||
starting container process caused: process_linux.go:545: container init caused:
|
||||
rootfs_linux.go:76: mounting "/home/ubuntu/my-conf.yml" to rootfs at
|
||||
"/app/public/conf.yml" caused: mount through procfd: not a directory:
|
||||
rootfs_linux.go:76: mounting "/home/ubuntu/my-conf.yml" to rootfs at
|
||||
"/app/public/conf.yml" caused: mount through procfd: not a directory:
|
||||
unknown: Are you trying to mount a directory onto a file (or vice-versa)?
|
||||
Check if the specified host path exists and is the expected type.
|
||||
```
|
||||
|
||||
If you get an error similar to the one above, you are mounting a directory to the config file's location, when a plain file is expected. Create a YAML file, (`touch my-conf.yml`), populate it with a sample config, then pass it as a volume: `-v ./my-local-conf.yml:/app/public/conf.yml`
|
||||
If you get an error similar to the one above, you are mounting a directory to the config file's location, when a plain file is expected. Create a YAML file, (`touch my-conf.yml`), populate it with a sample config, then pass it as a volume: `-v ./my-local-conf.yml:/app/public/conf.yml`
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -279,7 +279,7 @@ If you find that your styles and other visual assets work when visiting `ip:port
|
|||
This situation relates to error messages similar to one of the following, returned when pulling, updating or running the Docker container from Docker Hub.
|
||||
|
||||
```
|
||||
Continuing execution. Pulling image lissy93/dashy:release-1.6.0
|
||||
Continuing execution. Pulling image lissy93/dashy:release-1.6.0
|
||||
error pulling image configuration: toomanyrequests
|
||||
```
|
||||
or
|
||||
|
|
@ -288,7 +288,7 @@ You have reached your pull rate limit. You may increase the limit by authenticat
|
|||
```
|
||||
|
||||
When DockerHub returns one of these errors, or a `429` status, that means you've hit your rate limit. This was [introduced](https://www.docker.com/blog/scaling-docker-to-serve-millions-more-developers-network-egress/) last year, and prevents unauthenticated or free users from running docker pull more than 100 times per 6 hours.
|
||||
You can [check your rate limit status](https://www.docker.com/blog/checking-your-current-docker-pull-rate-limits-and-status/) by looking for the `ratelimit-remaining` header in any DockerHub responses.
|
||||
You can [check your rate limit status](https://www.docker.com/blog/checking-your-current-docker-pull-rate-limits-and-status/) by looking for the `ratelimit-remaining` header in any DockerHub responses.
|
||||
|
||||
#### Solution 1 - Use an alternate container registry
|
||||
- Dashy is also availible through GHCR, which at present does not have any hard limits. Just use `docker pull ghcr.io/lissy93/dashy:latest` to fetch the image
|
||||
|
|
@ -375,7 +375,7 @@ Currently, the status check needs a page to be rendered, so if this URL in your
|
|||
|
||||
For further troubleshooting, use an application like [Postman](https://postman.com) to diagnose the issue. Set the parameter to `GET`, and then make a call to: `https://[url-of-dashy]/status-check/?&url=[service-url]`. Where the service URL must have first been encoded (e.g. with `encodeURIComponent()` or [urlencoder.io](https://www.urlencoder.io/))
|
||||
|
||||
If you're serving Dashy though a CDN, instead of using the Node server or Docker image, then the Node endpoint that makes requests will not be available to you, and all requests will fail. A workaround for this may be implemented in the future, but in the meantime, your only option is to use the Docker or Node deployment method.
|
||||
If you're serving Dashy though a CDN, instead of using the Node server or Docker image, then the Node endpoint that makes requests will not be available to you, and all requests will fail. A workaround for this may be implemented in the future, but in the meantime, your only option is to use the Docker or Node deployment method.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -494,7 +494,7 @@ Finally, check the [browser console](#how-to-open-browser-console) for any error
|
|||
|
||||
## Copy to Clipboard not Working
|
||||
|
||||
If the copy to clipboard feature (either under Config --> Export, or Item --> Copy URL) isn't functioning as expected, first check the browser console. If you see `TypeError: Cannot read properties of undefined (reading 'writeText')` then this feature is not supported by your browser.
|
||||
If the copy to clipboard feature (either under Config --> Export, or Item --> Copy URL) isn't functioning as expected, first check the browser console. If you see `TypeError: Cannot read properties of undefined (reading 'writeText')` then this feature is not supported by your browser.
|
||||
The most common reason for this, is if you not running the app over HTTPS. Copying to the clipboard requires the app to be running in a secure origin / aka have valid HTTPS cert. You can read more about this [here](https://stackoverflow.com/a/71876238/979052).
|
||||
|
||||
As a workaround, you could either:
|
||||
|
|
@ -512,7 +512,7 @@ In some instances cached assets can prevent your settings from being updated, in
|
|||
To clear all local data from the UI, head to the Config Menu, then click "Reset Local Settings", and Confirm when prompted.
|
||||
This will not affect your config file. But be sure that you keep a backup of your config, if you've not written changes it to disk.
|
||||
|
||||
You can also view any and all data that Dashy is storing, using the developer tools. Open your browser's dev tools (usually <kbd>F12</kbd>), in Chromium head to the Application tab, or in Firefox go to the Storage tab. Select Local Storage, then scroll down the the URL Dashy is running on. You should now see all data being stored, and you can select and delete any fields you wish.
|
||||
You can also view any and all data that Dashy is storing, using the developer tools. Open your browser's dev tools (usually <kbd>F12</kbd>), in Chromium head to the Application tab, or in Firefox go to the Storage tab. Select Local Storage, then scroll down the the URL Dashy is running on. You should now see all data being stored, and you can select and delete any fields you wish.
|
||||
|
||||
For a full list of all data that may be cached, see the [Privacy Docs](/docs/privacy.md#browser-storage).
|
||||
|
||||
|
|
|
|||
124
docs/widgets.md
124
docs/widgets.md
|
|
@ -161,7 +161,7 @@ A simple, live-updating local weather component, showing temperature, conditions
|
|||
|
||||
### Weather Forecast
|
||||
|
||||
Displays the weather (temperature and conditions) for the next few days for a given location. Note that this requires either the free [OpenWeatherMap Student Plan](https://home.openweathermap.org/students), or the Premium Plan.
|
||||
Displays the weather (temperature and conditions) for the next few days for a given location. Note that this requires either the free [OpenWeatherMap Student Plan](https://home.openweathermap.org/students), or the Premium Plan.
|
||||
|
||||
<p align="center"><img width="400" src="https://i.ibb.co/vshwgZB/weather-forecast.png" /></p>
|
||||
|
||||
|
|
@ -249,7 +249,7 @@ Or what about showing a photo of the day? Try `https://source.unsplash.com/rando
|
|||
--- | --- | --- | ---
|
||||
**`imagePath`** | `string` | Required | The path (local or remote) of the image to display
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: image
|
||||
|
|
@ -276,7 +276,7 @@ _All fields are optional_
|
|||
**`provider`** | `string` | _Optional_ | The name of the service to fetch IP address from. Can be either `ipapi.co`, `ip-api` or `ipgeolocation`. Defaults to `ipapi.co`. Note, `ip-api` doesn't work on HTTPS, and if you set to `ipgeolocation` then you must also provide an API key
|
||||
**`apiKey`** | `string` | _Optional_ | Only required if provider is set to `ipgeolocation`. You can get a free API key [here](https://ipgeolocation.io/signup.html)
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: public-ip
|
||||
|
|
@ -313,7 +313,7 @@ Notice certain web pages aren't loading? This widget quickly shows which blackli
|
|||
**`ipAddress`** | `string` | _Optional_ | The IP to check. This can also be a domain/ host name or even an email address. If left blank, Dashy will use your current public IP address.
|
||||
**`apiKey`** | `string` | Required | You can get your free API key from [blacklistchecker.com](https://blacklistchecker.com/keys)
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: blacklist-check
|
||||
|
|
@ -345,7 +345,7 @@ Keep an eye on the expiry dates of your domain names, using public whois records
|
|||
**`apiKey`** | `string` | Required | You can get your free API key from [my.whoapi.com](https://my.whoapi.com/user/signup)
|
||||
**`showFullInfo`** | `boolean` | _Optional_ | If set to true, the toggle-full-info panel will be open by default
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: domain-monitor
|
||||
|
|
@ -470,7 +470,7 @@ Keep track of your crypto balances and see recent transactions. Data is fetched
|
|||
- type: wallet-balance
|
||||
options:
|
||||
coin: btc
|
||||
address: 3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC
|
||||
address: 3853bSxupMjvxEYfwGDGAaLZhTKxB2vEVC
|
||||
```
|
||||
|
||||
##### Info
|
||||
|
|
@ -644,7 +644,7 @@ Display current FX rates in your native currency. Hover over a row to view more
|
|||
**`outputCurrencies`** | `array` | Required | List or currencies to show results for. Specified as a 3-letter ISO-4217 code, see [here](https://www.exchangerate-api.com/docs/supported-currencies) for the full list of supported currencies, and their symbols
|
||||
**`apiKey`** | `string` | Required | API key for [exchangerate-api.com](https://www.exchangerate-api.com/), usually a 24-digit alpha-numeric string. You can sign up for a free account [here](https://app.exchangerate-api.com/sign-up)
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: exchange-rates
|
||||
|
|
@ -717,7 +717,7 @@ Keep track of the current COVID-19 status. Optionally also show cases by country
|
|||
**`limit`** | `number` | _Optional_ | If showing all countries, set a limit for number of results to return. Defaults to `10`, no maximum
|
||||
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: covid-stats
|
||||
|
|
@ -799,7 +799,7 @@ Displays the latest news, click to read full article. Date is fetched from vario
|
|||
**`keywords`** | `string` | _Optional_ | Only return articles that contain an exact match within their title or description
|
||||
**`hideImages`** | `boolean` | _Optional_ | If set to `true`, then article image thumbnails will not be displayed
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: news-headlines
|
||||
|
|
@ -831,7 +831,7 @@ Shows real-time tube status of the London Underground. All fields are optional.
|
|||
**`sortAlphabetically`** | `boolean` | _Optional_ | By default lines are sorted by current status, set this option to `true` to instead sort them alphabetically
|
||||
**`linesToShow`** | `array` | _Optional_ | By default all lines are shown. If you're only interested in the status of a few lines, then pass in an array of lines to show, specified by name
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: tfl-status
|
||||
|
|
@ -873,7 +873,7 @@ Shows recent price history for a given publicly-traded stock or share
|
|||
**`chartColor`** | `string` | _Optional_ | Color of the chart value. Defaults to `--widget-text-color` which inherits dashboard primary color
|
||||
**`chartHeight`** | `number` | _Optional_ | The height of rendered chart in px. Defaults to `300`
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: stock-price-chart
|
||||
|
|
@ -901,7 +901,7 @@ Renders the current Gas cost of transactions on the Ethereum network (in both GW
|
|||
|
||||
_No config options._
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: eth-gas-prices
|
||||
|
|
@ -930,7 +930,7 @@ Renders a programming or generic joke. Data is fetched from the [JokesAPI](https
|
|||
**`safeMode`** | `boolean` | _Optional_ | Set to `true`, to prevent the fetching of any NSFW jokes. Defaults to `false`
|
||||
**`language`** | `string` | _Optional_ | Specify the language for returned jokes. The following languages are supported: `en`, `cs`, `de`, `es`, `fr` and `pt`, and an up-to-date list of supported languages can be found [here](https://v2.jokeapi.dev/languages). By default, your system language will be used, if it's supported, otherwise English
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: joke
|
||||
|
|
@ -992,7 +992,7 @@ Displays airport departure and arrival flights, using data from [AeroDataBox](ht
|
|||
**`limit`** | `number` | _Optional_ | For busy airports, you may wish to limit the number of results visible
|
||||
**`direction`** | `string` | _Optional_ | By default, both departure and arrival flights will be fetched, if you would like to only show flights in one direction, set this to wither `departure` or `arrival`
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: flight-data
|
||||
|
|
@ -1022,7 +1022,7 @@ Show the NASA Astronomy Pictore of the Day. Data is fetched from [APOD](https://
|
|||
|
||||
_No config options._
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: apod
|
||||
|
|
@ -1051,7 +1051,7 @@ Displays currently trending projects on GitHub. Optionally specify a language an
|
|||
**`since`** | `string` | _Optional_ | The timeframe to use when calculating trends. Can be either `daily`, `weekly` or `monthly`. Defaults to `daily`
|
||||
**`limit`** | `number` | _Optional_ | Optionally limit the number of results. Max `25`, default is `10`
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: github-trending-repos
|
||||
|
|
@ -1085,7 +1085,7 @@ Display stats from your GitHub profile, using embedded cards from [anuraghazra/g
|
|||
**`repos`** | `array` | _Optional_ | If you'd like to also display stats for some GitHub reposotories, then add an array or repo names here. Specified as `[username]/[repo-name]`, e.g. `lissy93/dashy`
|
||||
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
|
||||
```yaml
|
||||
|
|
@ -1121,7 +1121,7 @@ Displays info about the server which Dashy is hosted on. Includes user + host, o
|
|||
|
||||
_No config options._
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: system-info
|
||||
|
|
@ -1147,7 +1147,7 @@ Cron job monitoring using [Health Checks](https://github.com/healthchecks/health
|
|||
**`apiKey`** | `string` | Required | A read-only API key for the project to monitor. You can generate this by selecting a Project --> Settings --> API Access. Note that you must generate a separate key for each project
|
||||
**`host`** | `string` | _Optional_ | If you're self-hosting, or using any instance other than the official (healthchecks.io), you will need to specify the host address. E.g. `https://healthchecks.example.com` or `http://cron-monitoing.local`
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: health-checks
|
||||
|
|
@ -1178,7 +1178,7 @@ Pull recent CPU usage history from NetData.
|
|||
**`chartHeight`** | `number` | _Optional_ | The height of rendered chart in px. Defaults to `300`
|
||||
**`chartColor`** / **`chartColors`** | `string` / `array`| _Optional_ | Color of the chart value(s) as hex codes. `chartColor` is a single value (defaults to `--widget-text-color`), whereas `chartColors` is an array of colors
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: nd-cpu-history
|
||||
|
|
@ -1210,7 +1210,7 @@ Pull recent system RAM usage from NetData, and show as a breakdown of different
|
|||
**`chartHeight`** | `number` | _Optional_ | The height of rendered chart in px. Defaults to `300`
|
||||
**`chartColor`** / **`chartColors`** | `string` / `array`| _Optional_ | Color of the chart value(s) as hex codes. `chartColor` is a single value (defaults to `--widget-text-color`), whereas `chartColors` is an array of colors
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: nd-ram-history
|
||||
|
|
@ -1241,7 +1241,7 @@ Pull recent load usage in 1, 5 and 15 minute intervals, from NetData.
|
|||
**`chartHeight`** | `number` | _Optional_ | The height of rendered chart in px. Defaults to `300`
|
||||
**`chartColor`** / **`chartColors`** | `string` / `array`| _Optional_ | Color of the chart value(s) as hex codes. `chartColor` is a single value (defaults to `--widget-text-color`), whereas `chartColors` is an array of colors
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: nd-load-history
|
||||
|
|
@ -1271,7 +1271,7 @@ Displays the number of queries blocked by [Pi-Hole](https://pi-hole.net/).
|
|||
**`hostname`** | `string` | Required | The URL to your Pi-Hole instance
|
||||
**`hideStatus`** / **`hideChart`** / **`hideInfo`** | `boolean` | _Optional_ | Optionally hide any of the three parts of the widget
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: pi-hole-stats
|
||||
|
|
@ -1302,7 +1302,7 @@ Shows top queries that were blocked and allowed by [Pi-Hole](https://pi-hole.net
|
|||
**`apiKey`** | `string` | Required | Your Pi-Hole web password. It is **NOT** your pi-hole admin interface or server password. It can be found in `/etc/pihole/setupVars.conf`, and is a 64-character located on the line that starts with `WEBPASSWORD`
|
||||
**`count`** | `number` | _Optional_ | The number of queries to display. Defaults to `10`
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: pi-hole-top-queries
|
||||
|
|
@ -1332,7 +1332,7 @@ Shows number of recent traffic, using allowed and blocked queries from [Pi-Hole]
|
|||
--- | --- | --- | ---
|
||||
**`hostname`** | `string` | Required | The URL to your Pi-Hole instance
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: pi-hole-traffic
|
||||
|
|
@ -1364,7 +1364,7 @@ Displays the current and recent uptime of your running services, via a self-host
|
|||
**`showChart`** | `boolean`| Optional | If provided and `false` then charts are not displayed. Defaults to `true`.
|
||||
**`showInfo`** | `boolean`| Optional | If provided and `false` then information summaries are not displayed. Defaults to `true`.
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: stat-ping
|
||||
|
|
@ -1407,7 +1407,7 @@ Displays the current downloads/torrents tasks of your Synology NAS
|
|||
**`username`** | `string` | Required | The username of a user on your synology NAS. You will see only this user download station tasks if he is not part of the administrator group. Currently don't support OTP protected accounts.
|
||||
**`password`** | `string` | Required | The password of the account specified above.
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: synology-download
|
||||
|
|
@ -1443,7 +1443,7 @@ displays total number of allowed and blocked queries, plus a pie chart showing b
|
|||
**`username`** | `string` | _Optional_ | If you've got auth enabled on AdGuard, provide your username here
|
||||
**`password`** | `string` | _Optional_ | If you've got auth enabled on AdGuard, provide your password here
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: adguard-stats
|
||||
|
|
@ -1479,7 +1479,7 @@ Fetches data from your [AdGuard Home](https://adguard.com/en/adguard-home/overvi
|
|||
**`password`** | `string` | _Optional_ | If you've got auth enabled on AdGuard, provide your password here
|
||||
**`showOnOffStatusOnly`** | `boolean` | _Optional_ | If set to `true`, will only show aggregated AdGuard filter status (on/off), instead of a list of filters
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: adguard-filter-status
|
||||
|
|
@ -1515,7 +1515,7 @@ Fetches data from your [AdGuard Home](https://adguard.com/en/adguard-home/overvi
|
|||
**`password`** | `string` | _Optional_ | If you've got auth enabled on AdGuard, provide your password here
|
||||
**`showFullInfo`** | `boolean` | _Optional_ | If set to `true`, the full DNS info will be shown by default, without having to click "Show Info"
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: adguard-dns-info
|
||||
|
|
@ -1553,7 +1553,7 @@ Fetches data from your [AdGuard Home](https://adguard.com/en/adguard-home/overvi
|
|||
**`hideBlockedDomains`** | `boolean` | _Optional_ | Don't show the blocked domains list (queried domains only)
|
||||
**`hideQueriedDomains`** | `boolean` | _Optional_ | Don't show the queried domains list (blocked domains only)
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: adguard-top-domains
|
||||
|
|
@ -1595,7 +1595,7 @@ Known issues: the User API incorrectly reports available disk space as total for
|
|||
**`password`** | `string` | Required | Nextcloud app-password (create one in Settings -> Security)
|
||||
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: nextcloud-user
|
||||
|
|
@ -1632,7 +1632,7 @@ Show user statuses for selected users.
|
|||
**`showEmpty`** | `boolean` | _Optional_ | Show statuses without a message, defaults to `true`
|
||||
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: nextcloud-userstatus
|
||||
|
|
@ -1666,10 +1666,10 @@ Displays your notifications and allows deleting them.
|
|||
**`hostname`** | `string` | Required | The URL of the Nextcloud server
|
||||
**`username`** | `string` | Required | Nextcloud username
|
||||
**`password`** | `string` | Required | Nextcloud app-password (create one in Settings -> Security)
|
||||
**`limit`** | `number\|string` | _Optional_ | Limit displayed notifications either by count, e.g. `5` to show the 5 most recent, or by age, e.g. `1d` to only show notifications not older than a day. Accepted suffixes for age limit are `m`, `h` and `d`.
|
||||
**`limit`** | `number\|string` | _Optional_ | Limit displayed notifications either by count, e.g. `5` to show the 5 most recent, or by age, e.g. `1d` to only show notifications not older than a day. Accepted suffixes for age limit are `m`, `h` and `d`.
|
||||
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: nextcloud-userstatus
|
||||
|
|
@ -1704,7 +1704,7 @@ Visualises overall memory utilisation and CPU load averages, shows server versio
|
|||
**`username`** | `string` | Required | Must be a Nextcloud admin user
|
||||
**`password`** | `string` | Required | Nextcloud app-password (create one in Settings -> Security)
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: nextcloud-system
|
||||
|
|
@ -1738,7 +1738,7 @@ Shows key usage statistics about your Nextcloud server.
|
|||
**`username`** | `string` | Required | Must be a Nextcloud admin user
|
||||
**`password`** | `string` | Required | Nextcloud app-password (create one in Settings -> Security)
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: nextcloud-stats
|
||||
|
|
@ -1772,7 +1772,7 @@ Shows statistics about PHP Opcache perforamnce on your Nextcloud server.
|
|||
**`username`** | `string` | Required | Must be a Nextcloud admin user
|
||||
**`password`** | `string` | Required | Nextcloud app-password (create one in Settings -> Security)
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: nextcloud-stats
|
||||
|
|
@ -1803,12 +1803,12 @@ Shows queue information regarding your self hosted Sabnzbd server.
|
|||
**Field** | **Type** | **Required** | **Description**
|
||||
--- | --- | --- | ---
|
||||
**`sabnzbdUrl`** | `string` | Required | The URL of the Sabnzbd server. No trailing `/`.
|
||||
**`apiKey`** | `string` | Required | API key for Sabnzbd access. Located under `Config` -> `General` -> `Security` -> `API Key`.
|
||||
**`apiKey`** | `string` | Required | API key for Sabnzbd access. Located under `Config` -> `General` -> `Security` -> `API Key`.
|
||||
**`hideDetails`** | `boolean` | _Optional_ | Hides extra server queue details.
|
||||
**`hideQueue`** | `boolean` | _Optional_ | Hides the queue list in an expandable dropdown.
|
||||
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: sabnzbd
|
||||
|
|
@ -1838,11 +1838,11 @@ Display info from the Gluetun VPN container public IP API. This can show the IP
|
|||
|
||||
**Field** | **Type** | **Required** | **Description**
|
||||
--- | --- | --- | ---
|
||||
**`visibleFields`** | `string` | Required | A comma separated list of the fields you want visible in the widget. You can have any number of the following : `public_ip`, `region`, `country`, `city`, `location`, `organisation`, `postal_code`, `timezone`. Defaults to just `public_ip`
|
||||
**`visibleFields`** | `string` | Required | A comma separated list of the fields you want visible in the widget. You can have any number of the following : `public_ip`, `region`, `country`, `city`, `location`, `organisation`, `postal_code`, `timezone`. Defaults to just `public_ip`
|
||||
**`host`** | `string` | Required | The url to the gluetun HTTP control server. E.g. `http://gluetun:8000`
|
||||
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
|
||||
```yaml
|
||||
|
|
@ -1903,7 +1903,7 @@ Live-updating current CPU usage, as a combined average across alll cores
|
|||
|
||||
<p align="center"><img width="400" src="https://i.ibb.co/qkLgxLp/gl-cpu-usage.png" /></p>
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: gl-current-cpu
|
||||
|
|
@ -1919,7 +1919,7 @@ Live-updating CPU usage breakdown per core
|
|||
|
||||
<p align="center"><img width="400" src="https://i.ibb.co/512MYhT/gl-cpu-cores.png" /></p>
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: gl-current-cores
|
||||
|
|
@ -1941,7 +1941,7 @@ Recent CPU usage history, across all cores, and displayed by user and system
|
|||
--- | --- | --- | ---
|
||||
**`limit`** | `number` | _Optional_ | Limit the number of results returned, rendering more data points will take longer to load. Defaults to `100`
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: gl-cpu-history
|
||||
|
|
@ -1958,7 +1958,7 @@ Real-time memory usage gauge, with more info visible on click
|
|||
|
||||
<p align="center"><img width="400" src="https://i.ibb.co/rynp52J/gl-mem-usage.png" /></p>
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: gl-current-mem
|
||||
|
|
@ -1981,7 +1981,7 @@ Recent memory usage chart
|
|||
**`limit`** | `number` | _Optional_ | Limit the number of results returned, rendering more data points will take longer to load. Defaults to `100`
|
||||
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: gl-mem-history
|
||||
|
|
@ -1998,7 +1998,7 @@ List connected disks, showing free / used space and other info (file system, mou
|
|||
|
||||
<p align="center"><img width="400" src="https://i.ibb.co/25y94bB/gl-disk-usage.png" /></p>
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: gl-disk-space
|
||||
|
|
@ -2010,11 +2010,11 @@ List connected disks, showing free / used space and other info (file system, mou
|
|||
|
||||
### Disk IO
|
||||
|
||||
Shows real-time read and write speeds and operations per sec for each disk
|
||||
Shows real-time read and write speeds and operations per sec for each disk
|
||||
|
||||
<p align="center"><img width="400" src="https://i.ibb.co/JdgjCjG/gl-disk-io.png" /></p>
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: gl-disk-io
|
||||
|
|
@ -2030,7 +2030,7 @@ Shows the number of processes waiting in the run-queue, averaged across all core
|
|||
|
||||
<p align="center"><img width="400" src="https://i.ibb.co/090FfNy/gl-system-load.png" /></p>
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: gl-system-load
|
||||
|
|
@ -2046,7 +2046,7 @@ Shows recent historical system load, calculated from the number of processes wai
|
|||
|
||||
<p align="center"><img width="500" src="https://i.ibb.co/C2rGMLg/system-load-history.png" /></p>
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: gl-load-history
|
||||
|
|
@ -2062,7 +2062,7 @@ Lists visible network interfaces, including real-time upload/ download stats
|
|||
|
||||
<p align="center"><img width="400" src="https://i.ibb.co/FnhgHfG/gl-network-interfaces.png" /></p>
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: gl-network-interfaces
|
||||
|
|
@ -2078,7 +2078,7 @@ Shows amount of data recently uploaded/ downloaded across all network interfaces
|
|||
|
||||
<p align="center"><img width="400" src="https://i.ibb.co/12RN6KT/gl-network-traffic.png" /></p>
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: gl-network-traffic
|
||||
|
|
@ -2095,7 +2095,7 @@ Lists recent high resource usage alerts (e.g. CPU, mem, IO, load, temp)
|
|||
|
||||
<p align="center"><img width="400" src="https://i.ibb.co/w01NX5R/gl-alerts.png" /></p>
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: gl-alerts
|
||||
|
|
@ -2111,7 +2111,7 @@ Shows public and private IP address. Note that the ip plugin is not available on
|
|||
|
||||
<p align="center"><img width="400" src="https://i.ibb.co/ZhXBxZr/gl-ip-address.png" /></p>
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: gl-ip-address
|
||||
|
|
@ -2130,7 +2130,7 @@ You'll need to enable the sensors plugin to use this widget, using: `--enable-pl
|
|||
|
||||
<p align="center"><img width="400" src="https://i.ibb.co/xSs4Gqd/gl-cpu-temp.png" /></p>
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: gl-cpu-temp
|
||||
|
|
@ -2155,7 +2155,7 @@ Embed any webpage into your dashboard as a widget.
|
|||
**`url`** | `string` | Required | The URL to the webpage to embed
|
||||
**`frameHeight`** | `number` | _Optional_ | If needed, specify height of iframe in `px`. E.g. `400`, defaults to auto
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: iframe
|
||||
|
|
@ -2182,13 +2182,13 @@ Many websites and apps provide their own embeddable widgets. These can be used w
|
|||
**`scriptSrc`** | `string` | _Optional_ | A URL to JavaScript content (caution)
|
||||
**`css`** | `string` | _Optional_ | Any stylings for widget contents
|
||||
|
||||
##### Example
|
||||
##### Example
|
||||
|
||||
```yaml
|
||||
- type: embed
|
||||
options:
|
||||
scriptSrc: https://cdn.speedcheck.org/basic/scbjs.min.js
|
||||
html: |
|
||||
html: |
|
||||
<div id="sc-container">
|
||||
<div id="sc-branding" class="sc-bb">
|
||||
<a target="_blank" href="https://www.speedcheck.org/">
|
||||
|
|
@ -2380,7 +2380,7 @@ In some instances, this is a false positive, and the widget is actually function
|
|||
|
||||
### Widget Styling
|
||||
|
||||
Like elsewhere in Dashy, all colours can be easily modified with CSS variables.
|
||||
Like elsewhere in Dashy, all colours can be easily modified with CSS variables.
|
||||
|
||||
Widgets use the following color variables, which can be overridden if desired:
|
||||
- `--widget-text-color` - Text color, defaults to `--primary`
|
||||
|
|
@ -2433,7 +2433,7 @@ Widgets cannot currently be edited through the UI. This feature is in developmen
|
|||
|
||||
Widgets are built in a modular fashion, making it easy for anyone to create their own custom components.
|
||||
|
||||
For a full tutorial on creating your own widget, you can follow [this guide](/docs/development-guides.md#building-a-widget), or take a look at [here](https://github.com/Lissy93/dashy/commit/3da76ce2999f57f76a97454c0276301e39957b8e) for a code example.
|
||||
For a full tutorial on creating your own widget, you can follow [this guide](/docs/development-guides.md#building-a-widget), or take a look at [here](https://github.com/Lissy93/dashy/commit/3da76ce2999f57f76a97454c0276301e39957b8e) for a code example.
|
||||
|
||||
Alternatively, for displaying simple data, you could also just use the either the [iframe](#iframe-widget), [embed](#html-embedded-widget), [data feed](#data-feed) or [API response](#api-response) widgets.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue