c7a10d6d35
* Add a simple docker-compose setup into tools (#66932) About The Pull Request Because I noticed overtime that I kept using my docker-compose.yml setup for spinning up small servers to try features on or mess around on in general. I thought I'd polish it a bit and add it into the tools/ directory for others to use as well. Not sure if it will be useful for anyone other than myself but hey! Might as well share this. Please note, this is my first PR, feel free to give critique where critique is due. Or let me know if this is an absolute dogshit PR, that is welcome too, go wild. Note: Priority of overrides is as following (1 taking highest priority and the rest is lower priority) Environment variable overrides Override files in the gamecfg/ folder Default configuration found under /config Why It's Good For The Game Mainly good for developers or people who want to spin up their own server to try stuff on, I was personally missing something like this in the repository and think others might be able to use it to rapidly spin up their own server in a container using the provided Dockerfile in the main repository. * Add a simple docker-compose setup into tools Co-authored-by: Melli <75690100+mel-byond@users.noreply.github.com>
Docker-Compose Test Server
This is a directory made for easily spinning up a /tg/station server using Docker-Compose. Also with some tweaks done to read environment variables, like database config and ranks.
How to use this?
Prerequisites:
- Docker and
docker-composeinstalled - Text editor
- Basic knowledge about the CLI and containers
Quickstart:
- Open a terminal (bash,powershell,cmd,whatever)
- Clone the /tg/station repository ( CLI:
git clone https://github.com/tgstation/tgstation) - Enter this directory (
cd tgstation/tools/DockerTestServer) - Make a copy of the
example.envfile and call it.env(cp example.env .env) - Edit the values in
.env(the content and commented out sections, seriously, read it) - When all and dandy, start the server by doing
docker-compose up
After this, you should be able to connect over to your server by opening BYOND and joining your game with an URL that looks like this byond://localhost:1337 or if you are hosting this on another device byond://192.168.1.25:1337 or whatever that device's IP or domain is.
Turning off the server:
Same directory as before in the terminal, try docker-compose down
This should turn it off until the next time you turn it on using docker-compose up
Overriding configuration files
Since you might need to tweak game_options.txt or any other file in the /config folder.
This setup allows you to slap those files right into the ./gamecfg folder for overriding files. Just copy the file you want to override into this directory and the entrypoint.sh should apply it during start-up!
Remember to properly take down the container ( docker-compose down ) if you have issues with recent changes not syncronizing after restart.