diff --git a/docker-rootless.md b/docker-rootless.md index 76d57d6d..a3894a64 100644 --- a/docker-rootless.md +++ b/docker-rootless.md @@ -9,7 +9,7 @@ You can run AIO with docker rootless by following the steps below. 1. Also do not forget to run `loginctl enable-linger USERNAME` (and substitute USERNAME with the correct one) in order to make sure that user services are automatically started after every reboot. 1. Expose the privileged ports by following https://docs.docker.com/engine/security/rootless/#exposing-privileged-ports. (`sudo setcap cap_net_bind_service=ep $(which rootlesskit); systemctl --user restart docker`) 1. Use the official AIO startup command but use `--volume $XDG_RUNTIME_DIR/docker.sock:/var/run/docker.sock:ro` instead of `--volume /var/run/docker.sock:/var/run/docker.sock:ro` and also add `--env WATCHTOWER_DOCKER_SOCKET_PATH=$XDG_RUNTIME_DIR/docker.sock` to the initial container startup (which is needed for mastercontainer updates to work correctly). -1. Now everything should work like without docker rootless. You can consider using docker-compose for this or running it behind a reverse proxy. Basically the only thing that needs to be adjusted always in the startup command or docker-compose file (after installing docker rootles) are things that are mentioned in point 3. +1. Now everything should work like without docker rootless. You can consider using docker-compose for this or running it behind a reverse proxy. Basically the only thing that needs to be adjusted always in the startup command or compose.yaml file (after installing docker rootles) are things that are mentioned in point 3. **Please note:** All files outside the containers get created, written to and accessed as the user that is running the docker daemon or a subuid of it. So for the built-in backup to work you need to allow this user to write to the target directory. E.g. with `sudo chown -R USERNAME:GROUPNAME /mnt/backup`. The same applies when changing Nextcloud's datadir. E.g. `sudo chown -R USERNAME:GROUPNAME /mnt/ncdata`. When you want to use the NEXTCLOUD_MOUNT option for local external storage, you need to adjust the permissions of the chosen folders to be accessible/writeable by the userid `100032:100032` (if running `grep ^$(whoami): /etc/subuid` as the user that is running the docker daemon returns 100000 as first value). diff --git a/manual-install/readme.md b/manual-install/readme.md index 6f7a39e3..ee6e8dd9 100644 --- a/manual-install/readme.md +++ b/manual-install/readme.md @@ -11,7 +11,7 @@ You can run the containers that are build for AIO with docker-compose. This come - You lose the AIO interface - You lose update notifications and automatic updates - You lose all AIO backup and restore features -- **You need to know what you are doing, especially when modifying the docker-compose file** +- **You need to know what you are doing, especially when modifying the compose.yaml file** - For updating, you need to strictly follow the at the bottom described update routine - Probably more @@ -23,7 +23,7 @@ cd all-in-one/manual-install ``` Then copy the sample.conf to default environment file, e.g. `cp sample.conf .env`, open the new conf file, e.g. with `nano .env`, edit all values that are marked with `# TODO!`, close and save the file. (Note: there is no clamav image for arm64). -Now copy the provided yaml file to a docker-compose file by running `cp latest.yml compose.yaml`. +Now copy the provided yaml file to a compose.yaml file by running `cp latest.yml compose.yaml`. Now you should be ready to go with `sudo docker-compose up`. @@ -38,7 +38,7 @@ Since the AIO containers may change in the future, it is highly recommended to s 1. Run `sudo docker-compose down` to stop all running containers 1. Back up all important files and folders 1. If your compose file is still named `docker-compose.yml` rename it to `compose.yaml` by running `mv -vn docker-compose.yml compose.yaml` -1. Run `git pull` in order to get the updated yaml files from the repository. Now bring your `compose.yaml` file up-to-date with the updated one from the repository. You can use `diff compose.yaml latest.yml` for comparing. ⚠️ **Please note**: Starting with AIO v5.1.0, ipv6 networking will be enabled by default, so make sure to either enable it first by following steps 1 and 2 of https://github.com/nextcloud/all-in-one/blob/main/docker-ipv6-support.md and then proceed with the steps below or disable ipv6 networking by editing the docker-compose file and removing ipv6 from the network. +1. Run `git pull` in order to get the updated yaml files from the repository. Now bring your `compose.yaml` file up-to-date with the updated one from the repository. You can use `diff compose.yaml latest.yml` for comparing. ⚠️ **Please note**: Starting with AIO v5.1.0, ipv6 networking will be enabled by default, so make sure to either enable it first by following steps 1 and 2 of https://github.com/nextcloud/all-in-one/blob/main/docker-ipv6-support.md and then proceed with the steps below or disable ipv6 networking by editing the compose.yaml file and removing ipv6 from the network. 1. Also have a look at the `sample.conf` if any variable was added or renamed and add that to your conf file as well. Here may help the diff command as well. 1. After the file update was successful, simply run `sudo docker-compose pull` to pull the new images. 1. At the end run `sudo docker-compose up` in order to start and update the containers with the new configuration. diff --git a/readme.md b/readme.md index fe2b6452..f2da5577 100644 --- a/readme.md +++ b/readme.md @@ -53,7 +53,7 @@ Included are: - Can be used with [Docker rootles](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 -- [Docker-compose ready](https://github.com/nextcloud/all-in-one/blob/main/compose.yaml) +- [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) diff --git a/reverse-proxy.md b/reverse-proxy.md index ac0ef181..293d9fac 100644 --- a/reverse-proxy.md +++ b/reverse-proxy.md @@ -568,7 +568,7 @@ Config examples for other reverse proxies are currently not documented. Pull req After adjusting your reverse proxy config, use the following command to start AIO:
-(For an docker-compose example, see the example further [below](#inspiration-for-a-docker-compose-file).) +(For a docker-compose example, see the example further [below](#inspiration-for-a-docker-compose-file).) ``` # For Linux: