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!

:memo: Re: #149 - Adds X-Frame-Options fix instructions

Alicia Sykesd1177873d6f0
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
index dee14a41..5a376aa2 100644
--- a/docs/troubleshooting.md
+++ b/docs/troubleshooting.md
@@ -2,7 +2,7 @@
This document contains common problems and their solutions.
-### Yarn Error
+## Yarn Error
For more info, see [Issue #1](https://github.com/Lissy93/dashy/issues/1)
@@ -18,3 +18,35 @@ Alternatively, as a workaround, you have several options:
- Try using [NPM](https://www.npmjs.com/get-npm) instead: So clone, cd, then run `npm install`, `npm run build` and `npm start`
- Try using [Docker](https://www.docker.com/get-started) instead, and all of the system setup and dependencies will already be taken care of. So from within the directory, just run `docker build -t lissy93/dashy .` to build, and then use docker start to run the project, e.g: `docker run -it -p 8080:80 lissy93/dashy` (see the [deploying docs](https://github.com/Lissy93/dashy/blob/master/docs/deployment.md#deploy-with-docker) for more info)
+---
+## `Refused to Connect` in Modal or Workspace View
+
+This is not an issue with Dashy, but instead caused by the target app preventing direct access through embedded elements. It can be fixed by setting the [`X-Frame-Options`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) HTTP header set to `ALLOW [path to Dashy]` or `SAMEORIGIN`, as defined in [RFC-7034](https://datatracker.ietf.org/doc/html/rfc7034). These settings are usually set in the config file for the web server that's hosting the target application, here are some examples of how to enable cross-origin access with common web servers:
+
+### NGINX
+In NGINX, you can use the [`add_header`](https://nginx.org/en/docs/http/ngx_http_headers_module.html) module within the app block.
+```
+server {
+ ...
+ add_header X-Frame-Options SAMEORIGIN always;
+}
+```
+Then reload with `service nginx reload`
+
+### Caddy
+
+In Caddy, you can use the [`header`](https://caddyserver.com/docs/caddyfile/directives/header) directive.
+
+```yaml
+header {
+ X-Frame-Options SAMEORIGIN
+}
+```
+
+### Apache
+
+In Apache, you can use the [`mod_headers`](https://httpd.apache.org/docs/current/mod/mod_headers.html) module to set the `X-Frame-Options` in your config file. This file is usually located somewhere like `/etc/apache2/httpd.conf
+
+```
+Header set X-Frame-Options: "ALLOW-FROM http://[dashy-location]/"
+```