From b814a51d0b8a89f204e5e7af8da10774159d7526 Mon Sep 17 00:00:00 2001 From: sunjam Date: Sun, 27 Oct 2024 07:43:10 -0700 Subject: [PATCH] Update readme.md local documentation (#5473) Adding more wording to local description to clarify it relates to having "no domain" and other keywords/phrases users must be missing, because so many people are confused about this. Signed-off-by: sunjam Signed-off-by: Simon L. Co-authored-by: Simon L. --- local-instance.md | 2 +- readme.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/local-instance.md b/local-instance.md index a03f8903f55..abd990596a6 100644 --- a/local-instance.md +++ b/local-instance.md @@ -1,5 +1,5 @@ # Local instance -It is possible due to several reasons that you do not want or cannot open Nextcloud to the public internet. However AIO requires a valid certificate to work correctly. Below is discussed how you can achieve both: Having a valid certificate for Nextcloud and only using it locally. +It is possible due to several reasons that you do not want or cannot open Nextcloud to the public internet. Perhaps you were hoping to access AIO directly from an `ip.add.r.ess` (unsupported) or without a valid domain. However, AIO requires a valid certificate to work correctly. Below is discussed how you can achieve both: Having a valid certificate for Nextcloud and only using it locally. ### Content - [1. The recommended way](#1-the-recommended-way) diff --git a/readme.md b/readme.md index 913f18e22d0..928319314b0 100644 --- a/readme.md +++ b/readme.md @@ -261,8 +261,11 @@ In general recommended VPS are those that are KVM/non-virtualized as Docker shou ### How to get Nextcloud running using the ACME DNS-challenge? You can install AIO in reverse proxy mode where is also documented how to get it running using the ACME DNS-challenge for getting a valid certificate for AIO. See the [reverse proxy documentation](./reverse-proxy.md). (Meant is the `Caddy with ACME DNS-challenge` section). Also see https://github.com/dani-garcia/vaultwarden/wiki/Running-a-private-vaultwarden-instance-with-Let%27s-Encrypt-certs#getting-a-custom-caddy-build for additional docs on this topic. -### How to run Nextcloud locally? -If you do not want to open Nextcloud to the public internet, you may have a look at the following documentation how to set it up locally: [local-instance.md](./local-instance.md) +### How to run Nextcloud locally? No domain wanted, or wanting intranet access within your LAN. +If you do not want to open Nextcloud to the public internet, you may have a look at the following documentation on how to set it up locally: [local-instance.md](./local-instance.md), but keep in mind you're still required to have https working properly. + +### Can I use an ip-address for Nextcloud instead of a domain? +No and it will not be added. If you only want to run it locally, you may have a look at the following documentation: [local-instance.md](./local-instance.md) for configuration without a traditional domain. Or, [consider using NextcloudPi](nextcloudpi.com) for ip-address access locally (it bundles fewer features than AIO). ### Can I run AIO offline or in an airgapped system? No. This is not possible and will not be added due to multiple reasons: update checks, app installs via app-store, downloading additional docker images on demand and more. @@ -270,9 +273,6 @@ No. This is not possible and will not be added due to multiple reasons: update c ### Are self-signed certificates supported for Nextcloud? No and they will not be. If you want to run it locally, without opening Nextcloud to the public internet, please have a look at the [local instance documentation](./local-instance.md). -### Can I use an ip-address for Nextcloud instead of a domain? -No and it will not be added. If you only want to run it locally, you may have a look at the following documentation: [local-instance.md](./local-instance.md) - ### Can I use AIO with multiple domains? No and it will not be added. However you can use [this feature](https://github.com/nextcloud/all-in-one/blob/main/multiple-instances.md) in order to create multiple AIO instances, one for each domain.