Files
docker-steam-headless/docs/docker-compose.md
2022-10-04 17:50:27 +13:00

42 lines
1.3 KiB
Markdown

# Docker Compose
Follow these instructions to configure a docker-compose.yml for your system.
> __Note__
>
> These instructions assume that you have docker and docker-compose installed for your system.
>
> Depending on how you have installed this, the commands to execute docker compose may vary.
## PREPARE DIRECTORY:
> __Warning__
>
> These commands are meant to be run as your user. Do not run them as root.
>
> If you do run these commands as root, you may need to manually fix the permissions and ownership after.
Create a directory for your service:
```
sudo mkdir -p /opt/container-services/steam-headless
sudo chown -R $(id -u):$(id -g) /opt/container-services/steam-headless
```
Create a directory for your service config data:
```
sudo mkdir -p /opt/container-data/steam-headless/{home,.X11-unix,pulse}
sudo chown -R $(id -u):$(id -g) /opt/container-data/steam-headless
```
Create a Steam Headless `/opt/container-services/steam-headless/docker-compose.yml` file.
Populate this file with the contents of the default [Docker Compose File](./compose-files/docker-compose.default.yml).
## CONFIGURE ENV:
Create a Steam Headless `/opt/container-services/steam-headless/.env` file with the contents found in this example [Environment File](./compose-files/.env).
Edit these variables as required.