Merge pull request #2153 from nicomiguelino/update-build-scripts

* chore: allow support for building of images from the container upgrade script
* docs: update documentation for building images in Pi or x86
* docs: remove unused how-tos

bin/upgrade_containers.sh

@@ -8,9 +8,15 @@ export MY_IP=$(ip -4 route get 8.8.8.8 | awk {'print $7'} | tr -d '\n')
 TOTAL_MEMORY_KB=$(grep MemTotal /proc/meminfo | awk {'print $2'})
 export VIEWER_MEMORY_LIMIT_KB=$(echo "$TOTAL_MEMORY_KB" \* 0.8 | bc)
 export SHM_SIZE_KB="$(echo "$TOTAL_MEMORY_KB" \* 0.3 | bc | cut -d'.' -f1)"
-
 export GIT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
 
+MODE="${MODE:-pull}"
+if [[ ! "$MODE" =~ ^(pull|build)$ ]]; then
+    echo "Invalid mode: $MODE"
+    echo "Usage: MODE=(pull|build) $0"
+    exit 1
+fi
+
 if [ -z "$DOCKER_TAG" ]; then
     export DOCKER_TAG="latest"
 fi
@@ -52,7 +58,7 @@ fi
 
 sudo -E docker compose \
     -f /home/${USER}/screenly/docker-compose.yml \
-    pull
+    ${MODE}
 
 if [ -f /var/run/reboot-required ]; then
     exit 0

docs/developer-documentation.md

@@ -58,73 +58,16 @@ To stop the development server, run the following:
 docker compose -f docker-compose.dev.yml down
 ```
 
-## Building containers locally
+## Building containers on the Raspberry Pi
 
-### Dependencies
-
-#### `buildx`
-
-> [!IMPORTANT]
-> Make sure that you have `buildx` installed and that you have run
-> `docker buildx create --use` before you run the image build script.
-
-#### Poetry
-
-We have switched from using Bash to [Poetry](https://python-poetry.org/) for building the Docker images.
-Make sure that you have Python 3.11 and Poetry installed on your machine.
-
-> [!TIP]
-> You can install Poetry by running the following script:
-> ```bash
-> ./bin/install_poetry.sh
-> ```
->
-> After running the script, you can add the following to your `~/.bashrc` or similar file:
->
-> ```bash
-> # Add `pyenv` to the load path.
-> export PYENV_ROOT="$HOME/.pyenv"
-> [[ -d $PYENV_ROOT/bin ]] && \
->     export PATH="$PYENV_ROOT/bin:$PATH"
-> eval "$(pyenv init -)"
->
-> # Add `poetry to the load path.
-> export PATH="$HOME/.local/bin:$PATH"
->
-> poetry install --only=docker-image-builder
-> ```
->
-> You can either restart your terminal or run `source ~/.bashrc` to start using Poetry.
-
-### Building only specific services
-
-Say that you would only like to build the `anthias-server` and `anthias-viewer`
-services. Just run the following:
-
-```bash
-$ poetry run python tools/image_builder \
-    --service anthias-server \
-    --service anthias-viewer
-```
-
-### Generating only Dockerfiles
-
-If you'd like to just generate the Dockerfiles from the templates provided
-inside the `docker/` directory, run the following:
-
-```bash
-$ poetry run python tools/image_builder \
-  --dockerfiles-only
-```
-
-### Disabling cache mounts
-
-If you'd like to disable cache mounts in the generated Dockerfiles, run the
-following:
+> [!NOTE]
+> Make sure that you have Docker installed on the device before proceeding.
 
 ```bash
-$ poetry run python tools/image_builder \
-  --disable-cache-mounts
+$ ENVIRONMENT=production \
+    ./bin/generate_dev_mode_dockerfiles.sh
+$ MODE=build \
+    ./bin/upgrade_containers.sh
 ```
 
 ## Testing