From 8732aba816668c7128595488d035aefcdecf9b7f Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Fri, 28 Sep 2018 10:38:27 -0400 Subject: [PATCH] Buff readme --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5252cc65c3..d7c3594163 100644 --- a/README.md +++ b/README.md @@ -38,10 +38,11 @@ Note that tgstation-server has only ever been tested on Linux via it's [docker e tgstation-server supports running in a docker container and is the recommended deployment method for Linux systems due being the only robustly tested environment. The official image repository is located at https://hub.docker.com/r/tgstation/server. It can also be built locally by running `docker build . -f build/Dockerfile` in the repository root. To create a container run -``` +```sh docker create \ --restart=always \ #if you want maximum uptime --network="host" \ #if your sql server is on the same machine + --name="tgs" \ #or whatever else you wanna call it -p :80 \ -p 0.0.0.0:: \ -v /path/to/store/instances:/tgs4_instances \ @@ -53,6 +54,8 @@ with any additional options you desire (i.e. You'll have to expose more game por Note although `/app/lib` is specified as a volume mount point in the `Dockerfile`, unless you REALLY know what you're doing. Do not mount any volumes over this for fear of breaking your container. +Before starting your container make sure the aforemention `appsettings.Production.json` is configured properly. See below + ### Configuring Create an `appsettings.Production.json` file next to `appsettings.json`. This will override the default settings in appsettings.json with your production settings. There are a few keys meant to be changed by hosts. Modifying any config files while the server is running will trigger a safe restart (Keeps DreamDaemon's running). Note these are all case-sensitive: @@ -87,6 +90,8 @@ For the Windows service version start the `tgstation-server-4` service. If it fa For the console version run `dotnet Tgstation.Server.Host.Console.dll` in the installation directory. The `tgs.bat` and `tgs.sh` shell scripts are shortcuts for this. If on Windows and you wish to install byond versions >= 512.1427 you must do this as admin to give the server permission to install the required DirectX dependency +For the docker version run `docker start tgs` + ### Stopping Note that the live detach for DreamDaemon servers is only supported for updates or restarts via the API at this time. Stopping tgstation-server will TERMINATE ALL CHILD DREAMDAEMON SERVERS. @@ -95,6 +100,8 @@ For the Windows service version stop the `tgstation-server-4` service For the console version press `Ctrl+C` or send a SIGQUIT to the ORIGINAL dotnet process +For the docker version run `docker stop tgs` + ## Integrating A breaking change from V3: tgstation-server 4 now REQUIRES the DMAPI to be integrated into any BYOND codebase which plans on being used by it. The integration process is a fairly simple set of code changes.