Skip to content

Commit faafa60

Browse files
authored
🔀 Merge pull request #1474 from CrazyWolf13/master
[Docs] Config not saving troubleshooting
2 parents 16e0719 + b05f057 commit faafa60

File tree

2 files changed

+24
-2
lines changed

2 files changed

+24
-2
lines changed

docs/deployment.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,9 @@ If you don't have a home server, then fear not - Dashy can be deployed to pretty
195195

196196
Some hosting providers required a bit of extra configuration, which was why I've made separate branches for deploying to those services (named: [`deploy_cloudflare`](https://github.com/Lissy93/dashy/tree/deploy_cloudflare), [`deploy_digital-ocean`](https://github.com/Lissy93/dashy/tree/deploy_digital-ocean), [`deploy_platform-sh`](https://github.com/Lissy93/dashy/tree/deploy_platform-sh) and [`deploy_render`](https://github.com/Lissy93/dashy/tree/deploy_render)). If there's another cloud service which you'd like 1-click deployment to be supported for, feel free to raise an issue.
197197

198-
**Note** If you use a static hosting provider, then status checks, writing new config changes to disk from the UI, and triggering a rebuild through the UI will not be available. This is because these features need endpoints provided by Dashy's local Node server. Everything else should work just the same though.
198+
> [!NOTE]
199+
> If you use a static hosting provider, then status checks, writing new config changes to disk from the UI, and triggering a rebuild through the UI will not be available. This is because these features need endpoints provided by Dashy's local Node server. Everything else should work just the same though.
200+
199201

200202
### Netlify
201203

docs/troubleshooting.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
88
## Contents
99

10+
- [Config not saving](#config-not-saving)
1011
- [Refused to Connect in Web Content View](#refused-to-connect-in-modal-or-workspace-view)
1112
- [404 On Static Hosting](#404-on-static-hosting)
1213
- [404 from Mobile Home Screen](#404-after-launch-from-mobile-home-screen)
@@ -45,6 +46,25 @@
4546

4647
---
4748

49+
## Config not saving
50+
51+
### Possible Issue 1: Unable to call save endpoint from CDN/static server
52+
If you're running Dashy using a static hosting provider (like Vercel), then there is no Node server, and so the save config action will not work via the UI.
53+
You'll instead need to copy the YAML after making your changes, and paste that into your `conf.yml` directly. If you've connected Vercel to git, then these changes will take effect automatically, once you commit your changes.
54+
Look here for more information: [https://dashy.to/docs/deployment#deploy-to-cloud-service](https://dashy.to/docs/deployment#deploy-to-cloud-service)
55+
56+
If you're running on Netlify, there are some cloud functions which take care of all the server endpoints (like status checking), so these will work as expected.
57+
58+
See also [#1465](https://github.com/Lissy93/dashy/issues/1465)
59+
60+
### Possible Issue 2: Unable to save
61+
In Docker, double check that the file isn't read-only, and that the container actually has permissions to modify it. You shouldn't really be running it as a root user, and I'm not sure if it will work if you do-
62+
63+
### Possible Issue 3: Saved but not updating
64+
After saving, the frontend will recompile, which may take a couple seconds (or a bit longer on a Pi or low-powered device). If it doesn't recompile, you can manually trigger a re-build.
65+
66+
---
67+
4868
## `Refused to Connect` in Modal or Workspace View
4969

5070
This is not an issue with Dashy, but instead caused by the target app preventing direct access through embedded elements.
@@ -538,7 +558,7 @@ export NODE_OPTIONS=--openssl-legacy-provider
538558
```
539559

540560
For more info, see [webpack/webpack#14532](https://github.com/webpack/webpack/issues/14532) and [nodejs/node#40455](https://github.com/nodejs/node/issues/40455).
541-
This occours because [Node 17+](https://medium.com/the-node-js-collection/node-js-17-is-here-8dba1e14e382) no longer supports MD4 as hash function, we're in the process of upgrading Dashy dependencies to all use SHA1 for hashing bundle IDs.
561+
This occurs because [Node 17+](https://medium.com/the-node-js-collection/node-js-17-is-here-8dba1e14e382) no longer supports MD4 as hash function, we're in the process of upgrading Dashy dependencies to all use SHA1 for hashing bundle IDs.
542562

543563
---
544564

0 commit comments

Comments
 (0)