diff options
author | Pierre <397503+bemble@users.noreply.github.com> | 2022-05-30 17:04:41 +0200 |
---|---|---|
committer | Pierre <397503+bemble@users.noreply.github.com> | 2022-05-30 17:04:41 +0200 |
commit | 95249e11255beb8b85f904c54429b353fca40b9e (patch) | |
tree | 76ef918402dbdc39bd4ea00eaa1b933c59b72b6a | |
parent | 132e9a0df516b50c854178ccb726cf9d9dc514fa (diff) | |
download | homer-95249e11255beb8b85f904c54429b353fca40b9e.tar.gz homer-95249e11255beb8b85f904c54429b353fca40b9e.tar.zst homer-95249e11255beb8b85f904c54429b353fca40b9e.zip |
doc(auth): add auth proxy documentation
-rw-r--r-- | docs/configuration.md | 3 | ||||
-rw-r--r-- | docs/troubleshooting.md | 6 |
2 files changed, 8 insertions, 1 deletions
diff --git a/docs/configuration.md b/docs/configuration.md index 84a7ea7..c240077 100644 --- a/docs/configuration.md +++ b/docs/configuration.md | |||
@@ -25,7 +25,8 @@ header: true # Set to false to hide the header | |||
25 | footer: '<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. | 25 | footer: '<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 | ||
27 | columns: "3" # "auto" or number (must be a factor of 12: 1, 2, 3, 4, 6, 12) | 27 | columns: "3" # "auto" or number (must be a factor of 12: 1, 2, 3, 4, 6, 12) |
28 | connectivityCheck: true # whether you want to display a message when the apps are not accessible anymore (VPN disconnected for example) | 28 | connectivityCheck: 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 |
31 | proxy: | 32 | proxy: |
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 | |||
23 | This 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. | ||