From 1b696a12425ef0da1a18eb1db89cf9adad386af0 Mon Sep 17 00:00:00 2001 From: gggeek Date: Mon, 18 May 2026 12:11:21 +0000 Subject: [PATCH 1/2] improve comm-conts readmes by adding links to upstream sw and describing what each one does Signed-off-by: Gaetano Giunta --- community-containers/borgbackup-viewer/readme.md | 3 +-- community-containers/caddy/readme.md | 10 +++++++++- community-containers/calcardbackup/readme.md | 3 +-- community-containers/container-management/readme.md | 6 +++--- community-containers/dlna/readme.md | 5 ++--- community-containers/facerecognition/readme.md | 2 +- community-containers/fail2ban/readme.md | 3 ++- community-containers/glances/readme.md | 2 +- community-containers/home-assistant/readme.md | 2 +- community-containers/jellyfin/readme.md | 2 +- community-containers/jellyseerr/readme.md | 2 +- community-containers/languagetool/readme.md | 2 +- community-containers/libretranslate/readme.md | 2 +- community-containers/lldap/readme.md | 2 +- community-containers/local-ai/readme.md | 2 +- community-containers/makemkv/readme.md | 2 +- community-containers/minio/readme.md | 2 +- community-containers/nocodb/readme.md | 2 +- community-containers/npmplus/readme.md | 2 +- community-containers/pi-hole/readme.md | 2 +- community-containers/plex/readme.md | 2 +- community-containers/scrutiny/readme.md | 2 +- community-containers/stalwart/readme.md | 2 +- community-containers/vaultwarden/readme.md | 2 +- 24 files changed, 36 insertions(+), 30 deletions(-) diff --git a/community-containers/borgbackup-viewer/readme.md b/community-containers/borgbackup-viewer/readme.md index ddd11be7..97b27f2e 100644 --- a/community-containers/borgbackup-viewer/readme.md +++ b/community-containers/borgbackup-viewer/readme.md @@ -1,5 +1,5 @@ ## Borgbackup Viewer -This container allows to view the local borg repository in a web session. It also allows you to restore files and folders from the backup by using desktop programs in a web browser. +This container allows to view the local borg backups repository in a web session. It also allows you to restore files and folders from the backup by using desktop programs in a web browser. ### Notes - After adding and starting the container, you need to visit `https://ip.address.of.this.server:5801` in order to log in with the user `nextcloud` and the password that you can see next to the container in the AIO interface. (The web page uses a self-signed certificate, so you need to accept the warning). @@ -14,4 +14,3 @@ https://github.com/szaimen/aio-borgbackup-viewer ### Maintainer https://github.com/szaimen - diff --git a/community-containers/caddy/readme.md b/community-containers/caddy/readme.md index 5ada3738..68da1f92 100644 --- a/community-containers/caddy/readme.md +++ b/community-containers/caddy/readme.md @@ -1,5 +1,13 @@ ## Caddy with geoblocking -This container bundles caddy and auto-configures it for you. It also covers [vaultwarden](https://github.com/nextcloud/all-in-one/tree/main/community-containers/vaultwarden) by listening on `bw.$NC_DOMAIN`, if installed. It also covers [stalwart](https://github.com/nextcloud/all-in-one/tree/main/community-containers/stalwart) by listening on `mail.$NC_DOMAIN`, if installed. It also covers [jellyfin](https://github.com/nextcloud/all-in-one/tree/main/community-containers/jellyfin) by listening on `media.$NC_DOMAIN`, if installed. It also covers [lldap](https://github.com/nextcloud/all-in-one/tree/main/community-containers/lldap) by listening on `ldap.$NC_DOMAIN`, if installed. It also covers [nocodb](https://github.com/nextcloud/all-in-one/tree/main/community-containers/nocodb) by listening on `tables.$NC_DOMAIN`, if installed. It also covers [seerr](https://github.com/nextcloud/all-in-one/tree/main/community-containers/jellyseerr) by listening on `requests.$NC_DOMAIN`, if installed. It also covers [nextcloud-exporter](https://github.com/nextcloud/all-in-one/tree/main/community-containers/nextcloud-exporter) by listening on `metrics.$NC_DOMAIN`, if installed. It also covers [LocalAI](https://github.com/nextcloud/all-in-one/tree/main/community-containers/local-ai) by listening on `ai.$NC_DOMAIN`, if installed. +This container bundles [caddy](https://caddyserver.com/) and auto-configures it for you as a reverse proxy. +It also covers [vaultwarden](https://github.com/nextcloud/all-in-one/tree/main/community-containers/vaultwarden) by listening on `bw.$NC_DOMAIN`, if installed. +It also covers [stalwart](https://github.com/nextcloud/all-in-one/tree/main/community-containers/stalwart) by listening on `mail.$NC_DOMAIN`, if installed. +It also covers [jellyfin](https://github.com/nextcloud/all-in-one/tree/main/community-containers/jellyfin) by listening on `media.$NC_DOMAIN`, if installed. +It also covers [lldap](https://github.com/nextcloud/all-in-one/tree/main/community-containers/lldap) by listening on `ldap.$NC_DOMAIN`, if installed. +It also covers [nocodb](https://github.com/nextcloud/all-in-one/tree/main/community-containers/nocodb) by listening on `tables.$NC_DOMAIN`, if installed. +It also covers [seerr](https://github.com/nextcloud/all-in-one/tree/main/community-containers/jellyseerr) by listening on `requests.$NC_DOMAIN`, if installed. +It also covers [nextcloud-exporter](https://github.com/nextcloud/all-in-one/tree/main/community-containers/nextcloud-exporter) by listening on `metrics.$NC_DOMAIN`, if installed. +It also covers [LocalAI](https://github.com/nextcloud/all-in-one/tree/main/community-containers/local-ai) by listening on `ai.$NC_DOMAIN`, if installed. ### Notes - This container is incompatible with the [npmplus](https://github.com/nextcloud/all-in-one/tree/main/community-containers/npmplus) community container. So make sure that you do not enable both at the same time! diff --git a/community-containers/calcardbackup/readme.md b/community-containers/calcardbackup/readme.md index 42a218b4..af2ecb79 100644 --- a/community-containers/calcardbackup/readme.md +++ b/community-containers/calcardbackup/readme.md @@ -1,5 +1,5 @@ ## calcardbackup -This container packages calcardbackup which is a tool that exports calendars and addressbooks from Nextcloud to .ics and .vcf files and saves them to a compressed file. +This container packages [calcardbackup](https://codeberg.org/BernieO/calcardbackup), a tool that exports calendars and addressbooks from Nextcloud to .ics and .vcf files and saves them to a compressed file. ### Notes - Backups will be created at 00:00 UTC every day. Make sure that this does not conflict with the configured daily backups inside AIO. @@ -12,4 +12,3 @@ https://github.com/waja/docker-calcardbackup ### Maintainer https://github.com/pailloM - diff --git a/community-containers/container-management/readme.md b/community-containers/container-management/readme.md index e8c17313..9b59f36a 100644 --- a/community-containers/container-management/readme.md +++ b/community-containers/container-management/readme.md @@ -1,11 +1,11 @@ ## Container-Management -This container allows to manage insides of other containers via a GUI inside a Web session by allowing to run docker commands from inside this container. +This container allows to manage other containers via a GUI inside a Web session by allowing to run docker commands from inside this container. ### Notes - After adding and starting the container, you need to visit `https://ip.address.of.this.server:5804` in order to log in with the user `container-management` and the password that you can see next to the container in the AIO interface. (The web page uses a self-signed certificate, so you need to accept the warning). - Then, you should see a terminal. There you can use any docker command. ⚠️ Be very carefully while doing that as can break your instance! -- There are also some pre-made scripts that make configuring some of the community containers easier. For example scripts for [LLDAP](https://github.com/nextcloud/all-in-one/tree/main/community-containers/lldap) and [Facerecognition](https://github.com/nextcloud/all-in-one/tree/main/community-containers/facerecognition). -- ⚠️ After you are done doing your operations, remove the container for better security again from the stack: https://github.com/nextcloud/all-in-one/tree/main/community-containers#how-to-remove-containers-from-aios-stack +- There are also some pre-made scripts that make configuring some community containers easier. For example scripts for [LLDAP](https://github.com/nextcloud/all-in-one/tree/main/community-containers/lldap) and [Facerecognition](https://github.com/nextcloud/all-in-one/tree/main/community-containers/facerecognition). +- ⚠️ After you are done doing your operations, remove the container from the stack for better security: https://github.com/nextcloud/all-in-one/tree/main/community-containers#how-to-remove-containers-from-aios-stack - See https://github.com/nextcloud/all-in-one/tree/main/community-containers#community-containers how to add it to the AIO stack ### Repository diff --git a/community-containers/dlna/readme.md b/community-containers/dlna/readme.md index 47502dc8..80a2067b 100644 --- a/community-containers/dlna/readme.md +++ b/community-containers/dlna/readme.md @@ -1,8 +1,8 @@ ## DLNA server -This container bundles DLNA server for your Nextcloud files to be accessible by the clients in your local network. Simply run the container and look for a new media server `nextcloud-aio` in your local network. +This container bundles a DLNA multimedia streaming server for your Nextcloud files to be accessible by the clients in your local network. Simply run the container and look for a new media server `nextcloud-aio` in your local network. ### Notes -- This container will work only if the Nextcloud installation is in your home network, it is not suitable for installations on remote servers. +- This container will work only if the Nextcloud installation is in your home network, it is not suitable for installations on public servers. - If you have a firewall like ufw configured, you might need to open at least port 9999 TCP and 1900 UDP first in order to make it work. - See https://github.com/nextcloud/all-in-one/tree/main/community-containers#community-containers how to add it to the AIO stack @@ -11,4 +11,3 @@ https://github.com/thanek/nextcloud-dlna ### Maintainer https://github.com/thanek - diff --git a/community-containers/facerecognition/readme.md b/community-containers/facerecognition/readme.md index 474ed1e2..cccad6f0 100644 --- a/community-containers/facerecognition/readme.md +++ b/community-containers/facerecognition/readme.md @@ -1,5 +1,5 @@ ## Facerecognition -This container bundles the external model of facerecognition and auto-configures it for you. +This container bundles a basic facial recognition system and auto-configures it for you. ### Notes - This container needs imaginary in order to analyze modern file format images. Make sure to enable imaginary in the AIO interface before adding this container. diff --git a/community-containers/fail2ban/readme.md b/community-containers/fail2ban/readme.md index 28ab21e3..756ce905 100644 --- a/community-containers/fail2ban/readme.md +++ b/community-containers/fail2ban/readme.md @@ -1,5 +1,6 @@ ## Fail2ban -This container bundles fail2ban and auto-configures it for you in order to block ip-addresses automatically. It also covers https://github.com/nextcloud/all-in-one/tree/main/community-containers/vaultwarden, https://github.com/nextcloud/all-in-one/tree/main/community-containers/jellyfin, and https://github.com/nextcloud/all-in-one/tree/main/community-containers/jellyseerr, if installed. +This container bundles [fail2ba](https://github.com/fail2ban/fail2ban) and auto-configures it for you in order to block ip-addresses automatically. +It also covers https://github.com/nextcloud/all-in-one/tree/main/community-containers/vaultwarden, https://github.com/nextcloud/all-in-one/tree/main/community-containers/jellyfin, and https://github.com/nextcloud/all-in-one/tree/main/community-containers/jellyseerr, if installed. ### Notes - If you get an error like `"ip6tables v1.8.9 (legacy): can't initialize ip6tables table filter': Table does not exist (do you need to insmod?)"`, you need to enable ip6tables on your host via `sudo modprobe ip6table_filter`. diff --git a/community-containers/glances/readme.md b/community-containers/glances/readme.md index a9860778..10c0ef77 100644 --- a/community-containers/glances/readme.md +++ b/community-containers/glances/readme.md @@ -1,5 +1,5 @@ ## Glances -This container starts Glances, a web-based info-board, and auto-configures it for you. +This container starts [Glances](https://nicolargo.github.io/glances/), a web-based system monitoring dashboard, and auto-configures it for you. > [!CAUTION] > This container mounts the docker-socket from the host-system. diff --git a/community-containers/home-assistant/readme.md b/community-containers/home-assistant/readme.md index e5ac025a..75d3c76c 100644 --- a/community-containers/home-assistant/readme.md +++ b/community-containers/home-assistant/readme.md @@ -1,5 +1,5 @@ ## Home Assistant -This container bundles Home Assistant and auto-configures it for you. +This container bundles [Home Assistant](https://www.home-assistant.io/) and auto-configures it for you. ### Notes - This container should only be run in home networks since Home Assistant is designed for local home automation. diff --git a/community-containers/jellyfin/readme.md b/community-containers/jellyfin/readme.md index 2a78bc1e..768d879a 100644 --- a/community-containers/jellyfin/readme.md +++ b/community-containers/jellyfin/readme.md @@ -1,5 +1,5 @@ ## Jellyfin -This container bundles Jellyfin and auto-configures it for you. +This container bundles [Jellyfin](https://jellyfin.org/) and auto-configures it for you. ### Notes - This container is incompatible with the [Plex](https://github.com/nextcloud/all-in-one/tree/main/community-containers/plex) community container. So make sure that you do not enable both at the same time! diff --git a/community-containers/jellyseerr/readme.md b/community-containers/jellyseerr/readme.md index f5541062..dd3b6712 100644 --- a/community-containers/jellyseerr/readme.md +++ b/community-containers/jellyseerr/readme.md @@ -1,5 +1,5 @@ ## Seerr -This container bundles Seerr and auto-configures it for you. +This container bundles [Seerr](https://seerr.dev/) request management and media discovery tool and auto-configures it for you. ### Notes - **Migration from Jellyseerr**: Jellyseer previously ran as the root user. With the migration to Seerr, the container now runs rootless with userid 1000, meaning that if you previously used Jellyseerr, Seerr will not be able to access the config files generated by the old Jellyseerr container. To migrate, execute the following steps: 1. stop all containers using the AIO-interface, 2. run `sudo docker run --rm -v nextcloud_aio_jellyseerr:/data alpine chown -R 1000:1000 /data` diff --git a/community-containers/languagetool/readme.md b/community-containers/languagetool/readme.md index c7a725e9..1c46bcf9 100644 --- a/community-containers/languagetool/readme.md +++ b/community-containers/languagetool/readme.md @@ -1,5 +1,5 @@ ## LanguageTool for Nextcloud Office -This container bundles a LanguageTool for Nextcloud Office which adds spell checking functionality to Nextcloud Office. +This container bundles [LanguageTool](https://github.com/languagetool-org/languagetool) for Nextcloud Office which adds spell checking functionality to Nextcloud Office. ### Notes - Make sure to have Nextcloud Office enabled via the AIO interface diff --git a/community-containers/libretranslate/readme.md b/community-containers/libretranslate/readme.md index f9893f34..cbc01d06 100644 --- a/community-containers/libretranslate/readme.md +++ b/community-containers/libretranslate/readme.md @@ -1,5 +1,5 @@ ## LibreTranslate -This container bundles LibreTranslate and auto-configures it for you. +This container bundles [LibreTranslate](https://github.com/LibreTranslate/LibreTranslate) and auto-configures it for you. > [!WARNING] > The LibreTranslate container and app is deprecated! diff --git a/community-containers/lldap/readme.md b/community-containers/lldap/readme.md index 586aea9e..88f15f5c 100644 --- a/community-containers/lldap/readme.md +++ b/community-containers/lldap/readme.md @@ -1,5 +1,5 @@ ## Light LDAP server -This container bundles LLDAP server and auto-configures your Nextcloud instance for you. +This container bundles an [LLDAP](https://github.com/lldap/lldap) LDAP server and auto-configures your Nextcloud instance for you. ### Notes - In order to access your LLDAP web interface outside the local network, you have to set up your own reverse proxy. You can set up a reverse proxy following [these instructions](https://github.com/nextcloud/all-in-one/blob/main/reverse-proxy.md) OR use the [Caddy](https://github.com/nextcloud/all-in-one/tree/main/community-containers/caddy) community container that will automatically configure `ldap.$NC_DOMAIN` to redirect to your Lldap. You need to point the reverse proxy at port 17170 of this server. diff --git a/community-containers/local-ai/readme.md b/community-containers/local-ai/readme.md index 2068ed1d..18ec0242 100644 --- a/community-containers/local-ai/readme.md +++ b/community-containers/local-ai/readme.md @@ -1,5 +1,5 @@ ## Local AI -This container bundles Local AI and auto-configures it for you. It support hardware acceleration with Vulkan. +This container bundles [Local AI](https://localai.io/) and auto-configures it for you. It support hardware acceleration with Vulkan. ### Notes Documentation is available on the container repository. This documentation is regularly updated and is intended to be as simple and detailed as possible. Thanks for all your feedback! diff --git a/community-containers/makemkv/readme.md b/community-containers/makemkv/readme.md index e78510ee..2933e11b 100644 --- a/community-containers/makemkv/readme.md +++ b/community-containers/makemkv/readme.md @@ -1,5 +1,5 @@ ## MakeMKV -This container bundles MakeMKV and auto-configures it for you. +This container bundles the [MakeMKV](https://www.makemkv.com/) video converter and auto-configures it for you. ### Notes - This container should only be run in home networks diff --git a/community-containers/minio/readme.md b/community-containers/minio/readme.md index be41d5bd..67d3a687 100644 --- a/community-containers/minio/readme.md +++ b/community-containers/minio/readme.md @@ -1,5 +1,5 @@ ## Minio -This container bundles minio s3 storage and auto-configures it for you. +This container bundles [minio](https://github.com/minio/minio) s3 storage and auto-configures it for you. >[!WARNING] > Enabling this container will remove access to all the files formerly written to the data directory. diff --git a/community-containers/nocodb/readme.md b/community-containers/nocodb/readme.md index fa23f8f6..8f5cb2d9 100644 --- a/community-containers/nocodb/readme.md +++ b/community-containers/nocodb/readme.md @@ -14,7 +14,7 @@ > - See more here https://github.com/nextcloud/tables/issues/103 ## NocoDb server -This container bundles NocoDb without synchronization with Nextcloud. +This container bundles [NocoDb](https://github.com/nocodb/nocodb), an online no-code database solution, without synchronization with Nextcloud. This is an alternative of **Airtable**. diff --git a/community-containers/npmplus/readme.md b/community-containers/npmplus/readme.md index a71b4af2..ebd55d96 100644 --- a/community-containers/npmplus/readme.md +++ b/community-containers/npmplus/readme.md @@ -1,5 +1,5 @@ ## NPMplus -This container contains a fork of the Nginx Proxy Manager, which is a WebUI for nginx. It will also automatically create a config and cert for AIO. +This container contains a fork of [Nginx Proxy Manager](https://nginxproxymanager.com/), which is a WebUI for nginx. It will also automatically create a config and cert for AIO. ### Notes - This container is incompatible with the [caddy](https://github.com/nextcloud/all-in-one/tree/main/community-containers/caddy) community container. So make sure that you do not enable both at the same time! diff --git a/community-containers/pi-hole/readme.md b/community-containers/pi-hole/readme.md index 7254f585..69ad11ce 100644 --- a/community-containers/pi-hole/readme.md +++ b/community-containers/pi-hole/readme.md @@ -1,5 +1,5 @@ ## Pi-hole -This container bundles pi-hole and auto-configures it for you. +This container bundles the [pi-hole](https://pi-hole.net/) ad blocker and auto-configures it for you. ### Notes - You should not run this container on a public VPS! It is only intended to run in home networks! diff --git a/community-containers/plex/readme.md b/community-containers/plex/readme.md index 7f8434ab..538f4907 100644 --- a/community-containers/plex/readme.md +++ b/community-containers/plex/readme.md @@ -1,5 +1,5 @@ ## Plex -This container bundles Plex and auto-configures it for you. +This container bundles the [Plex Media Server](https://www.plex.tv/en-gb/personal-media-server/) and auto-configures it for you. ### Notes - This container is incompatible with the [Jellyfin](https://github.com/nextcloud/all-in-one/tree/main/community-containers/jellyfin) community container. So make sure that you do not enable both at the same time! diff --git a/community-containers/scrutiny/readme.md b/community-containers/scrutiny/readme.md index 3bb728f7..34bf5d45 100644 --- a/community-containers/scrutiny/readme.md +++ b/community-containers/scrutiny/readme.md @@ -1,5 +1,5 @@ ## Scrutiny -This container bundles Scrutiny which is a frontend for SMART stats and auto-configures it for you. +This container bundles [Scrutiny](https://github.com/analogj/scrutiny), a web frontend for SMART stats, and auto-configures it for you. ### Notes - This container should only be run in home networks diff --git a/community-containers/stalwart/readme.md b/community-containers/stalwart/readme.md index b34f04db..0b63a92f 100644 --- a/community-containers/stalwart/readme.md +++ b/community-containers/stalwart/readme.md @@ -4,7 +4,7 @@ > Do not use this feature as a main mail server or without a redundancy system and without knowledge. ## Stalwart mail server -This container bundles stalwart mail server and auto-configures it for you. +This container bundles the [Stalwart](https://stalw.art/) mail server and auto-configures it for you. ### Notes Documentation is available on the container repository. diff --git a/community-containers/vaultwarden/readme.md b/community-containers/vaultwarden/readme.md index 81f37010..8815ca48 100644 --- a/community-containers/vaultwarden/readme.md +++ b/community-containers/vaultwarden/readme.md @@ -1,5 +1,5 @@ ## Vaultwarden -This container bundles vaultwarden and auto-configures it for you. +This container bundles the [VaultWarden](https://www.vaultwarden.net/) password manager and auto-configures it for you. ### Notes - You need to configure a reverse proxy in order to run this container since vaultwarden needs a dedicated (sub)domain! For that, you might have a look at https://github.com/nextcloud/all-in-one/tree/main/community-containers/caddy or follow https://github.com/nextcloud/all-in-one/blob/main/reverse-proxy.md and https://github.com/dani-garcia/vaultwarden/wiki/Proxy-examples. You need to point the reverse proxy at port 8812 of this server. From 22d2db35b156eb9efe9d5b29e1c2b5a7ab0610b1 Mon Sep 17 00:00:00 2001 From: Anvil5465 <119350594+Anvil5465@users.noreply.github.com> Date: Wed, 20 May 2026 17:03:57 -0400 Subject: [PATCH 2/2] Update community-containers/fail2ban/readme.md Signed-off-by: Anvil5465 <119350594+Anvil5465@users.noreply.github.com> --- community-containers/fail2ban/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/community-containers/fail2ban/readme.md b/community-containers/fail2ban/readme.md index 756ce905..9e6b8d4d 100644 --- a/community-containers/fail2ban/readme.md +++ b/community-containers/fail2ban/readme.md @@ -1,5 +1,5 @@ ## Fail2ban -This container bundles [fail2ba](https://github.com/fail2ban/fail2ban) and auto-configures it for you in order to block ip-addresses automatically. +This container bundles [fail2ban](https://github.com/fail2ban/fail2ban) and auto-configures it for you in order to block ip-addresses automatically. It also covers https://github.com/nextcloud/all-in-one/tree/main/community-containers/vaultwarden, https://github.com/nextcloud/all-in-one/tree/main/community-containers/jellyfin, and https://github.com/nextcloud/all-in-one/tree/main/community-containers/jellyseerr, if installed. ### Notes