Skip to content

armgit / dashy

Public Imported from GitHub
0

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

πŸ“ Updates out-dated config options in docs

Alicia Sykesde6f60123330
diff --git a/docs/authentication.md b/docs/authentication.md
index 9ed81333..b2bce798 100644
--- a/docs/authentication.md
+++ b/docs/authentication.md
@@ -360,9 +360,9 @@ appConfig:
auth:
enableOidc: true
oidc:
- clientId: ['registered client id']
- endpoint: [OIDC endpoint]
- scope: [The scope(s) to request from the OIDC provider]
+ clientId: 'registered-client-id'
+ endpoint: 'https://your-oidc-provider.example.com'
+ scope: 'openid profile email'
adminGroup: admin
```
diff --git a/docs/configuring.md b/docs/configuring.md
index b8d3795a..9558eadf 100644
--- a/docs/configuring.md
+++ b/docs/configuring.md
@@ -122,12 +122,13 @@ For more info, see the[Multi-Page docs](/docs/pages-and-sections.md#multi-page-s
**`colCount`** | `number` | _Optional_ | The number of columns of sections displayed on the homepage, using the default view. Should be in integer between `1` and `8`. Note that by default this is applied responsively, based on current screen size, and specifying a value here will override this behavior, which may not be desirable.
**`contentMaxWidth`** | `string` or `number` | _Optional_ | Sets the max width of the main sections area on the homepage, overriding the responsive default. Can be a percentage, or any CSS unit
**`theme`** | `string` | _Optional_ | The default theme for first load (you can change this later from the UI)
+**`dayTheme`** | `string` | _Optional_ | Theme to apply when the OS is set to light mode. Overrides `theme` on initial load
+**`nightTheme`** | `string` | _Optional_ | Theme to apply when the OS is set to dark mode. Overrides `theme` on initial load
**`cssThemes`** | `string[]` | _Optional_ | An array of custom theme names which can be used in the theme switcher dropdown
**`customColors`** | `object`| _Optional_ | Enables you to apply a custom color palette to any given theme. Use the theme name (lowercase) as the key, for an object including key-value-pairs, with the color variable name as keys, and 6-digit hex code as value. See [Theming](/docs/theming.md#modifying-theme-colors) for more info
**`externalStyleSheet`** | `string` or `string[]` | _Optional_ | Either a URL to an external stylesheet or an array or URLs, which can be applied as themes within the UI
**`customCss`** | `string` | _Optional_ | Raw CSS that will be applied to the page. This can also be set from the UI. Please minify it first.
**`hideComponents`** | `object` | _Optional_ | A list of key page components (header, footer, search, settings, etc) that are present by default, but can be removed using this option. See [`appConfig.hideComponents`](#appconfighideComponents-optional)
-**`routingMode`** | `string` | _Optional_ | Can be either `hash` or `history`. Determines the URL format for sub-pages, hash mode will look like `/#/home` whereas with history mode available you have nice clean URLs, like `/home`. For more info, see the [Vue docs](https://router.vuejs.org/guide/essentials/history-mode.html#example-server-configurations). If you're hosting Dashy with a custom BASE_URL, you will find that a bit of extra server config is necessary to get history mode working, so here you may want to instead use `hash` mode.Defaults to `history`.
**`enableMultiTasking`** | `boolean` | _Optional_ | If set to true, will keep apps open in the background when in the workspace view. Useful for quickly switching between multiple sites, and preserving their state, but comes at the cost of performance.
**`workspaceLandingUrl`** | `string` | _Optional_ | The URL or an app, service or website to launch when the workspace view is opened, before another service has been launched
**`preventWriteToDisk`** | `boolean` | _Optional_ | If set to `true`, users will be prevented from saving config changes to disk through the UI
@@ -187,6 +188,7 @@ For more info, see the **[Authentication Docs](/docs/authentication.md)**
**`serverUrl`** | `string` | Required | The URL (or URL/ IP + Port) where your keycloak server is running
**`realm`** | `string` | Required | The name of the realm (must already be created) that you want to use
**`clientId`** | `string` | Required | The Client ID of the client you created for use with Dashy
+**`idpHint`** | `string` | _Optional_ | The alias of an Identity Provider configured in your realm. If set, Keycloak will skip its login page and redirect straight to that external IdP
**`legacySupport`** | `boolean` | _Optional_ | If using Keycloak 17 or older, then set this to `true`
**[⬆️ Back to Top](#configuring)**
@@ -216,7 +218,7 @@ For more info, see the **[Authentication Docs](/docs/authentication.md)**
**Field** | **Type** | **Required**| **Description**
--- | --- | --- | ---
-**`disableWebSearch`** | `string` | _Optional_ | Web search is enabled by default, but can be disabled by setting this property to `true`
+**`disableWebSearch`** | `boolean` | _Optional_ | Web search is enabled by default, but can be disabled by setting this property to `true`. Defaults to `false`
**`searchEngine`** | `string` | _Optional_ | Set the key name for your search engine. Can also use a custom engine by setting this property to `custom`. Currently supported: `duckduckgo`, `google`, `whoogle`, `qwant`, `startpage`, `searx-bar` and `searx-info`. Defaults to `duckduckgo`
**`customSearchEngine`** | `string` | _Optional_ | You can also use a custom search engine, or your own self-hosted instance. This requires `searchEngine: custom` to be set. Then add the URL of your service, with GET query string included here
**`openingMethod`** | `string` | _Optional_ | Set your preferred opening method for search results: `newtab`, `sametab`, `workspace`. Defaults to `newtab`
@@ -271,6 +273,7 @@ For more info, see the **[Authentication Docs](/docs/authentication.md)**
**`backgroundColor`** | `string` | _Optional_ | An optional background fill color for the that given item. Again, this will override the current theme and so might not display well against the background
**`provider`** | `string` | _Optional_ | The name of the provider for a given service, useful for when including hosted apps. In some themes, this is visible under the item name
**`displayData`** | `object` | _Optional_ | Meta-data to optionally override display settings for a given item. See [`displayData`](#itemdisplaydata-optional)
+**`subItems`** | `array` | _Optional_ | An optional list of nested sub-items, rendered as smaller icons within the parent. Each sub-item supports `title`, `url`, `icon`, `target`, `color` and `backgroundColor`
**[⬆️ Back to Top](#configuring)**
@@ -309,7 +312,7 @@ For more info, see the **[Authentication Docs](/docs/authentication.md)**
**`collapsed`** | `boolean` | _Optional_ | If true, the section will be collapsed initially, and will need to be clicked to open. Useful for less regularly used, or very long sections. Defaults to `false`
**`cutToHeight`** | `boolean` | _Optional_ | By default, sections will fill available space. Set this option to true to match section height with content height
**`rows`** | `number` | _Optional_ | Height of the section, specified as the number of rows it should span vertically, e.g. `2`. Defaults to `1`. Max is `5`.
-**`cols`** | `number` | _Optional_ | Width of the section, specified as the number of columns the section should span horizontally, e.g. `2`. Defaults to `1`. Max is `6`. Will be clamped to the page's active column count so that a section never exceeds the available grid width.
+**`cols`** | `number` | _Optional_ | Width of the section, specified as the number of columns the section should span horizontally, e.g. `2`. Defaults to `1`. Max is `5`. Will be clamped to the page's active column count so that a section never exceeds the available grid width.
**`itemSize`** | `string` | _Optional_ | Specify the size for items within this group, either `small`, `medium` or `large`. Note that this will override any settings specified through the UI
**`color`** | `string` | _Optional_ | A custom accent color for the section, as a hex code or HTML color (e.g. `#fff`)
**`customStyles`** | `string` | _Optional_ | Custom CSS properties that should be applied to that section, e.g. `border: 2px dashed #ff0000;`
diff --git a/docs/management.md b/docs/management.md
index 3f679d1b..e2ab9bd0 100644
--- a/docs/management.md
+++ b/docs/management.md
@@ -806,7 +806,7 @@ server {
}
```
-To use HTML5 history mode (`appConfig.routingMode: history`), replace the inside of the location block with: `try_files $uri $uri/ /index.html;`.
+To use HTML5 history mode (the default - controlled via the `VUE_APP_ROUTING_MODE` build-time env var), replace the inside of the location block with: `try_files $uri $uri/ /index.html;`.
Then upload the build contents of Dashy's dist directory to that location.
For example: `scp -r ./dist/* [username]@[server_ip]:/var/www/dashy/html`
diff --git a/docs/multi-language-support.md b/docs/multi-language-support.md
index fcb08593..3bb4d659 100644
--- a/docs/multi-language-support.md
+++ b/docs/multi-language-support.md
@@ -18,7 +18,7 @@ You can manually select your language in the UI. Under the Config Menu, click th
### Config File
-You can also set your language in the config file. Specify the ISO code of one of the supported languages, under `appConfig.lang`. For example:
+You can also set your language in the config file. Specify the ISO code of one of the supported languages, under `appConfig.language`. For example:
```yaml
appConfig:
diff --git a/docs/privacy.md b/docs/privacy.md
index 44dad083..8f3a92d3 100644
--- a/docs/privacy.md
+++ b/docs/privacy.md
@@ -271,7 +271,7 @@ These can be combined with the `admin` and `normal` user roles to give fine-grai
You may wish to disable features that you don't want to use, if they involve storing data in the browser or making network requests.
- To disable smart-sort (uses local storage), set `appConfig.disableSmartSort: true`
- To disable update checks (makes external request to GH), set `appConfig.disableUpdateChecks: true`
-- To disable web search (redirect to external / internal content), set `appConfig.disableWebSearch: true`
+- To disable web search (redirect to external / internal content), set `appConfig.webSearch.disableWebSearch: true`
- To keep status checks disabled (external/ internal requests), set `appConfig.statusCheck: false`
- To keep font-awesome icons disabled (external requests), set `appConfig.enableFontAwesome: false`
- To keep error reporting disabled (external requests and data collection), set `appConfig.enableErrorReporting: false`
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
index c360b397..740bb3d2 100644
--- a/docs/troubleshooting.md
+++ b/docs/troubleshooting.md
@@ -118,16 +118,16 @@ Content-Security-Policy: frame-ancestors 'self' https://[dashy-location]/
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`.
+The first solution is to switch the routing mode, from HTML5 `history` mode to `hash` mode, by rebuilding Dashy with the `VUE_APP_ROUTING_MODE=hash` build-time environment variable set.
-If this works, but you wish to continue using HTML5 history mode, then a bit of extra [server configuration](/docs/management.md#web-server-configuration) is required. This is explained in more detaail in the [Vue Docs](https://router.vuejs.org/guide/essentials/history-mode.html). Once completed, you can then use `routingMode: history` again, for neater URLs.
+If this works, but you wish to continue using HTML5 history mode, then a bit of extra [server configuration](/docs/management.md#web-server-configuration) is required. This is explained in more detaail in the [Vue Docs](https://router.vuejs.org/guide/essentials/history-mode.html). Once completed, you can then use `VUE_APP_ROUTING_MODE=history` (the default) again, for neater URLs.
---
## 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.
-It can be fixed by setting `appConfig.routingMode` to `hash`
+It can be fixed by rebuilding Dashy with the `VUE_APP_ROUTING_MODE=hash` build-time environment variable set.
See also: [#628](https://github.com/Lissy93/dashy/issues/628), [#762](https://github.com/Lissy93/dashy/issues/762)
@@ -135,7 +135,7 @@ See also: [#628](https://github.com/Lissy93/dashy/issues/628), [#762](https://gi
## 404 On Multi-Page Apps
-Similar to above, if you get a 404 error when visiting a page directly on multi-page apps, then this can be fixed under `appConfig`, by setting `routingMode` to `hash`. Then rebuilding, and refreshing the page.
+Similar to above, if you get a 404 error when visiting a page directly on multi-page apps, then this can be fixed by rebuilding Dashy with the `VUE_APP_ROUTING_MODE=hash` build-time environment variable set, then refreshing the page.
See also: [#670](https://github.com/Lissy93/dashy/issues/670), [#763](https://github.com/Lissy93/dashy/issues/763)