Update readme.md #6011
Draft
Update readme.md #6011
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
suggesting sub-titles in the presentation section (again) Signed-off-by: pun kyard <[email protected]>
|
hi @szaimen |
|
@szaimen ? |
Sorry, I was on vacation until today. |
Yes, definitely, but technically this is already a PR (Pull request), but in WIP (work in progress). But definitely a good idea so that we can discuss this. |
szaimen
reviewed
Feb 11, 2025
Comment on lines
-2
to
-16
| The official Nextcloud installation method. Nextcloud AIO provides easy deployment and maintenance with most features included in this one Nextcloud instance. | ||
|
|
||
| Included are: | ||
| - Nextcloud | ||
| - High performance backend for Nextcloud Files | ||
| - Nextcloud Office (optional) | ||
| - High performance backend for Nextcloud Talk and TURN-server (optional) | ||
| - Nextcloud Talk Recording-server (optional) | ||
| - Backup solution (optional, based on [BorgBackup](https://github.com/borgbackup/borg#what-is-borgbackup)) | ||
| - Imaginary (optional, for previews of heic, heif, illustrator, pdf, svg, tiff and webp) | ||
| - ClamAV (optional, Antivirus backend for Nextcloud) | ||
| - Fulltextsearch (optional) | ||
| - Whiteboard (optional) | ||
| - Docker Socket Proxy (optional, needed for [Nextcloud App API](https://github.com/cloud-py-api/app_api#nextcloud-appapi)) | ||
| - [Community containers](https://github.com/nextcloud/all-in-one/tree/main/community-containers#community-containers) |
There was a problem hiding this comment.
I would probably keep it like this
There was a problem hiding this comment.
really?
showing what is optional breaks down the paragraph, gives a clear introduction of what is AiO: a core, with actionable options - as a rookie user, it makes things clearer to me 😊
szaimen
reviewed
Feb 11, 2025
Comment on lines
-17
to
102
| - Ready for big file uploads up to 10 GB on public links, [adjustable](https://github.com/nextcloud/all-in-one#how-to-adjust-the-upload-limit-for-nextcloud) (logged in users can upload much bigger files using the webinterface or the mobile/desktop clients since chunking is used in that case) | ||
| - PHP and web server timeouts set to 3600s, [adjustable](https://github.com/nextcloud/all-in-one#how-to-adjust-the-max-execution-time-for-nextcloud) (important for big file uploads) | ||
| - Defaults to a max of 512 MB RAM per PHP process, [adjustable](https://github.com/nextcloud/all-in-one#how-to-adjust-the-php-memory-limit-for-nextcloud) | ||
| - Automatic TLS included (by using Let's Encrypt) | ||
| - Brotli compression enabled by default for javascript, css and svg files which reduces Nextcloud load times | ||
| - Redis for distributed cache and file locking | ||
| - PostgreSQL database | ||
| - PHP-FPM with optimized settings (OPcache and JIT enabled) | ||
|
|
||
| ## Security | ||
|
|
||
| - **A+** security rating in Nextcloud security scan | ||
| - Automatic TLS by Let's Encrypt | ||
| - HTTP/2 and HTTP/3 enabled | ||
| - "Pretty URLs" for Nextcloud are enabled by default (removes the index.php from all links) | ||
| - Video previews work out of the box and when Imaginary is enabled, many recent image formats as well! | ||
| - Only one domain and not multiple domains are required for everything to work (usually you would need to have one domain for each service which is much more complex) | ||
| - [Adjustable location](https://github.com/nextcloud/all-in-one#how-to-change-the-default-location-of-nextclouds-datadir) of Nextcloud's datadir (e.g. good for easy file-sharing with host system on Windows and MacOS) | ||
| - By default confined (good for security) but can [allow access to additional storages](https://github.com/nextcloud/all-in-one#how-to-allow-the-nextcloud-container-to-access-directories-on-the-host) in order to enable the usage of the local external storage feature | ||
| - Possibility included to [adjust default installed Nextcloud apps](https://github.com/nextcloud/all-in-one#how-to-change-the-nextcloud-apps-that-are-installed-on-the-first-startup) | ||
| - Nextcloud installation is not read only - that means you can apply patches if you should need them (instead of having to wait for the next release for them getting applied) | ||
| - `ffmpeg`, `smbclient`, `libreoffice` and `nodejs` are included by default | ||
| - Possibility included to [permanently add additional OS packages into the Nextcloud container](https://github.com/nextcloud/all-in-one#how-to-change-the-nextcloud-apps-that-are-installed-on-the-first-startup) without having to build your own Docker image | ||
| - Possibility included to [permanently add additional PHP extensions into the Nextcloud container](https://github.com/nextcloud/all-in-one#how-to-add-php-extensions-permanently-to-the-nextcloud-container) without having to build your own Docker image | ||
| - Possibility included to [pass the needed device for hardware transcoding](https://github.com/nextcloud/all-in-one#how-to-enable-hardware-acceleration-for-nextcloud) to the Nextcloud container | ||
| - Possibility included to [store all docker related files on a separate drive](https://github.com/nextcloud/all-in-one#how-to-store-the-filesinstallation-on-a-separate-drive) | ||
| - [LDAP can be used as user backend for Nextcloud](https://github.com/nextcloud/all-in-one/tree/main#ldap) | ||
| - Migration from any former Nextcloud installation to AIO is possible. See [this documentation](https://github.com/nextcloud/all-in-one/blob/main/migration.md) | ||
| - [Fail2Ban can be added](https://github.com/nextcloud/all-in-one#fail2ban) | ||
| - [phpMyAdmin, Adminer or pgAdmin can be added](https://github.com/nextcloud/all-in-one#phpmyadmin-adminer-or-pgadmin) | ||
| - [Mail server can be added](https://github.com/nextcloud/all-in-one#mail-server) | ||
| - Nextcloud can be [accessed locally via the domain](https://github.com/nextcloud/all-in-one#how-can-i-access-nextcloud-locally) | ||
| - Can [be installed locally](https://github.com/nextcloud/all-in-one/blob/main/local-instance.md) (if you don't want or cannot make the instance publicly reachable) | ||
| - "Pretty URLs" enabled (removes 'index.php' from all links) | ||
| - Confined by default; can also [allow external storage](https://github.com/nextcloud/all-in-one#how-to-allow-the-nextcloud-container-to-access-directories-on-the-host) | ||
|
|
||
| ## Compatibility | ||
|
|
||
| - Ready for existing [reverse proxies](https://github.com/nextcloud/all-in-one/blob/main/reverse-proxy.md), [Cloudflare Tunnel](https://github.com/nextcloud/all-in-one#how-to-run-nextcloud-behind-a-cloudflare-tunnel), and [Tailscale](https://github.com/nextcloud/all-in-one/discussions/5439) | ||
| - Supports uploads up to 10 GB on public links ([adjustable](https://github.com/nextcloud/all-in-one#how-to-adjust-the-upload-limit-for-nextcloud)); loogged-in users can upload larger files using the web interface or mobile/desktop clients | ||
| - [Adjustable](https://github.com/nextcloud/all-in-one#how-to-adjust-the-max-execution-time-for-nextcloud) PHP and web server timeouts (default: 3600s) | ||
| - Default maximum of 512 MB RAM per PHP process ([adjustable](https://github.com/nextcloud/all-in-one#how-to-adjust-the-php-memory-limit-for-nextcloud)) | ||
| - [LDAP as user backend](https://github.com/nextcloud/all-in-one/tree/main#ldap) if needed | ||
| - Add [Fail2Ban](https://github.com/nextcloud/all-in-one#fail2ban), [phpMyAdmin, Adminer or pgAdmin](https://github.com/nextcloud/all-in-one#phpmyadmin-adminer-or-pgadmin) | ||
| - Configure an individual or organizational [mail server](https://github.com/nextcloud/all-in-one#mail-server) | ||
|
|
||
| ## Extensibility | ||
|
|
||
| - [Adjust default apps and OS packages](https://github.com/nextcloud/all-in-one#how-to-change-the-nextcloud-apps-that-are-installed-on-the-first-startup) | ||
| - [Permanently add PHP extensions](https://github.com/nextcloud/all-in-one#how-to-add-php-extensions-permanently-to-the-nextcloud-container) | ||
| - [Enable hardware acceleration](https://github.com/nextcloud/all-in-one#how-to-enable-hardware-acceleration-for-nextcloud) | ||
| - [Store all Docker-related files on a separate drive](https://github.com/nextcloud/all-in-one#how-to-store-the-filesinstallation-on-a-separate-drive) | ||
| - All this without having to build your own Docker image | ||
|
|
||
| ## Network and System | ||
|
|
||
| - [IPv6-ready](https://github.com/nextcloud/all-in-one/blob/main/docker-ipv6-support.md) | ||
| - Can be used with [Docker rootless](https://github.com/nextcloud/all-in-one/blob/main/docker-rootless.md) (good for additional security) | ||
| - Runs on all platforms Docker supports (e.g. also on Windows and Macos) | ||
| - Included containers easy to debug by having the possibility to check their logs directly from the AIO interface | ||
| - [Local access via the domain](https://github.com/nextcloud/all-in-one#how-can-i-access-nextcloud-locally) | ||
| - [Local install](https://github.com/nextcloud/all-in-one/blob/main/local-instance.md) for private use | ||
| - [Adjustable location](https://github.com/nextcloud/all-in-one#how-to-change-the-default-location-of-nextclouds-datadir) of Nextcloud's datadir for easy file-sharing with host system on Windows and MacOS | ||
|
|
||
| ## Container Management | ||
|
|
||
| - [Docker-compose ready](./compose.yaml) | ||
| - Can be installed [without a container having access to the docker socket](https://github.com/nextcloud/all-in-one/tree/main/manual-install) | ||
| - Can be installed with [Docker Swarm](https://github.com/nextcloud/all-in-one#can-i-run-this-with-docker-swarm) | ||
| - Can be installed with [Kubernetes](https://github.com/nextcloud/all-in-one/tree/main/nextcloud-aio-helm-chart) | ||
| - Almost all included containers Alpine Linux based (good for security and size) | ||
| - Many of the included containers run as non-root user (good for security) | ||
| - Many of the included containers have a read-only root-FS (good for security) | ||
| - Included containers run in its own docker network (good for security) and only really necessary ports are exposed on the host | ||
| - [Multiple instances on one server](https://github.com/nextcloud/all-in-one/blob/main/multiple-instances.md) are doable without having to deal with VMs | ||
| - Adjustable backup path or remote borg repository from the AIO interface (good to put the backups e.g. on a different drive if using a local backup path) | ||
| - Possibility included to also back up external Docker Volumes or Host paths (can be used for host backups) | ||
| - Borg backup can be completely managed from the AIO interface, including backup creation, backup restore, backup integrity check and integrity-repair | ||
| - Other forms of [remote backup](https://github.com/nextcloud/all-in-one#are-remote-borg-backups-supported) are indirectly possible | ||
| - Updates and backups can be [run from an external script](https://github.com/nextcloud/all-in-one#how-to-stopstartupdate-containers-or-trigger-the-daily-backup-from-a-script-externally). See [this documentation](https://github.com/nextcloud/all-in-one#how-to-enable-automatic-updates-without-creating-a-backup-beforehand) for a complete example. | ||
| - Runs on all platforms Docker supports (including Windows and MacOS) | ||
| - Supports [Docker rootless](https://github.com/nextcloud/all-in-one/blob/main/docker-rootless.md) for additional security | ||
| - Compatible with [Docker Swarm](https://github.com/nextcloud/all-in-one#can-i-run-this-with-docker-swarm) and [Kubernetes](https://github.com/nextcloud/all-in-one/tree/main/nextcloud-aio-helm-chart) | ||
| - [Multiple instances on one server](https://github.com/nextcloud/all-in-one/blob/main/multiple-instances.md) | ||
| - Can be installed [without giving access to the Docker socket](https://github.com/nextcloud/all-in-one/tree/main/manual-install) | ||
|
|
||
| **Note:** | ||
| - Almost all included containers are Alpine Linux-based | ||
| - Many of the included containers run as non-root user | ||
| - Many of the included containers have a read-only root filesystem | ||
| - Included containers run in their own docker network, and only really necessary ports are exposed on the host | ||
|
|
||
| > **Nextcloud AIO is not read only and will let you apply patches manually.** | ||
| ## Additional Features | ||
|
|
||
| - Video previews work out of the box | ||
| - `ffmpeg`, `smbclient`, `libreoffice` and `nodejs` included by default | ||
| - Brotli compression enabled by default for JavaScript, CSS and SVG files to reduce load times | ||
|
|
||
| </details> |
There was a problem hiding this comment.
but having sections inside the additional features section probably is a good idea!
There was a problem hiding this comment.
well, it took me a good couple of hours to figure what was repeating, what could be gathered in one section...
szaimen
reviewed
Feb 11, 2025
Comment on lines
+110
to
+113
| The following instructions are meant for setups without a web server or reverse proxy (like Apache, Nginx, Caddy, Cloudflare Tunnel and else). If you want to run Nextcloud AIO behind a web server or reverse proxy, see the [reverse proxy documentation](https://github.com/nextcloud/all-in-one/blob/main/reverse-proxy.md). | ||
|
|
||
| The instructions below are meant for Linux; see separate guides for [MacOS](#how-to-run-aio-on-macos), [Windows](#how-to-run-aio-on-windows) and for [Synology](#how-to-run-aio-on-synology-dsm). | ||
|
|
There was a problem hiding this comment.
Suggested change
| The following instructions are meant for setups without a web server or reverse proxy (like Apache, Nginx, Caddy, Cloudflare Tunnel and else). If you want to run Nextcloud AIO behind a web server or reverse proxy, see the [reverse proxy documentation](https://github.com/nextcloud/all-in-one/blob/main/reverse-proxy.md). | |
| The instructions below are meant for Linux; see separate guides for [MacOS](#how-to-run-aio-on-macos), [Windows](#how-to-run-aio-on-windows) and for [Synology](#how-to-run-aio-on-synology-dsm). | |
| > [!NOTE] | |
| > The following instructions are meant for setups without a web server or reverse proxy (like Apache, Nginx, Caddy, Cloudflare Tunnel and else). If you want to run Nextcloud AIO behind a web server or reverse proxy, see the [reverse proxy documentation](https://github.com/nextcloud/all-in-one/blob/main/reverse-proxy.md). | |
| > [!TIP] | |
| > The instructions below are meant for Linux; see separate guides for [MacOS](#how-to-run-aio-on-macos), [Windows](#how-to-run-aio-on-windows) and for [Synology](#how-to-run-aio-on-synology-dsm). | |
There was a problem hiding this comment.
i'm willing to transform every URL into a link to help the reading...
|
Thanks a lot @punkyard for starting to work on this |
szaimen
added
2. developing
|
i'm receiving an error message when i tried to commit and push. |
what exactly is the error message? You should be able to push to the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
suggesting sub-titles in the presentation section (again)
For #5362