From 0c16bb42739034c248e4499698b16abdbf0b7a50 Mon Sep 17 00:00:00 2001 From: ZeWaka Date: Thu, 3 Jun 2021 15:11:45 -0700 Subject: [PATCH 1/3] keycloak is a supported provider --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 17cd1a401c..a4e638173c 100644 --- a/README.md +++ b/README.md @@ -142,7 +142,7 @@ Create an `appsettings.Production.yml` file next to `appsettings.yml`. This will - `Swarm:Identifier` should be set uniquely on all swarmed servers. Used to identify the current server. This is also used to select which instances exist on the current machine and should not be changed post-setup. -- `Security:OAuth:`: Sets the OAuth client ID and secret for a given ``. The currently supported providers are `GitHub`, `Discord`, and `TGForums`. Setting these fields to `null` disables logins with the provider, but does not stop users from associating their accounts using the API. Sample Entry: +- `Security:OAuth:`: Sets the OAuth client ID and secret for a given ``. The currently supported providers are `Keycloak`, `GitHub`, `Discord`, and `TGForums`. Setting these fields to `null` disables logins with the provider, but does not stop users from associating their accounts using the API. Sample Entry: ```yml Security: OAuth: From a47978d1bbe77e97a445e1abc97da38dcfbf0e88 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Mon, 7 Jun 2021 20:32:22 -0400 Subject: [PATCH 2/3] Add a note about launching the server console --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index a4e638173c..215ec3a83f 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,8 @@ If you wish to install the TGS as a service, run `Tgstation.Server.Host.Service. Should you want a clean start, be sure to first uninstall the service by running `Tgstation.Server.Host.Service.exe -u` from the command line. +If using the console version, run ./tgs.bat in the root of the installation directory. + #### Linux (Native) We recommend using Docker for Linux installations, see below. The content of this parent section may be skipped if you choose to do so. @@ -44,6 +46,8 @@ The following dependencies are required to run tgstation-server on Linux alongsi - gdb (for using gcore to create core dumps) - gcc-multilib (Only on 64-bit systems) +To launch the server, run ./tgs.sh in the root of the installation directory. The process will run in a blocking fashion. SIQQUIT will close the server, terminating all live game instances. + Note that tgstation-server has only ever been tested on Linux via it's [docker environment](build/Dockerfile#L22). If you are having trouble with something in a native installation, or figure out a required workaround, please contact project maintainers so this documentation may be better updated. #### Docker (Linux) From 4ea5dc7c61482340e943fcc034b0db0877fd2db3 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Mon, 7 Jun 2021 20:34:16 -0400 Subject: [PATCH 3/3] Fix typo. Info about console Ctrl+C on Windows --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 215ec3a83f..489a644e0a 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,8 @@ If you wish to install the TGS as a service, run `Tgstation.Server.Host.Service. Should you want a clean start, be sure to first uninstall the service by running `Tgstation.Server.Host.Service.exe -u` from the command line. -If using the console version, run ./tgs.bat in the root of the installation directory. +If using the console version, run ./tgs.bat in the root of the installation directory. Ctrl+C will close the server, terminating all live game instances. + #### Linux (Native) @@ -46,7 +47,7 @@ The following dependencies are required to run tgstation-server on Linux alongsi - gdb (for using gcore to create core dumps) - gcc-multilib (Only on 64-bit systems) -To launch the server, run ./tgs.sh in the root of the installation directory. The process will run in a blocking fashion. SIQQUIT will close the server, terminating all live game instances. +To launch the server, run ./tgs.sh in the root of the installation directory. The process will run in a blocking fashion. SIGQUIT will close the server, terminating all live game instances. Note that tgstation-server has only ever been tested on Linux via it's [docker environment](build/Dockerfile#L22). If you are having trouble with something in a native installation, or figure out a required workaround, please contact project maintainers so this documentation may be better updated.