You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**Spin up your own demo**: [](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml)
35
+
> For more examples of Dashy in action, see: [**The Showcase**](./docs/showcase.md)
@@ -204,7 +213,7 @@ Dashy has an optional feature that can display a small icon next to each of your
204
213
By default, this feature is off, but you can enable it globally by setting `appConfig.statusCheck: true`, or enable/ disable it for an individual item, with `item[n].statusCheck`. You can also specify an time interval in seconds under `appConfig.statusCheckInterval`, which will determine how often to recheck services, if this value is `0`, then status is only checked on initial page load, this is default behavior.
From the Settings Menu in Dashy, you can download, backup, edit and rest your config. An interactive editor makes editing the config file easy, it will tell you if you've got any errors. After making your changes, you can either apply them locally, or export into your main config file. After saving to the config file to the disk, the app will need to be rebuilt. This will happen automatically, but may take a few minutes. You can also manually trigger a rebuild from the Settings Menu. A full list of available config options can be found [here](./docs/configuring.md). It's recommend to make a backup of your configuration, as you can then restore it into a new instance of Dashy, without having to set it up again.
There are a few self-hosted web apps, that serve a similar purpose to Dashy. If you're looking for a dashboard, and Dashy doesn't meet your needs, I highly recommend you check these projects out! Including, but not limited to: [HomeDash2](https://lamarios.github.io/Homedash2), [Homer](https://github.com/bastienwirtz/homer) (`Apache License 2.0`), [Organizr](https://organizr.app/) (`GPL-3.0 License`) and [Heimdall](https://github.com/linuxserver/Heimdall) (`MIT License`)
381
+
There are a few self-hosted web apps, that serve a similar purpose to Dashy. If you're looking for a dashboard, and Dashy doesn't meet your needs, I highly recommend you check these projects out!
Copy file name to clipboardExpand all lines: docs/configuring.md
+13-13
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
##Configuring
1
+
# Configuring
2
2
3
3
All app configuration is specified in [`/public/conf.yml`](https://github.com/Lissy93/dashy/blob/master/public/conf.yml) which is in [YAML Format](https://yaml.org/) format.
4
4
@@ -11,17 +11,17 @@ There's a couple of things to remember, before getting started:
11
11
- You can check that your config file fits the schema, by running `yarn validate-config`
12
12
- Any which are only saved locally through the UI need to be exported into this file, in order for them to persist across devices
13
13
14
-
####Config Saving Methods
14
+
### Config Saving Methods
15
15
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 to 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.
16
16
17
-
####Preventing Changes being Written to Disk
17
+
### Preventing Changes being Written to Disk
18
18
To disallow any changes from being written to disk, then set `appConfig.allowConfigEdit: false`. If you are using users, and have setup `auth` within Dashy, then only users with `type: admin` will be able to write config changes to disk.
19
19
20
20
It is recommended to make a backup of your config file.
**`icon`** | `string` | _Optional_ | The icon for a given item or section. Can be a font-awesome icon, favicon, remote URL or local URL. If set to `favicon`, the icon will be automatically fetched from the items website URL. To use font-awesome, specify the category, followed by the icon name, e.g. `fas fa-rocket`, `fab fa-monero` or `fal fa-duck` - note that to use pro icons, you mut specify `appConfig.fontAwesomeKey`. If set to `generative`, then a unique icon is generated from the apps URL or IP. You can also use hosted any by specifying it's URL, e.g. `https://i.ibb.co/710B3Yc/space-invader-x256.png`. To use a local image, first store it in `./public/item-icons/` (or `-v /app/public/item-icons/` in Docker) , and reference it by name and extension - e.g. set `image.png` to use `./public/item-icon/image.png`, you can also use sub-folders if you have a lot of icons, to keep them organised.
- A single high-quality screenshot of your Dashboard
44
+
- A short title (it doesn't have to be particularly imaginative)
45
+
- An optional description, you could include details on anything interesting or unique about your dashboard, or say how you use it, and why it's awesome
46
+
- Optionally leave your name or username, with a link to your GitHub, Twitter or Website
47
+
48
+
#### Template
49
+
50
+
If you're submitting a pull request, please use a format similar to this:
51
+
52
+
```
53
+
### [Dashboard Name] (required)
54
+
55
+
> Submitted by [@username](https://github.com/user) (optional)
0 commit comments