diff --git a/README.md b/README.md index 56bdfc26e50a7f6c0a2940e74ca02f1f035e28b8..b1eec5533eff4a16ef8bad120eb262cf96eded04 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,25 @@ ansible-pull -U https://code.fbi.h-da.de/pse-ai-at-the-edge/raspberry-pi-setup.g # Notes +## Changing optional settings + +There are a bunch of optional settings in the script with default values that can be changed if needed. When running the script on a normal Pi with the default user, there is no need to change any of those. + +The configurable options are the following: + +| Variable name | Default value | Description | +|:----------------------|:--------------|:------------| +| target_user | pi | Setup for a specified user | +| jupyter_service | true | Setup a systemd service to autostart jupyterlab in the background | +| jupyter_start | true | Don't start jupyterlab directly | +| ignore_python_version | false | Ignore the python version check (**not recommended**) | +| ignore_architecture | false | Ignore the architecture check (**not recommended**) | + +To change any of these values add `-e "[var1]=[value1] [var2]=[value2]"` to the `ansible-pull` command. + +**Important:** To set a value to `false` use `-e [var]=''` and **not** `-e [var]=false`. This is necessary due to ansible interpreting all extra-vars as strings. + + ## Raspberry Pi OS Version and Architecture This current version of the playbook will install a prebuilt `tensorflow-2.7` wheel that only works on `Python3.9` and the `Aarch64` architecture. That means for now the playbook **only works on Raspberry Pi OS 11 64-bit**