Merge pull request #6004 from nextcloud/enh/noid/add-toc

readme: add TOC
This commit is contained in:
Simon L. 2025-02-04 17:22:52 +01:00 committed by GitHub
commit d0374e4b47
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -138,6 +138,100 @@ If your firewall/router has port 80 and 8443 open/forwarded and you point a doma
5. Please do not forget to open port `3478/TCP` and `3478/UDP` in your firewall/router for the Talk container! 5. Please do not forget to open port `3478/TCP` and `3478/UDP` in your firewall/router for the Talk container!
## FAQ ## FAQ
- [Where can I find additional documentation?](#where-can-i-find-additional-documentation)
- [How does it work?](#how-does-it-work)
- [How to contribute?](#how-to-contribute)
- [How many users are possible?](#how-many-users-are-possible)
- [Are reverse proxies supported?](#are-reverse-proxies-supported)
- [Which CPU architectures are supported?](#which-cpu-architectures-are-supported)
- [Which ports are mandatory to be open in your firewall/router?](#which-ports-are-mandatory-to-be-open-in-your-firewallrouter)
- [Explanation of used ports:](#explanation-of-used-ports)
- [How to run AIO on macOS?](#how-to-run-aio-on-macos)
- [How to run AIO on Windows?](#how-to-run-aio-on-windows)
- [How to run AIO on Synology DSM](#how-to-run-aio-on-synology-dsm)
- [How to run AIO with Portainer?](#how-to-run-aio-with-portainer)
- [Can I run AIO on TrueNAS SCALE?](#can-i-run-aio-on-truenas-scale)
- [Notes on Cloudflare (proxy/tunnel)](#notes-on-cloudflare-proxytunnel)
- [How to run Nextcloud behind a Cloudflare Tunnel?](#how-to-run-nextcloud-behind-a-cloudflare-tunnel)
- [How to run Nextcloud via Tailscale?](#how-to-run-nextcloud-via-tailscale)
- [Disrecommended VPS providers](#disrecommended-vps-providers)
- [Recommended VPS](#recommended-vps)
- [Note on storage options](#note-on-storage-options)
- [How to get Nextcloud running using the ACME DNS-challenge?](#how-to-get-nextcloud-running-using-the-acme-dns-challenge)
- [How to run Nextcloud locally? No domain wanted, or wanting intranet access within your LAN.](#how-to-run-nextcloud-locally-no-domain-wanted-or-wanting-intranet-access-within-your-lan)
- [Can I use an ip-address for Nextcloud instead of a domain?](#can-i-use-an-ip-address-for-nextcloud-instead-of-a-domain)
- [Can I run AIO offline or in an airgapped system?](#can-i-run-aio-offline-or-in-an-airgapped-system)
- [Are self-signed certificates supported for Nextcloud?](#are-self-signed-certificates-supported-for-nextcloud)
- [Can I use AIO with multiple domains?](#can-i-use-aio-with-multiple-domains)
- [Are other ports than the default 443 for Nextcloud supported?](#are-other-ports-than-the-default-443-for-nextcloud-supported)
- [Can I run Nextcloud in a subdirectory on my domain?](#can-i-run-nextcloud-in-a-subdirectory-on-my-domain)
- [How can I access Nextcloud locally?](#how-can-i-access-nextcloud-locally)
- [How to skip the domain validation?](#how-to-skip-the-domain-validation)
- [How to resolve firewall problems with Fedora Linux, RHEL OS, CentOS, SUSE Linux and others?](#how-to-resolve-firewall-problems-with-fedora-linux-rhel-os-centos-suse-linux-and-others)
- [Are there known problems when SELinux is enabled?](#are-there-known-problems-when-selinux-is-enabled)
- [How to run `occ` commands?](#how-to-run-occ-commands)
- [How to resolve `Security & setup warnings displays the "missing default phone region" after initial install`?](#how-to-resolve-security--setup-warnings-displays-the-missing-default-phone-region-after-initial-install)
- [How to run multiple AIO instances on one server?](#how-to-run-multiple-aio-instances-on-one-server)
- [Bruteforce protection FAQ](#bruteforce-protection-faq)
- [Update policy](#update-policy)
- [How to switch the channel?](#how-to-switch-the-channel)
- [How to update the containers?](#how-to-update-the-containers)
- [How often are update notifications sent?](#how-often-are-update-notifications-sent)
- [How to easily log in to the AIO interface?](#how-to-easily-log-in-to-the-aio-interface)
- [How to change the domain?](#how-to-change-the-domain)
- [How to properly reset the instance?](#how-to-properly-reset-the-instance)
- [Backup solution](#backup-solution)
- [What is getting backed up by AIO's backup solution?](#what-is-getting-backed-up-by-aios-backup-solution)
- [How to adjust borgs retention policy?](#how-to-adjust-borgs-retention-policy)
- [How to migrate from AIO to AIO?](#how-to-migrate-from-aio-to-aio)
- [Are remote borg backups supported?](#are-remote-borg-backups-supported)
- [Failure of the backup container in LXC containers](#failure-of-the-backup-container-in-lxc-containers)
- [How to create the backup volume on Windows?](#how-to-create-the-backup-volume-on-windows)
- [Pro-tip: Backup archives access](#pro-tip-backup-archives-access)
- [Delete backup archives manually](#delete-backup-archives-manually)
- [Sync local backups regularly to another drive](#sync-local-backups-regularly-to-another-drive)
- [How to stop/start/update containers or trigger the daily backup from a script externally?](#how-to-stopstartupdate-containers-or-trigger-the-daily-backup-from-a-script-externally)
- [How to disable the backup section?](#how-to-disable-the-backup-section)
- [How to change the default location of Nextcloud's Datadir?](#how-to-change-the-default-location-of-nextclouds-datadir)
- [Can I use a CIFS/SMB share as Nextcloud's datadir?](#can-i-use-a-cifssmb-share-as-nextclouds-datadir)
- [How to allow the Nextcloud container to access directories on the host?](#how-to-allow-the-nextcloud-container-to-access-directories-on-the-host)
- [How to adjust the Talk port?](#how-to-adjust-the-talk-port)
- [How to adjust the upload limit for Nextcloud?](#how-to-adjust-the-upload-limit-for-nextcloud)
- [How to adjust the max execution time for Nextcloud?](#how-to-adjust-the-max-execution-time-for-nextcloud)
- [How to adjust the PHP memory limit for Nextcloud?](#how-to-adjust-the-php-memory-limit-for-nextcloud)
- [What can I do to fix the internal or reserved ip-address error?](#what-can-i-do-to-fix-the-internal-or-reserved-ip-address-error)
- [Can I run this with Docker swarm?](#can-i-run-this-with-docker-swarm)
- [Can I run this with Kubernetes?](#can-i-run-this-with-kubernetes)
- [How to run this with Docker rootless?](#can-i-run-this-with-podman-instead-of-docker)
- [How to change the Nextcloud apps that are installed on the first startup?](#how-to-change-the-nextcloud-apps-that-are-installed-on-the-first-startup)
- [How to add OS packages permanently to the Nextcloud container?](#how-to-add-os-packages-permanently-to-the-nextcloud-container)
- [How to add PHP extensions permanently to the Nextcloud container?](#how-to-add-php-extensions-permanently-to-the-nextcloud-container)
- [What about the pdlib PHP extension for the facerecognition app?](#what-about-the-pdlib-php-extension-for-the-facerecognition-app)
- [How to enable hardware acceleration for Nextcloud?](#how-to-enable-hardware-acceleration-for-nextcloud)
- [With open source drivers MESA for AMD, Intel and **new** drivers `Nouveau` for Nvidia](#with-open-source-drivers-mesa-for-amd-intel-and-new-drivers-nouveau-for-nvidia)
- [With proprietary drivers for Nvidia :warning: BETA](#with-proprietary-drivers-for-nvidia-warning-beta)
- [How to keep disabled apps?](#how-to-keep-disabled-apps)
- [Huge docker logs](#huge-docker-logs)
- [Access/Edit Nextcloud files/folders manually](#accessedit-nextcloud-filesfolders-manually)
- [How to store the files/installation on a separate drive?](#how-to-store-the-filesinstallation-on-a-separate-drive)
- [How to edit Nextclouds config.php file with a texteditor?](#how-to-edit-nextclouds-configphp-file-with-a-texteditor)
- [How to change default files by creating a custom skeleton directory?](#how-to-change-default-files-by-creating-a-custom-skeleton-directory)
- [Fail2ban](#fail2ban)
- [LDAP](#ldap)
- [Netdata](#netdata)
- [USER_SQL](#user_sql)
- [phpMyAdmin, Adminer or pgAdmin](#phpmyadmin-adminer-or-pgadmin)
- [Mail server](#mail-server)
- [How to migrate from an already existing Nextcloud installation to Nextcloud AIO?](#how-to-migrate-from-an-already-existing-nextcloud-installation-to-nextcloud-aio)
- [Requirements for integrating new containers](#requirements-for-integrating-new-containers)
- [How to trust user-defined Certification Authorities (CA)?](#how-to-trust-user-defined-certification-authorities-ca)
- [How to disable Collabora's Seccomp feature?](#how-to-disable-collaboras-seccomp-feature)
- [How to enable automatic updates without creating a backup beforehand?](#how-to-enable-automatic-updates-without-creating-a-backup-beforehand)
- [Securing the AIO interface from unauthorized ACME challenges](#securing-the-aio-interface-from-unauthorized-acme-challenges)
## Where can I find additional documentation?
Some of the documentation is available on [GitHub Discussions](https://github.com/nextcloud/all-in-one/discussions/categories/wiki).
### How does it work? ### How does it work?
Nextcloud AIO is inspired by projects like Portainer that manage the docker daemon by talking to it through the docker socket directly. This concept allows a user to install only one container with a single command that does the heavy lifting of creating and managing all containers that are needed in order to provide a Nextcloud installation with most features included. It also makes updating a breeze and is not bound to the host system (and its slow updates) anymore as everything is in containers. Additionally, it is very easy to handle from a user perspective because a simple interface for managing your Nextcloud AIO installation is provided. Nextcloud AIO is inspired by projects like Portainer that manage the docker daemon by talking to it through the docker socket directly. This concept allows a user to install only one container with a single command that does the heavy lifting of creating and managing all containers that are needed in order to provide a Nextcloud installation with most features included. It also makes updating a breeze and is not bound to the host system (and its slow updates) anymore as everything is in containers. Additionally, it is very easy to handle from a user perspective because a simple interface for managing your Nextcloud AIO installation is provided.