Merge pull request #167 from nextcloud/enh/28/add-docs-for-arm64

add docs for arm64

Author: szaimen

develop.md

@@ -14,40 +14,24 @@ nextcloud/all-in-one:develop
 And you are done :)
 It will now also select the developer channel for all other containers automatically.
 
-## How to promote builds from develop to latest
-
-<!---
-You can use the Docker CLI to promote builds from develop to latest. Make sure to adjust:
+## How to build new containers
 
-- $name
-- $digest
+Go to https://github.com/nextcloud-releases/all-in-one/actions/workflows/repo-sync.yml and run the workflow that will first sync the repo and then build new container that automatically get published to `develop` and `develop-arm64`.
 
-```shell
-export AIO_NAME=$name
-export AIO_DIGEST=$digest
-docker pull nextcloud/$AIO_NAME@sha256:$AIO_DIGEST
-docker tag nextcloud/$AIO_NAME@sha256:$AIO_DIGEST nextcloud/$AIO_NAME\:latest
-docker push nextcloud/$AIO_NAME\:latest
-```
---->
+## How to promote builds from develop to latest
 
 To automatically promoted the latest develop version you can use the following script:
 
 **WARNING:** Make sure to verify that the latest develop tag is what you really want to deploy since someone could have pushed to main and created a new container in between.
 ```shell
-# x64
+# Set the name of the container that you want to promote from the develop- to the latest channels
 export AIO_NAME=$name
+# x64
 docker pull nextcloud/$AIO_NAME\:develop
 docker tag nextcloud/$AIO_NAME\:develop nextcloud/$AIO_NAME\:latest
 docker push nextcloud/$AIO_NAME\:latest
-```
-
-**ATTENTION**: don't run the script below since the arm64 containers currently don't work!
-```shell
 # arm64 
-export AIO_NAME=$name
 docker pull nextcloud/$AIO_NAME\:develop-arm64
 docker tag nextcloud/$AIO_NAME\:develop-arm64 nextcloud/$AIO_NAME\:latest-arm64
 docker push nextcloud/$AIO_NAME\:latest-arm64
 ```
-Later when the arm64 containers work, we can simply publish to latest and latest-arm64 in a rush by providing the name one time at the top of the script.

readme.md

@@ -15,29 +15,56 @@ Included are:
 **Found a bug?** Please file an issue at https://github.com/nextcloud/all-in-one
 
 ## How to use this?
-1. Install Docker on your Linux installations using:
-
-```
-curl -fsSL get.docker.com | sudo sh
-```
+1. Install Docker on your Linux installation using:
+    ```
+    curl -fsSL get.docker.com | sudo sh
+    ```
 2. Make sure to pull the latest image:
+    ```
+    # For x64 CPUs:
+    sudo docker pull nextcloud/all-in-one:latest
+    ```
+    <details>
+    <summary>Command for arm64 CPUs like the Raspberry Pi 4</summary>
+
+    ```
+    # For arm64 CPUs:
+    sudo docker pull nextcloud/all-in-one:latest-arm64
+    ```
+
+    </details>
 
-```
-sudo docker pull nextcloud/all-in-one:latest
-```
 3. Run the following command in order to start the container:
+    ```
+    # For x64 CPUs:
+    sudo docker run -it \
+    --name nextcloud-aio-mastercontainer \
+    --restart always \
+    -p 80:80 \
+    -p 8080:8080 \
+    -p 8443:8443 \
+    --volume nextcloud_aio_mastercontainer:/mnt/docker-aio-config \
+    --volume /var/run/docker.sock:/var/run/docker.sock:ro \
+    nextcloud/all-in-one:latest
+    ```
+    <details>
+    <summary>Command for arm64 CPUs like the Raspberry Pi 4</summary>
+
+    ```
+    # For arm64 CPUs:
+    sudo docker run -it \
+    --name nextcloud-aio-mastercontainer \
+    --restart always \
+    -p 80:80 \
+    -p 8080:8080 \
+    -p 8443:8443 \
+    --volume nextcloud_aio_mastercontainer:/mnt/docker-aio-config \
+    --volume /var/run/docker.sock:/var/run/docker.sock:ro \
+    nextcloud/all-in-one:latest-arm64
+    ```
+
+    </details>
 
-```
-sudo docker run -it \
---name nextcloud-aio-mastercontainer \
---restart always \
--p 80:80 \
--p 8080:8080 \
--p 8443:8443 \
---volume nextcloud_aio_mastercontainer:/mnt/docker-aio-config \
---volume /var/run/docker.sock:/var/run/docker.sock:ro \
-nextcloud/all-in-one:latest
-```
 4. After the initial startup, you should be able to open the Nextcloud AIO Interface now on port 8080 of this server.<br>
 E.g. https://internal.ip.of.this.server:8080<br>
 If your server has port 80 and 8443 open and you point a domain to your server, you can get a valid certificate automatially by opening the Nextcloud AIO Interface via:<br>