Add docs for setting up Steam Headless on Intel GPU with docker-compose
This commit is contained in:
41
docs/compose-files/.env
Normal file
41
docs/compose-files/.env
Normal file
@@ -0,0 +1,41 @@
|
||||
# Docker config
|
||||
## DOCKER_RUNTIME:
|
||||
## Options: ['runc', 'nvidia']
|
||||
## Description: The name of an implementation of OCI Runtime Spec
|
||||
## Available runtimes are listed when you run `docker info`.
|
||||
## Your system may have other options available. As a simple rule, if you are
|
||||
## using an NVIDIA GPU, set this to 'nvidia' for anything else, set this to 'runc'.
|
||||
DOCKER_RUNTIME='runc'
|
||||
|
||||
# Container mode config
|
||||
## MODE:
|
||||
## Options: ['primary', 'secondary']
|
||||
## Description: Steam Headless containers can run in a secondary mode that will only start
|
||||
## a Steam process that will then use the X server of either the host or another
|
||||
## Steam Headless container running in 'primary' mode.
|
||||
MODE='primary'
|
||||
## WEB_UI_MODE:
|
||||
## Options: ['vnc', 'neko', 'none']
|
||||
## Description: Configures the WebUI to use for accessing the virtual desktop.
|
||||
WEB_UI_MODE='vnc'
|
||||
## ENABLE_VNC_AUDIO:
|
||||
## Options: ['true', 'false']
|
||||
## Description: Enables audio over for the VNC Web UI if 'WEB_UI_MODE' is set to 'vnc'.
|
||||
ENABLE_VNC_AUDIO='true'
|
||||
|
||||
# Default user config
|
||||
PUID='1000'
|
||||
PGID='1000'
|
||||
UMASK='000'
|
||||
USER_PASSWORD='password'
|
||||
|
||||
# System config
|
||||
HOSTNAME='SteamHeadless'
|
||||
TZ='Pacific/Auckland'
|
||||
USER_LOCALES='en_US.UTF-8 UTF-8'
|
||||
DISPLAY=':55'
|
||||
SHM_SIZE='2G'
|
||||
|
||||
# Nvidia specific config (not required for non Nvidia GPUs)
|
||||
NVIDIA_DRIVER_CAPABILITIES='all'
|
||||
NVIDIA_VISIBLE_DEVICES='all'
|
||||
38
docs/compose-files/docker-compose.intel.yml
Normal file
38
docs/compose-files/docker-compose.intel.yml
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
services:
|
||||
steam-headless:
|
||||
image: josh5/steam-headless:latest
|
||||
restart: unless-stopped
|
||||
runtime: ${DOCKER_RUNTIME}
|
||||
## NOTE: Requires privileged access to host to be able to access the required devices
|
||||
privileged: true
|
||||
shm_size: ${SHM_SIZE}
|
||||
ipc: host # Could also be set to 'shareable'
|
||||
ulimits:
|
||||
nofile:
|
||||
soft: 1024
|
||||
hard: 524288
|
||||
|
||||
# NETWORK:
|
||||
## NOTE: Steam headless always required the use of the host network
|
||||
network_mode: host
|
||||
hostname: ${HOSTNAME}
|
||||
extra_hosts:
|
||||
- "${HOSTNAME}:127.0.0.1"
|
||||
|
||||
# ENVIRONMENT:
|
||||
## Read all config variables from the .env file
|
||||
env_file: .env
|
||||
|
||||
# VOLUMES:
|
||||
volumes:
|
||||
# The location of your home directory.
|
||||
- /opt/container-data/steam-headless/home/:/home/default/:rw
|
||||
# The location where all games should be installed.
|
||||
- /mnt/Games/:/mnt/games/:rw
|
||||
# Input devices used for mouse and joypad support inside the container.
|
||||
- /dev/input/:/dev/input/:ro
|
||||
# The Xorg socket. This will be shared with other containers so they can access the X server.
|
||||
- /opt/container-data/steam-headless/.X11-unix/:/tmp/.X11-unix/:rw
|
||||
# Pulse audio socket. This will be shared with other containers so they can access the audio sink.
|
||||
- /opt/container-data/steam-headless/pulse/:/tmp/pulse/:rw
|
||||
Reference in New Issue
Block a user