Update Readme & clarify scripts

README.md

@@ -7,8 +7,18 @@ Based on https://github.com/MOVE-II/move2radio.
 
 This container uses no blobs to build, however some proprietary code is needed. The distributed docker images only contain binary assets, this is achieved using docker multi-stage builds. The proprietary code is currently hosted at the LRZ GitLab by the MOVE-II team, and an older private mirror exists at the CHRZ Git server. It is forbidden to redistribute the proprietary code without permission, however binary assets compiled from it may be redistributed.
 
-## Usage
+## Download
-Use the scripts from the `scripts` directory to control the docker containers. Each script takes a parameter to configure the mode, either `gui` or `cli`.
+User Docker to download the precompiled binaries: `docker pull registry.chrz.de/redsat/move2docker`. This image is multi-arch and Docker will automatically select the correct sub-image based on the current architecture.
 
-## Configuration
+## Usage
+Starting the container without any arguments opens a shell into the container. You can override the default entrypoint (`/app/run-cli.sh`) using `docker run --entrypoint "/app/run-gui.sh" ...`, which launches the GNURadio companion on start. The same behavior can be achieved by executing `gnuradio-companion` in the CLI session.
+
+The GUI container needs to know which X11 server to connect to, this can be configured using `docker run --env DISPLAY=host.docker.internal:0.0 ...` when using Docker Desktop for Windows or OS X. On Linux `host.docker.internal` cannot be resolved so there you have to use something like `$(docker network inspect bridge --format='{{(index .IPAM.Config 0).Gateway}}')` (The gateway address of the `docker0` bridge interface) or its IP address directly like `172.17.0.1`, but note that your configuration may differ.
+
+## Development
+Use the `scripts/*-dev.sh` to build and run the docker container for local development. The other scripts will download and run the precompiled image.
+
+The public docker image is built by the CI server using the `master` branch of this repository. Please use the `dev` branch for local development.
+
+### Proprietary Code Server Configuration
 Configure the proprietary code server using the file `config/config.sh` (see or copy `config/config.sh.example*`), and place or link your private key for the server access (`id_rsa`) there as well. Note that this key should not be protected with a password.

scripts/build-dev.sh

@@ -7,4 +7,4 @@ export PROP_SERVER_KEY=$(cat ./config/id_rsa)
 docker build \
     --build-arg PROP_SERVER --build-arg PROP_SERVER_USER \
     --build-arg PROP_SERVER_KEY --build-arg PROP_DIR_SDR --build-arg PROP_DIR_DECODER \
-    -t registry.chrz.de/redsat/move2docker:$(arch) .
+    -t move2docker:dev-$(arch) .

scripts/buildx.sh

@@ -1,11 +0,0 @@
-#!/bin/bash
-
-cd "${0%/*}/.."
-source ./config/config.sh
-export PROP_SERVER_KEY=$(cat ./config/id_rsa)
-
-docker buildx build \
-    --platform linux/amd64,linux/arm64,linux/arm/v7 \
-    --build-arg PROP_SERVER --build-arg PROP_SERVER_USER \
-    --build-arg PROP_SERVER_KEY --build-arg PROP_DIR_SDR --build-arg PROP_DIR_DECODER \
-    -t registry.chrz.de/redsat/move2docker .

scripts/pull.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
 
-docker pull registry.chrz.de/redsat/move2docker:$(arch)
+docker pull registry.chrz.de/redsat/move2docker

scripts/push.sh

@@ -1,3 +0,0 @@
-#!/bin/bash
-
-docker push registry.chrz.de/redsat/move2docker:$(arch)

scripts/run-dev.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+cd "${0%/*}/.."
+source ./config/config.sh
+
+docker run -it --rm \
+    -v $(pwd)/data:/app/data:rw \
+    --env DISPLAY=host.docker.internal:0.0 \
+    move2docker:dev-$(arch)

scripts/run.sh

@@ -6,4 +6,4 @@ source ./config/config.sh
 docker run -it --rm \
     -v $(pwd)/data:/app/data:rw \
     --env DISPLAY=host.docker.internal:0.0 \
-    registry.chrz.de/redsat/move2docker:$(arch)
+    registry.chrz.de/redsat/move2docker