docker-steam-headless - GitLite

KO | EN

gitlite — search

#javascript #python #react #ai #typescript #android #machine-learning #rust #deep-learning #awesome #cli #kubernetes #mcp #open-source

docker-steam-headless

(★ 4,716)

A Headless Steam Docker image supporting NVIDIA GPU and accessible via Web UI

File Explorer

Download Latest Version (.zip)

- - BUG-REPORT.yml
  - config.yml
  - DOCUMENTATION.yml
  - FEATURE-REQUEST.yml
- - build_ci.yml
  - issues-stale.yml
  - issues.yml
- FUNDING.yml
- label-actions.yml
- - .env
  - docker-compose.amd+intel.privileged.yml
  - docker-compose.amd+intel.yml
  - docker-compose.nvidia.privileged.yml
  - docker-compose.nvidia.yml
- - disk_write_error.png
  - install-steam-headless-unraid-ca.png
  - unraid-amd-plugin.png
  - unraid-nvidia-plugin.png
  - unraid-steam-headless-configure-network-as-host.png
  - unraid-steam-headless-install-uinput-plugin.png
  - unraid-steam-headless-template-nvidia-extra-params.png
  - web_connect.png
- - pvc.yaml
  - statefulset.yaml
- docker-compose.md
- k8s.md
- troubleshooting.md
- ubuntu-server.md
- unraid.md
- banner.jpg
- steam-icon.png
- - supervisord.conf
- entrypoint.sh
.dockerignore
.gitignore
Dockerfile.arch
Dockerfile.debian
LICENSE
README.md

# Installation Guide

1. Get the code

git clone https://github.com/Steam-Headless/docker-steam-headless

Downloads the entire project code from GitHub to your computer.

cd docker-steam-headless

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -f Dockerfile.arch -t docker-steam-headless .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 docker-steam-headless

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Headless Steam Service

![](https://raw.githubusercontent.com/Steam-Headless/docker-steam-headless/master/images/banner.jpg)

Remote Game Streaming Server.

Play your games either in the browser with audio or via Steam Link or Moonlight. Play from another Steam Client with Steam Remote Play.

Easily deploy a Steam Docker instance in seconds.

## Features:
- Steam Client configured for running on Linux with Proton
- Moonlight compatible server for easy remote desktop streaming
- Easy installation of EmeDeck, Heroic and Lutris via Flatpak
- Full video/audio noVNC web access to a Xfce4 Desktop
- NVIDIA, AMD and Intel GPU support
- Full controller support
- Support for Flatpak and Appimage installation
- Root access
- Based on Debian Trixie

---
## Notes:

### ADDITIONAL SOFTWARE:
If you wish to install additional applications, you can generate a script inside the `~/init.d` directory ending with ".sh".
This will be executed on the container startup.

Also, you can install applications using the WebUI under **Applications > System > Software**. There you can install other game launchers like Lutris, Heroic or EmuDeck.

### STORAGE PATHS:
Everything that you wish to save in this container should be stored in the home directory or a docker container mount that you have specified. 
All files that are store outside your home directory are not persistent and will be wiped if there is an update of the container or you change something in the template.

### GAMES LIBRARY:
It is recommended that you mount your games library to `/mnt/games` and configure Steam to add that path.

### AUTO START APPLICATIONS:
In this container, Steam is configured to automatically start. If you wish to add additional services to automatically start, 
add them under **Applications > Settings > Session and Startup** in the WebUI.

### NETWORK MODE:
If you want to use the container as a Steam Remote Play (previously "In Home Streaming") host device you should create a custom network and assign this container it's own IP, if you don't do this the traffic will be routed through the internet since Steam thinks you are on a different network.

### USING HOST X SERVER:
If your host is already running X, you can just use that. To do this, be sure to configure:
  - DISPLAY=:0    
    **(Variable)** - *Configures the sceen to use the primary display. Set this to whatever your host is using*
  - MODE=secondary    
    **(Variable)** - *Configures the container to not start an X server of its own*
  - HOST_DBUS=true    
    **(Variable)** - *Optional - Configures the container to use the host dbus process*
  - /run/dbus:/run/dbus:ro    
    **(Mount)**  - *Optional - Configures the container to use the host dbus process*

---
## Installation:
- [Docker Compose](./docs/docker-compose.md)
- [Unraid](./docs/unraid.md)
- [Ubuntu Server](./docs/ubuntu-server.md)

---
## Running locally:

For a development environment, I have created a script in the devops directory.

---
## TODO:
- Remove SSH
- Require user to enter password for sudo
- Document how to run this container:
    - Other server OS
    - TrueNAS Scale