mirror of
https://github.com/Lissy93/dashy.git
synced 2024-09-11 22:27:10 +03:00
📝 Starts writing multi-page docs
This commit is contained in:
parent
bc391e285c
commit
d5c5c4fc85
51
docs/pages-and-sections.md
Normal file
51
docs/pages-and-sections.md
Normal file
@ -0,0 +1,51 @@
|
||||
# Pages and Sections
|
||||
|
||||
|
||||
## Multi-Page Support
|
||||
|
||||
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.
|
||||
|
||||
Note that the only top-level fields supported by sub-pages are `pageInfo` and `sections`. The `appConfig` and `pages` will always be inherited from your main `conf.yml` file. Other than that, sub-pages behave exactly the same as your default view, and can contain sections, items, widgets and page info like nav links, title and logo.
|
||||
|
||||
### Using Local Sub-Pages
|
||||
|
||||
To get started, create a new `.yml` config file for your sub-page, placing it within `/app/public`. Then within your primary `conf.yml`, choose a name, and specify the path to the new file.
|
||||
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
pages:
|
||||
- name: Networking Services
|
||||
path: 'networking.yml'
|
||||
- name: Work Stuff
|
||||
path: 'work.yml'
|
||||
```
|
||||
|
||||
### Using Remote Sub-Pages
|
||||
|
||||
Config files don't need to be local, you can store them anywhere, and data will be imported as sub-pages on page load.
|
||||
|
||||
For example:
|
||||
|
||||
```yaml
|
||||
pages:
|
||||
- name: Getting Started
|
||||
path: 'https://snippet.host/tvcw/raw'
|
||||
- name: Homelab
|
||||
path: 'https://snippet.host/tetp/raw'
|
||||
- name: Browser Startpage
|
||||
path: 'https://snippet.host/zcom/raw'
|
||||
```
|
||||
|
||||
There are many options of how this can be used. You could store your config within a Git repository, in order to easily track and rollback changes. Or host your config on your NAS, to have it backed up with the rest of your files. Or use a hosted paste service, for example [snippet.host](https://snippet.host/), which supports never-expiring CORS-enabled pastes, which can also be edited later.
|
||||
|
||||
You will obviously not be able to write updates to remote configs through the UI editor, but you can still make and preview changes, then use the export menu to get a copy of the new config, and modify the original source manually.
|
||||
The config file must, of course be accessible from within Dashy. If your config contains sensitive info (like API keys, credentials, secret URLs, etc), take care not to expose it to the internet.
|
||||
|
||||
The following example shows creating a config, publishing it as a [Gist](https://gist.github.com/), copying the URL to the raw file, and using it within your dashboard.
|
||||
|
||||
<p align="center">
|
||||
<img width="700" alt="Public config in a gist demo"
|
||||
src="https://i.ibb.co/55jm3LG/how-to-use-remote-config-sub-page.gif"
|
||||
/>
|
||||
</p>
|
@ -21,6 +21,7 @@
|
||||
- [Backup & Restore](/docs/backup-restore.md) - Guide to backing up config with Dashy's cloud sync feature
|
||||
- [Icons](/docs/icons.md) - Outline of all available icon types for sections and items, with examples
|
||||
- [Language Switching](/docs/multi-language-support.md) - Details on how to switch language, or add a new locale
|
||||
- [Pages and Sections](/docs/pages-and-sections.md) - Multi-page support, sections, items and sub-items
|
||||
- [Status Indicators](/docs/status-indicators.md) - Using Dashy to monitor uptime and status of your apps
|
||||
- [Searching & Shortcuts](/docs/searching.md) - Searching, launching methods + keyboard shortcuts
|
||||
- [Theming](/docs/theming.md) - Complete guide to applying, writing and modifying themes + styles
|
||||
|
@ -8,6 +8,7 @@
|
||||
- [Refused to Connect in Web Content View](#refused-to-connect-in-modal-or-workspace-view)
|
||||
- [404 On Static Hosting](#404-on-static-hosting)
|
||||
- [Yarn Build or Run Error](#yarn-error)
|
||||
- [Remote Config Not Loading](#remote-config-not-loading)
|
||||
- [Auth Validation Error: "should be object"](#auth-validation-error-should-be-object)
|
||||
- [App Not Starting After Update to 2.0.4](#app-not-starting-after-update-to-204)
|
||||
- [Keycloak Redirect Error](#keycloak-redirect-error)
|
||||
@ -102,6 +103,21 @@ Alternatively, as a workaround, you have several options:
|
||||
|
||||
---
|
||||
|
||||
## Remote Config Not Loading
|
||||
|
||||
If you've got a multi-page dashboard, and are hosting the additional config files yourself, then CORS rules will apply. A CORS error will look something like:
|
||||
|
||||
```
|
||||
Access to XMLHttpRequest at 'https://example.com/raw/my-config.yml' from origin 'http://dashy.local' has been blocked by CORS policy:
|
||||
No 'Access-Control-Allow-Origin' header is present on the requested resource.
|
||||
```
|
||||
|
||||
The solution is to add the appropriate headers onto the target server, to allow it to accept requests from the origin where you're running Dashy.
|
||||
|
||||
If it is a remote service, that you do not have admin access to, then another option is to proxy the request. Either host your own, or use a publicly accessible service, like [allorigins.win](https://allorigins.win), e.g: `https://api.allorigins.win/raw?url=https://pastebin.com/raw/4tZpaJV5`. For git-based services specifically, there's [raw.githack.com](https://raw.githack.com/)
|
||||
|
||||
---
|
||||
|
||||
## Auth Validation Error: "should be object"
|
||||
|
||||
In V 1.6.5 an update was made that in the future will become a breaking change. You will need to update you config to reflect this before V 2.0.0 is released. In the meantime, your previous config will continue to function normally, but you will see a validation warning. The change means that the structure of the `appConfig.auth` object is now an object, which has a `users` property.
|
||||
|
Loading…
Reference in New Issue
Block a user