{"id":16293270,"url":"https://github.com/jackblk/battlebit-server-docker","last_synced_at":"2025-07-24T17:07:05.616Z","repository":{"id":191529423,"uuid":"684838802","full_name":"jackblk/battlebit-server-docker","owner":"jackblk","description":"Battlebit Dedicated Server in Docker","archived":false,"fork":false,"pushed_at":"2023-09-03T13:17:20.000Z","size":21,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-15T05:12:36.827Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jackblk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2023-08-30T00:44:11.000Z","updated_at":"2024-06-25T02:01:09.000Z","dependencies_parsed_at":"2024-10-10T20:20:46.086Z","dependency_job_id":null,"html_url":"https://github.com/jackblk/battlebit-server-docker","commit_stats":null,"previous_names":["jackblk/battlebit-server-docker"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jackblk%2Fbattlebit-server-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jackblk%2Fbattlebit-server-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jackblk%2Fbattlebit-server-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jackblk%2Fbattlebit-server-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jackblk","download_url":"https://codeload.github.com/jackblk/battlebit-server-docker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248026955,"owners_count":21035585,"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":[],"created_at":"2024-10-10T20:10:41.447Z","updated_at":"2025-04-09T10:46:59.239Z","avatar_url":"https://github.com/jackblk.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BattleBit Server Docker\n\n## Caution\n\nHosting Battlebit on Linux is HIGHLY EXPERIMENTAL :warning:\n\n## How to run\n\n* Copy `.env.example` to `config` folder and rename it to `.env`\n* Copy `server.conf.example` to `config` folder and rename it to `server.conf`\n* Edit `.env` and `server.conf` to your liking\n* (Optional) Login with 2FA, see below\n* (Optional) If you use custom API from [BattleBitAPIRunner](https://github.com/BattleBit-Community-Servers/BattleBitAPIRunner), see below\n* **IMPORTANT** Create data folders with the right permission: `mkdir -p data/Steam data/battlebit \u0026\u0026 chown 1000:1000 -R data`\n* Run `docker compose up -d` or `make` to start the server\n* Run `docker compose down -v` or `make stop-server` to stop the server\n\n### Notes\n\n* This docker image uses `steam` user (non-root), has ID: `1000:1000`. If you encounter permission issues for `data` folder,\nremove the `data` folder and re-create it with the right permisison.\n* Server should have 2 ports open:\n  * Game port (default: 30000/udp)\n  * `Query port = Game port + 1` (default: 30001/udp)\n* If your server is behind NAT, you need to forward these ports to your server\n* If you want to use a custom API endpoint, edit in `server.conf` accordingly\n\n### (Optional) Login with 2FA\n\nYou only need to do this at the first time, and only when the login session is expired.\n\n```shell\ndocker run --rm -it \\\n  --name battlebit-docker \\\n  -v $(pwd)/data/battlebit:/home/steam/battlebit \\\n  -v $(pwd)/data/Steam:/home/steam/Steam \\\n  --env-file ./config/.env \\\n  ghcr.io/jackblk/battlebit-server-docker bash login.sh\n```\n\n### Accept EULA\n\nRun this while the container is running: `make accept-eula`\n\nOr:\n\n```shell\ndocker exec -it battlebit-server-docker sed -i 's/false/true/g' /home/steam/battlebit/eula.txt\n```\n\n### BattleBitAPIRunner\n\n* Create data folder for BattleBitAPIRunner:\n\n```shell\nmkdir -p config/runner/data/modules config/runner/data/dependencies config/runner/data/configurations\ncp appsettings.json.example config/runner/appsettings.json\nchown 1000:1000 -R config/runner\n```\n\n* Refer [Hosting Guide](https://github.com/BattleBit-Community-Servers/BattleBitAPIRunner/wiki/Hosting-Guide) to create folders \u0026 files accordingly:\n  * `appsettings.json`\n  * `data/modules/...`\n  * `data/dependencies/...`\n  * `data/configurations/...`\n* Edit `ApiEndpoint=battlebit-runner:29999` in `server.conf` to use custom API endpoint\n* Edit in `battlebit-runner` service in `docker-compose.yml` if you need to:\n  * Expose/change port\n  * Change volume path\n  * Override `appsettings.json` file\n\n## Credits\n\n* [DasIschBims/BattleBitDocker](https://github.com/DasIschBims/BattleBitDocker)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjackblk%2Fbattlebit-server-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjackblk%2Fbattlebit-server-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjackblk%2Fbattlebit-server-docker/lists"}