From 7dc4edc1e037002f7d078db0764f89342cf77762 Mon Sep 17 00:00:00 2001 From: ManOki Date: Fri, 23 Dec 2022 17:23:49 +0100 Subject: [PATCH 1/2] manual-install: update readme to use default docker environment file .env Signed-off-by: ManOki --- .gitignore | 3 ++- manual-install/readme.md | 11 ++++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/.gitignore b/.gitignore index a27e8815..db327d1d 100644 --- a/.gitignore +++ b/.gitignore @@ -5,4 +5,5 @@ /php/vendor /manual-install/*.conf !/manual-install/sample.conf -/manual-install/docker-compose.yml \ No newline at end of file +/manual-install/docker-compose.yml +/manual-install/.env diff --git a/manual-install/readme.md b/manual-install/readme.md index da98efa8..617eee60 100644 --- a/manual-install/readme.md +++ b/manual-install/readme.md @@ -21,20 +21,21 @@ First, install docker and docker-compose if not already done. Then simply run th git clone https://github.com/nextcloud/all-in-one.git cd all-in-one/manual-install ``` -Then copy the sample.conf to a new file, e.g. `cp sample.conf my.conf`, open the new conf file, e.g. with `nano my.conf`, edit all values that are marked with `# TODO!`, close and save the file. +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. Now copy the provided yaml file to a docker-compose file by running on x64 `cp latest.yml docker-compose.yml` and on arm64 `cp latest-arm64.yml docker-compose.yml`. -Now you should be ready to go with `sudo docker-compose --env-file my.conf up`. +Now you should be ready to go with `sudo docker-compose up`. ## How to update? Since the AIO containers may change in the future, it is highly recommended to strictly follow the following procedure whenever you want to upgrade your containers. -1. Run `sudo docker-compose --env-file my.conf down` to stop all running containers +1. If your previous copy of `sample.conf` is named `my.conf`, run `mv my.conf .env` +1. Run `sudo docker-compose down` to stop all running containers 1. Back up all important files and folders 1. Run `git pull` in order to get the updated yaml files from the repository. Now bring your `docker-compose.yml` file up-to-date with the updated one from the repository. You can use `diff docker-compose.yml latest.yml` on x64 and `diff docker-compose.yml latest-arm64.yml` on arm64 for comparing. 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 --env-file my.conf pull` to pull the new images. -1. At the end run `sudo docker-compose --env-file my.conf up` in order to start and update the containers with the new configuration. +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. ## FAQ ### Backup and restore? From 377058cef1ae8113b868ac472d686756843664fb Mon Sep 17 00:00:00 2001 From: Simon L Date: Fri, 23 Dec 2022 22:03:00 +0100 Subject: [PATCH 2/2] make description of the mv command a bit clearer Signed-off-by: Simon L --- manual-install/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manual-install/readme.md b/manual-install/readme.md index 617eee60..8e52e932 100644 --- a/manual-install/readme.md +++ b/manual-install/readme.md @@ -29,7 +29,7 @@ Now you should be ready to go with `sudo docker-compose up`. ## How to update? Since the AIO containers may change in the future, it is highly recommended to strictly follow the following procedure whenever you want to upgrade your containers. -1. If your previous copy of `sample.conf` is named `my.conf`, run `mv my.conf .env` +1. If your previous copy of `sample.conf` is named `my.conf`, run `mv my.conf .env` in order to rename the file to `.env`. 1. Run `sudo docker-compose down` to stop all running containers 1. Back up all important files and folders 1. Run `git pull` in order to get the updated yaml files from the repository. Now bring your `docker-compose.yml` file up-to-date with the updated one from the repository. You can use `diff docker-compose.yml latest.yml` on x64 and `diff docker-compose.yml latest-arm64.yml` on arm64 for comparing.