From 8fae9b669f485157c23de1bc5e0e073f26d3707a Mon Sep 17 00:00:00 2001 From: "Simon L." Date: Fri, 18 Oct 2024 16:22:51 +0200 Subject: [PATCH 1/2] rp-docs: add links to examples direclty to each rp section Signed-off-by: Simon L. --- local-instance.md | 2 +- reverse-proxy.md | 14 +++++++++++--- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/local-instance.md b/local-instance.md index ac0b9fb4..f2471877 100644 --- a/local-instance.md +++ b/local-instance.md @@ -9,7 +9,7 @@ The recommended way is the following: 1. Enter the ip-address of your local dns-server in the daemon.json file for docker so that you are sure that all docker containers use the correct local dns-server. 1. Now, entering the domain in the AIO-interface should work as expected and should allow you to continue with the setup -Here is a video that does shows this a bit more in detail: https://youtu.be/zk-y2wVkY4c +**Hint:** You may have a look at [this video](https://youtu.be/zk-y2wVkY4c) for a more complete but possibly outdated example. ## 2. Use the ACME DNS-challenge You can alternatively use the ACME DNS-challenge to get a valid certificate for Nextcloud. Here is described how to set it up: https://github.com/nextcloud/all-in-one#how-to-get-nextcloud-running-using-the-acme-dns-challenge diff --git a/reverse-proxy.md b/reverse-proxy.md index 205d7892..98ff5545 100644 --- a/reverse-proxy.md +++ b/reverse-proxy.md @@ -145,6 +145,8 @@ To make the config work you can run the following command: click here to expand +**Hint:** You may have a look at [this guide](https://github.com/nextcloud/all-in-one/discussions/575#discussion-4055615) for a more complete but possibly outdated example. + Add this to your Caddyfile: ``` @@ -204,6 +206,9 @@ For a reverse proxy example guide for Citrix ADC VPX / Citrix Netscaler, see thi click here to expand + +**Hint:** You may have a look at [this guide](https://github.com/nextcloud/all-in-one/discussions/2845#discussioncomment-6423237) for a more complete but possibly outdated example. + Although it does not seem like it is the case but from AIO perspective a Cloudflare Tunnel works like a reverse proxy. Please see the [caveats](https://github.com/nextcloud/all-in-one#notes-on-cloudflare-proxytunnel) before proceeding. Here is then how to make it work: 1. Install the Cloudflare Tunnel on the same machine where AIO will be running on and point the Tunnel with the domain that you want to use for AIO to `http://localhost:11000`.
@@ -317,6 +322,8 @@ backend Nextcloud click here to expand +**Hint:** You may have a look at [this guide](https://github.com/nextcloud/all-in-one/discussions/588#discussioncomment-2811152) for a more complete but possibly outdated example. + **Disclaimer:** This config was tested and should normally work on all modern Nginx versions. Improvements to the config are very welcome! Add the below template to your Nginx config. @@ -401,8 +408,6 @@ server { ⚠️ **Please note:** look into [this](#adapting-the-sample-web-server-configurations-below) to adapt the above example configuration. -**Advice:** You may have a look at [this](https://github.com/nextcloud/all-in-one/discussions/588#discussioncomment-2811152) for a more complete example. - ### Nginx-Proxy-Manager - NPM @@ -411,6 +416,8 @@ server { click here to expand +**Hint:** You may have a look at [this guide](https://github.com/nextcloud/all-in-one/discussions/588#discussioncomment-3040493) for a more complete but possibly oudated example. + First, make sure the environmental variables `PUID` and `PGID` in the `compose.yaml` file for NPM are either unset or set to `0`. If you need to change the GID/PID then please add `net.ipv4.ip_unprivileged_port_start=0` at the end of `/etc/sysctl.conf`. Note: this will cause that non root users can bind privileged ports. @@ -560,6 +567,8 @@ See these screenshots for a working config: click here to expand +**Hint:** You may have a look at [this video](https://www.youtube.com/watch?v=VLPSRrLMDmA) for a more complete but possibly outdated example. + **Disclaimer:** it might be possible that the config below is not working 100% correctly, yet. Improvements to it are very welcome! Traefik's building blocks (router, service, middlewares) need to be defined using dynamic configuration similar to [this](https://doc.traefik.io/traefik/providers/file/#configuration-examples) official Traefik configuration example. Using **docker labels _won't work_** because of the nature of the project. @@ -638,7 +647,6 @@ The examples below define the dynamic configuration in YAML files. If you rather --- ⚠️ **Please note:** look into [this](#adapting-the-sample-web-server-configurations-below) to adapt the above example configuration. -**Hint**: see https://www.youtube.com/watch?v=VLPSRrLMDmA for a video on configuring Traefik. From 5b4edc2c344c623b1a5c718b1d8142a474448e18 Mon Sep 17 00:00:00 2001 From: "Simon L." Date: Mon, 21 Oct 2024 10:01:02 +0200 Subject: [PATCH 2/2] address review Signed-off-by: Simon L. --- local-instance.md | 3 ++- reverse-proxy.md | 15 ++++++++++----- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/local-instance.md b/local-instance.md index f2471877..28ef78ee 100644 --- a/local-instance.md +++ b/local-instance.md @@ -9,7 +9,8 @@ The recommended way is the following: 1. Enter the ip-address of your local dns-server in the daemon.json file for docker so that you are sure that all docker containers use the correct local dns-server. 1. Now, entering the domain in the AIO-interface should work as expected and should allow you to continue with the setup -**Hint:** You may have a look at [this video](https://youtu.be/zk-y2wVkY4c) for a more complete but possibly outdated example. +> [!TIP] +> You may have a look at [this video](https://youtu.be/zk-y2wVkY4c) for a more complete but possibly outdated example. ## 2. Use the ACME DNS-challenge You can alternatively use the ACME DNS-challenge to get a valid certificate for Nextcloud. Here is described how to set it up: https://github.com/nextcloud/all-in-one#how-to-get-nextcloud-running-using-the-acme-dns-challenge diff --git a/reverse-proxy.md b/reverse-proxy.md index 98ff5545..3c2f6134 100644 --- a/reverse-proxy.md +++ b/reverse-proxy.md @@ -145,7 +145,8 @@ To make the config work you can run the following command: click here to expand -**Hint:** You may have a look at [this guide](https://github.com/nextcloud/all-in-one/discussions/575#discussion-4055615) for a more complete but possibly outdated example. +> [!TIP] +> You may have a look at [this guide](https://github.com/nextcloud/all-in-one/discussions/575#discussion-4055615) for a more complete but possibly outdated example. Add this to your Caddyfile: @@ -207,7 +208,8 @@ For a reverse proxy example guide for Citrix ADC VPX / Citrix Netscaler, see thi click here to expand -**Hint:** You may have a look at [this guide](https://github.com/nextcloud/all-in-one/discussions/2845#discussioncomment-6423237) for a more complete but possibly outdated example. +> [!TIP] +> You may have a look at [this guide](https://github.com/nextcloud/all-in-one/discussions/2845#discussioncomment-6423237) for a more complete but possibly outdated example. Although it does not seem like it is the case but from AIO perspective a Cloudflare Tunnel works like a reverse proxy. Please see the [caveats](https://github.com/nextcloud/all-in-one#notes-on-cloudflare-proxytunnel) before proceeding. Here is then how to make it work: @@ -322,7 +324,8 @@ backend Nextcloud click here to expand -**Hint:** You may have a look at [this guide](https://github.com/nextcloud/all-in-one/discussions/588#discussioncomment-2811152) for a more complete but possibly outdated example. +> [!TIP] +> You may have a look at [this guide](https://github.com/nextcloud/all-in-one/discussions/588#discussioncomment-2811152) for a more complete but possibly outdated example. **Disclaimer:** This config was tested and should normally work on all modern Nginx versions. Improvements to the config are very welcome! @@ -416,7 +419,8 @@ server { click here to expand -**Hint:** You may have a look at [this guide](https://github.com/nextcloud/all-in-one/discussions/588#discussioncomment-3040493) for a more complete but possibly oudated example. +> [!TIP] +> You may have a look at [this guide](https://github.com/nextcloud/all-in-one/discussions/588#discussioncomment-3040493) for a more complete but possibly oudated example. First, make sure the environmental variables `PUID` and `PGID` in the `compose.yaml` file for NPM are either unset or set to `0`. If you need to change the GID/PID then please add `net.ipv4.ip_unprivileged_port_start=0` at the end of `/etc/sysctl.conf`. Note: this will cause that non root users can bind privileged ports. @@ -567,7 +571,8 @@ See these screenshots for a working config: click here to expand -**Hint:** You may have a look at [this video](https://www.youtube.com/watch?v=VLPSRrLMDmA) for a more complete but possibly outdated example. +> [!TIP] +> You may have a look at [this video](https://www.youtube.com/watch?v=VLPSRrLMDmA) for a more complete but possibly outdated example. **Disclaimer:** it might be possible that the config below is not working 100% correctly, yet. Improvements to it are very welcome!