From b42e09f86d52304b3d072c1b57c4468c6eb81bfc Mon Sep 17 00:00:00 2001
From: Janek <xerusx@pm.me>
Date: Thu, 16 Feb 2023 18:21:28 +0000
Subject: [PATCH] Amend some infos in README.md
- update upstream link
- note on postStart
- follow https://sembr.org/ roughly
---
README.md | 54 +++++++++++++++++++++++++++++++-----------------------
1 file changed, 31 insertions(+), 23 deletions(-)
diff --git a/README.md b/README.md
index f339d8e8..17e5091e 100644
--- a/README.md
+++ b/README.md
@@ -3,20 +3,22 @@
This helm chart installs Nextcloud and ONLYOFFICE
and configures Nextcloud to use ONLYOFFICE as its document editor.
Depends on the
-[Nextcloud](https://github.com/helm/charts/tree/master/stable/nextcloud)
-`@stable` chart. For configuration details on Nextcloud, refer to their
-documentation.
+[Nextcloud](https://github.com/nextcloud/helm/tree/master/charts/nextcloud)
+chart.
+For configuration details on Nextcloud, refer to their documentation.
-Parts of this chart are based on a copy of the [COLLABORA code helm
-chart](https://github.com/helm/charts/tree/master/stable/collabora-code)
+Parts of this chart are based on a copy of the
+[COLLABORA code helm chart](https://github.com/helm/charts/tree/master/stable/collabora-code)
## Installation
**NOTE:** The `onlyoffice.server_name` variable needs to be
overwritten with a URL that points to your onlyoffice for this to work
-correctly. See `values-local.yaml.example` for an example of domain
-configurations you might want to do. These instructions assume you copy
-`values-local.yaml.example` to `values-local.yaml` and edit it.
+correctly.
+See `values-local.yaml.example` for an example of domain configurations
+you might want to do.
+These instructions assume you copy `values-local.yaml.example` to `values-local.yaml`
+and edit it.
**NOTE:** It is very important that you uncomment and set the following password and
secrets variables manually when you run helm install:
@@ -84,21 +86,23 @@ This chart adds a "postStart" command to the Nextcloud pod, that installs apps
(see below) and applies a custom configuration to set up those apps and
integration with ONLYOFFICE as well as the Stackspin OIDC provider.
-Kubernetes postStart commands do not log to the pod log. Instead, the script
-creates its own log in `/var/www/tmp/postStart<date>.log`. This means that
-even if you can't `exec` into the pod (because something is failing), you can
-see the logs inside the `data` folder in the PVC. Often, if the `postStart`
-command fails, you can also see the problem by running `kubectl describe pod
-<nextcloud pod>`.
+Kubernetes postStart commands do not log to the pod log.
+Instead, the script creates its own log in `/var/www/tmp/postStart<date>.log`.
+This means that even if you can't `exec` into the pod (because something is failing),
+you can see the logs inside the `data` folder in the PVC.
+Often, if the `postStart` command fails,
+you can also see the problem by running `kubectl describe pod <nextcloud pod>`.
## Apps
The Nextcloud app store allows admin users to install applications, many of
-which have not undergone security testing. For that reason we disabled
-downloading new apps via the app store. As the person installing Nextcloud it is
-possible to specify which applications from the app store are available for
-installation. It is also possible to enable them by default. Apps that are not
-enabled by default can be enabled through the Apps screen in Nextcloud.
+which have not undergone security testing.
+For that reason we disabled downloading new apps via the app store.
+Upon installing Nextcloud it is possible to specify
+which applications from the app store are available.
+It is also possible to enable them by default.
+Apps that are not enabled by default can be enabled by admins
+through the Apps screen in Nextcloud.
Apps that are installed this way are automatically updated to their newest
version every time Nextcloud is updated.
@@ -111,10 +115,14 @@ apps:
enabled: false # Disables sociallogin by default
```
-Additionally, we have added an option to install Apps immediately from GitHub
-releases. The benefit of this, compared to installing them with `occ`, is that
-we can pin the versions to specific GitHub releases. To install an app from
-GitHub releases:
+Note that manually enabled apps will not be disabled upon rerunning the installer,
+which can lead to incompatibility errors upon Nextcloud Server version upgrades.
+Check for `postStart` errors as mentioned above.
+
+Additionally, we have added an option to install Apps immediately from GitHub releases.
+Unlike when installing them with `occ`,
+this allows us to pin the versions to specific GitHub releases.
+To install an app from GitHub releases:
```yaml
apps:
--
GitLab