aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorBastien Wirtz <bastien.wirtz@gmail.com>2022-06-04 09:07:15 +0200
committerGitHub <noreply@github.com>2022-06-04 09:07:15 +0200
commit2b48d1c057bf24776fb0538c7db0a0b156e667c5 (patch)
tree47a6b64226c3d3707b285a6de3838a2d7270b59f /docs
parent95d73348e5dd8fd0fbb1b6747c58b346ecf772ad (diff)
parent95249e11255beb8b85f904c54429b353fca40b9e (diff)
downloadhomer-2b48d1c057bf24776fb0538c7db0a0b156e667c5.tar.gz
homer-2b48d1c057bf24776fb0538c7db0a0b156e667c5.tar.zst
homer-2b48d1c057bf24776fb0538c7db0a0b156e667c5.zip
Merge pull request #448 from bemble/main
feat(pwa): enhance connectivity checks
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md3
-rw-r--r--docs/troubleshooting.md6
2 files changed, 8 insertions, 1 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index bb41948..a4da08b 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -25,7 +25,8 @@ header: true # Set to false to hide the header
25footer: '<p>Created with <span class="has-text-danger">❤️</span> with <a href="https://bulma.io/">bulma</a>, <a href="https://vuejs.org/">vuejs</a> & <a href="https://fontawesome.com/">font awesome</a> // Fork me on <a href="https://github.com/bastienwirtz/homer"><i class="fab fa-github-alt"></i></a></p>' # set false if you want to hide it. 25footer: '<p>Created with <span class="has-text-danger">❤️</span> with <a href="https://bulma.io/">bulma</a>, <a href="https://vuejs.org/">vuejs</a> & <a href="https://fontawesome.com/">font awesome</a> // Fork me on <a href="https://github.com/bastienwirtz/homer"><i class="fab fa-github-alt"></i></a></p>' # set false if you want to hide it.
26 26
27columns: "3" # "auto" or number (must be a factor of 12: 1, 2, 3, 4, 6, 12) 27columns: "3" # "auto" or number (must be a factor of 12: 1, 2, 3, 4, 6, 12)
28connectivityCheck: true # whether you want to display a message when the apps are not accessible anymore (VPN disconnected for example) 28connectivityCheck: true # whether you want to display a message when the apps are not accessible anymore (VPN disconnected for example).
29 # You should set it to true when using an authentication proxy, it also reloads the page when a redirection is detected when checking connectivity.
29 30
30# Optional: Proxy / hosting option 31# Optional: Proxy / hosting option
31proxy: 32proxy:
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
index 649e5a6..10d6c2d 100644
--- a/docs/troubleshooting.md
+++ b/docs/troubleshooting.md
@@ -17,3 +17,9 @@ To resolve this, you can either:
17* Host all your target service under the same domain & port. 17* Host all your target service under the same domain & port.
18* Modify the target server configuration so that the response of the server included following header- `Access-Control-Allow-Origin: *` (<https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#simple_requests>). It might be an option in the targeted service, otherwise depending on how the service is hosted, the proxy or web server can seamlessly add it. 18* Modify the target server configuration so that the response of the server included following header- `Access-Control-Allow-Origin: *` (<https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#simple_requests>). It might be an option in the targeted service, otherwise depending on how the service is hosted, the proxy or web server can seamlessly add it.
19* Use a cors proxy server like [`cors-container`](https://github.com/imjacobclark/cors-container), [`cors-anywhere`](https://github.com/Rob--W/cors-anywhere) or many others. 19* Use a cors proxy server like [`cors-container`](https://github.com/imjacobclark/cors-container), [`cors-anywhere`](https://github.com/Rob--W/cors-anywhere) or many others.
20
21## I am using an authentication proxy and homer says I am offline
22
23This should be a configuration issue.
24* Make sure the option `connectivityCheck` is set to `true` in configuration.
25* Check your proxy configuration, the expected behavior is to redirect user using a 302 to the login page when user is not authenticated.