Files
truecharts/charts/stable/nextcloud/docs/installation-notes.md
kqmaverick 286b2fe716 docs(nextcloud): snapshot directory visibility warning (#10408)
**Description**
Add warning about having snapshot directory set to visible.

⚒️ Fixes  #

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code

**🧪 How Has This Been Tested?**


**📃 Notes:**

**✔️ Checklist:**

- [ ] ⚖️ My code follows the style guidelines of this project
- [ ] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 I have made corresponding changes to the documentation
- [ ] ⚠️ My changes generate no new warnings
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [ ] ⬆️ I increased versions for any altered app according to semantic
versioning

** App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🪞 I have opened a PR on
[truecharts/containers](https://github.com/truecharts/containers) adding
the container to TrueCharts mirror repo.
- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._

Co-authored-by: StevenMcElligott <89483932+StevenMcElligott@users.noreply.github.com>
2023-07-14 10:46:18 +02:00

2.4 KiB

Installation Notes

Prerequisites

  1. The cloudnative-pg operator is required from the operator train. More information can be found on our getting started guide.
  2. While nextcloud can run without ingress setup a lot of features will not work. More information can be found on our getting started guide.

:::caution SNAPSHOT DIRECTORY VISIBILITY

Nextcloud installation will fail if the application or user data datasets have Snapshot Directory set to Visible (Invisible by default). Return this setting to default prior to installation.

:::

User Data Permissions

If you plan to use HostPath or NFS to store user data then the permissions for the dataset will need to be set as shown below.

userdata-perms

Nextcloud Configurations

Required

The following configurations must be set during initially setup for nextcloud to deploy.

  1. Initial Admin Username
  2. Initial Admin Password
  3. Default Phone Region (if you are unsure about your region, you can find your code for your region in this wiki)

Optional Addons

  1. Notify Push (Allows Nextcloud to notify clients of changes, instead of clients having to poll. A Notify Push container will be deployed automatically). This is highly recommended to keep enabled.
  2. ClamAV (Anti-virus for nextcloud, keep in mind that only scans files that Nextcloud posts to it's endpoint. A Clam AV container will be deployed automatically.
  3. Collabora (Document editor for Nextcloud. A Collabora container will be deployed automatically.
  4. Only Office (document editor for Nextcloud, this does NOT deploy the Only Office container. You will need to have a separate installation.

Networking and Services

If you are setting up Ingress (highly recommended and the only method supported) then change the Service Type to ClusterIP from LoadBalancer. Nextcloud will not work with Ingress configured unless ClusterIP is set.

Storage

You can change the User Data Storage option to your preference here if you previously setup the proper dataset permissions. All other Storage should remain the default of PVC.