{"id":13552291,"url":"https://github.com/Steam-Headless/docker-steam-headless","last_synced_at":"2025-04-03T03:31:18.376Z","repository":{"id":37919238,"uuid":"446364569","full_name":"Steam-Headless/docker-steam-headless","owner":"Steam-Headless","description":"A Headless Steam Docker image supporting NVIDIA GPU and accessible via Web UI","archived":false,"fork":false,"pushed_at":"2025-02-05T19:01:44.000Z","size":3923,"stargazers_count":1354,"open_issues_count":59,"forks_count":112,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-02-05T20:28:35.968Z","etag":null,"topics":["docker","gameserver","gamestream","hacktoberfest","moonlight","steam","sunshine"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Steam-Headless.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"Josh5","patreon":"Josh5","open_collective":null,"ko_fi":"josh5coffee","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2022-01-10T09:49:01.000Z","updated_at":"2025-02-05T19:01:49.000Z","dependencies_parsed_at":"2024-05-08T06:29:54.639Z","dependency_job_id":"e6922157-a69d-42d8-85c7-ff99eab67aed","html_url":"https://github.com/Steam-Headless/docker-steam-headless","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Steam-Headless%2Fdocker-steam-headless","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Steam-Headless%2Fdocker-steam-headless/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Steam-Headless%2Fdocker-steam-headless/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Steam-Headless%2Fdocker-steam-headless/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Steam-Headless","download_url":"https://codeload.github.com/Steam-Headless/docker-steam-headless/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246933398,"owners_count":20857047,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","gameserver","gamestream","hacktoberfest","moonlight","steam","sunshine"],"created_at":"2024-08-01T12:02:01.834Z","updated_at":"2025-04-03T03:31:13.348Z","avatar_url":"https://github.com/Steam-Headless.png","language":"Shell","funding_links":["https://github.com/sponsors/Josh5","https://patreon.com/Josh5","https://ko-fi.com/josh5coffee"],"categories":["Shell"],"sub_categories":[],"readme":"# Headless Steam Service\n\n![](./images/banner.jpg)\n\nRemote Game Streaming Server.\n\nPlay your games either in the browser with audio or via Steam Link or Moonlight. Play from another Steam Client with Steam Remote Play.\n\nEasily deploy a Steam Docker instance in seconds.\n\n## Features:\n- Steam Client configured for running on Linux with Proton\n- Moonlight compatible server for easy remote desktop streaming\n- One click installation of EmeDeck, Heroic and Lutris\n- Full video/audio noVNC web access to a Xfce4 Desktop\n- NVIDIA, AMD and Intel GPU support\n- Full controller support\n- Support for Flatpak and Appimage installation\n- Root access\n- Based on Debian Bookworm\n\n---\n## Notes:\n\n### ADDITIONAL SOFTWARE:\nIf you wish to install additional applications, you can generate a script inside the `~/init.d` directory ending with \".sh\".\nThis will be executed on the container startup.\n\n### STORAGE PATHS:\nEverything that you wish to save in this container should be stored in the home directory or a docker container mount that you have specified. \nAll 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.\n\n### GAMES LIBRARY:\nIt is recommended that you mount your games library to `/mnt/games` and configure Steam to add that path.\n\n### AUTO START APPLICATIONS:\nIn this container, Steam is configured to automatically start. If you wish to add additional services to automatically start, \nadd them under **Applications \u003e Settings \u003e Session and Startup** in the WebUI.\n\n### NETWORK MODE:\nIf 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.\n\n### USING HOST X SERVER:\nIf your host is already running X, you can just use that. To do this, be sure to configure:\n  - DISPLAY=:0    \n    **(Variable)** - *Configures the sceen to use the primary display. Set this to whatever your host is using*\n  - MODE=secondary    \n    **(Variable)** - *Configures the container to not start an X server of its own*\n  - HOST_DBUS=true    \n    **(Variable)** - *Optional - Configures the container to use the host dbus process*\n  - /run/dbus:/run/dbus:ro    \n    **(Mount)**  - *Optional - Configures the container to use the host dbus process*\n\n\n---\n## Installation:\n- [Docker Compose](./docs/docker-compose.md)\n- [Unraid](./docs/unraid.md)\n- [Ubuntu Server](./docs/ubuntu-server.md)\n\n\n---\n## Running locally:\n\nFor a development environment, I have created a script in the devops directory.\n\n\n---\n## TODO:\n- Remove SSH\n- Require user to enter password for sudo\n- Document how to run this container:\n    - Other server OS\n    - TrueNAS Scale \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSteam-Headless%2Fdocker-steam-headless","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSteam-Headless%2Fdocker-steam-headless","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSteam-Headless%2Fdocker-steam-headless/lists"}