diff --git a/docs/deployment.md b/docs/deployment.md index c3ea7fb1b0..a780808049 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -195,7 +195,9 @@ If you don't have a home server, then fear not - Dashy can be deployed to pretty 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. -**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. +> [!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. + ### Netlify diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 0e87694fb0..82abffb9d3 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -48,15 +48,22 @@ ## Config not saving -Possible Issue 1: Unable to call save endpoint from CDN/static server -If you're running Dashy on a static host, like Vercel, then there's no server-side code to actually save the config. Look here for more information: https://dashy.to/docs/deployment#deploy-to-cloud-service +### Possible Issue 1: Unable to call save endpoint from CDN/static server +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. +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. +Look here for more information: [https://dashy.to/docs/deployment#deploy-to-cloud-service](https://dashy.to/docs/deployment#deploy-to-cloud-service) -Possible Issue 2: Unable to save +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. + +See also [#1465](https://github.com/Lissy93/dashy/issues/1465) + +### Possible Issue 2: Unable to save 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- -Possible Issue 3: Saved but not updating +### Possible Issue 3: Saved but not updating 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. +--- ## `Refused to Connect` in Modal or Workspace View @@ -551,7 +558,7 @@ export NODE_OPTIONS=--openssl-legacy-provider ``` 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). -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. +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. ---