Skip to content

Commit

Permalink
[composition] Add HIVEMIND_CONFIG_PHAL_FOLDER and OVOS_CONFIG_PHAL_FO…
Browse files Browse the repository at this point in the history 
…LDER variables
  • Loading branch information
@goldyfruit
goldyfruit committed Jan 19, 2024
1 parent 7640a53 commit 9a84d6b
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 21 deletions.
42 changes: 22 additions & 20 deletions docs/getting-started/docker/composition.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,26 +28,28 @@ A Docker or Podman environment file contains lines about environment variables t

Some variables might need to be tuned to match your setup such as the `TZ`, `XDG_RUNTIME_DIR`, etc...

| Variable | Default | Platforms | Description |
| ------------------------ | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
| `DISPLAY` | `:0` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } | Display used by X or Wayland |
| `GPIO_GID` | `997` | :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } | `gpio` group ID on Raspberry Pi |
| `HIVEMIND_CONFIG_FOLDER` | `~/hivemind/config` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | HiveMind configuration directory |
| `HIVEMIND_SHARE_FOLDER` | `~/hivemind/share` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | HiveMind shared directory |
| `HIVEMIND_USER` | `hivemind` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | User running in the container |
| `I2C_GID` | `994` | :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } | `i2c` group ID on Raspberry Pi |
| `INPUT_GID` | `102` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } | `input` group ID |
| `OVOS_CONFIG_FOLDER` | `~/ovos/config` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | OVOS configureation directory |
| `OVOS_SHARE_FOLDER` | `~/ovos/share` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | OVOS shared directory |
| `OVOS_USER` | `ovos` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | User running in the container |
| `PULL_POLICY` | `always` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | Policy to pull Docker images |
| `RENDER_GID` | `106` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } | `render` group ID |
| `SPI_GID` | `995` | :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } | `spi` group ID on Raspberry Pi |
| `TMP_FOLDER` | `~/ovos/tmp` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | OVOS temporary directory |
| `TZ` | `America/Montreal` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | Timezone to set in the container |
| `VERSION` | `alpha` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | Container image tag to pull |
| `VIDEO_GID` | `44` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } | `video` group ID |
| `XDG_RUNTIME_DIR` | `/run/user/1000` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | Path to XDG runtime directory |
| Variable | Default | Platforms | Description |
| ----------------------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| `DISPLAY` | `:0` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } | Display used by X or Wayland |
| `GPIO_GID` | `997` | :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } | `gpio` group ID on Raspberry Pi |
| `HIVEMIND_CONFIG_FOLDER` | `~/hivemind/config` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | HiveMind configuration directory |
| `HIVEMIND_CONFIG_PHAL_FOLDER` | `~/hivemind/config/phal` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | HiveMind PHAL configuration directory |
| `HIVEMIND_SHARE_FOLDER` | `~/hivemind/share` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | HiveMind shared directory |
| `HIVEMIND_USER` | `hivemind` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | User running in the container |
| `I2C_GID` | `994` | :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } | `i2c` group ID on Raspberry Pi |
| `INPUT_GID` | `102` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } | `input` group ID |
| `OVOS_CONFIG_FOLDER` | `~/ovos/config` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | OVOS configureation directory |
| `OVOS_CONFIG_PHAL_FOLDER` | `~/ovos/config/phal` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | OVOS PHAL configureation directory |
| `OVOS_SHARE_FOLDER` | `~/ovos/share` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | OVOS shared directory |
| `OVOS_USER` | `ovos` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | User running in the container |
| `PULL_POLICY` | `always` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | Policy to pull Docker images |
| `RENDER_GID` | `106` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } | `render` group ID |
| `SPI_GID` | `995` | :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } | `spi` group ID on Raspberry Pi |
| `TMP_FOLDER` | `~/ovos/tmp` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | OVOS temporary directory |
| `TZ` | `America/Montreal` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | Timezone to set in the container |
| `VERSION` | `alpha` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-apple:{ .lg title="Mac OS" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | Container image tag to pull |
| `VIDEO_GID` | `44` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } | `video` group ID |
| `XDG_RUNTIME_DIR` | `/run/user/1000` | :fontawesome-brands-linux:{ .lg title="Linux" } :fontawesome-brands-raspberry-pi:{ .lg title="Raspberry Pi" } :fontawesome-brands-windows:{ .lg title="Windows WSL2" } | Path to XDG runtime directory |

!!! bug "Do not change `OVOS_USER` or `HIVEMIND_USER`"

Expand Down
4 changes: 3 additions & 1 deletion docs/getting-started/docker/installation/requirements.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The `~/hivemind` directory is only required if you plan to use [HiveMind](../../

```shell
git clone https://github.com/OpenVoiceOS/ovos-docker.git ~/ovos-docker
mkdir -p ~/ovos/{config,share,tmp} ~/hivemind/{config,share}
mkdir -p ~/ovos/{config/phal,share,tmp} ~/hivemind/{config/phal,share}
chown ${USER}:${USER} -R ~/ovos ~/hivemind
cd ~/ovos-docker/compose
```
Expand Down Expand Up @@ -50,10 +50,12 @@ Below is an example of `.env` for Linux _(not Raspberry Pi)_, please read [this
```ini title=".env"
DISPLAY=:0
HIVEMIND_CONFIG_FOLDER=~/hivemind/config
HIVEMIND_CONFIG_PHAL_FOLDER=~/hivemind/config/phal
HIVEMIND_SHARE_FOLDER=~/hivemind/share
HIVEMIND_USER=hivemind
INPUT_GID=102
OVOS_CONFIG_FOLDER=~/ovos/config
OVOS_CONFIG_PHAL_FOLDER=~/ovos/config/phal
OVOS_SHARE_FOLDER=~/ovos/share
OVOS_USER=ovos
PULL_POLICY=always
Expand Down

0 comments on commit 9a84d6b

Please sign in to comment.