diff --git a/_r_e_a_d_m_e_8md_source.html b/_r_e_a_d_m_e_8md_source.html index 241ce3f9f5..597541028e 100644 --- a/_r_e_a_d_m_e_8md_source.html +++ b/_r_e_a_d_m_e_8md_source.html @@ -90,7 +90,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
README.md
-Go to the documentation of this file.
1 # tgstation-server v4:
2 
3 [![Build status](https://ci.appveyor.com/api/projects/status/7t1h7bvuha0p9j5f/branch/master?svg=true)](https://ci.appveyor.com/project/Cyberboss/tgstation-server-tools/branch/master) [![Build Status](https://travis-ci.org/tgstation/tgstation-server.svg?branch=master)](https://travis-ci.org/tgstation/tgstation-server) [![codecov](https://codecov.io/gh/tgstation/tgstation-server/branch/master/graph/badge.svg)](https://codecov.io/gh/tgstation/tgstation-server)
4 
5 [![GitHub license](https://img.shields.io/github/license/tgstation/tgstation-server.svg)](LICENSE) [![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/tgstation/tgstation-server.svg)](http://isitmaintained.com/project/tgstation/tgstation-server "Average time to resolve an issue") [![NuGet version](https://img.shields.io/nuget/v/Tgstation.Server.Api.svg)](https://www.nuget.org/packages/Tgstation.Server.Api) [![NuGet version](https://img.shields.io/nuget/v/Tgstation.Server.Client.svg)](https://www.nuget.org/packages/Tgstation.Server.Client)
6 
7 [![forthebadge](http://forthebadge.com/images/badges/made-with-c-sharp.svg)](http://forthebadge.com) [![forinfinityandbyond](https://user-images.githubusercontent.com/5211576/29499758-4efff304-85e6-11e7-8267-62919c3688a9.gif)](https://www.reddit.com/r/SS13/comments/5oplxp/what_is_the_main_problem_with_byond_as_an_engine/dclbu1a)
8 
9 [![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](http://forthebadge.com) [![forthebadge](http://forthebadge.com/images/badges/60-percent-of-the-time-works-every-time.svg)](http://forthebadge.com)
10 
11 This is a toolset to manage production BYOND servers. It includes the ability to update the server without having to stop or shutdown the server (the update will take effect on a "reboot" of the server) the ability start the server and restart it if it crashes, as well as systems for managing code and game files, and merging GitHub Pull Requests for test deployments.
12 
13 ### Legacy Servers
14 
15 Older server versions can be found in the V# branches of this repository. Note that V4 is nearly fully incompatible with existing installations. Only some static files may be copied over: https://github.com/tgstation/tgstation-server#static-files
16 
17 ## Setup
18 
19 ### Pre-Requisites
20 
21 - [ASP .NET Core Runtime (>= v3.1)](https://dotnet.microsoft.com/download/dotnet-core/current/runtime) (Choose the option to `Run Server Apps` for your system) If you plan to install tgstation-server as a Windows service, you should also ensure that your .NET Framework runtime version is >= v4.7.2 (Download can be found on same page). Ensure that the `dotnet` executable file is in your system's `PATH` variable (or that of the user's that will be running the server).
22 - A [MariaDB](https://downloads.mariadb.org/), MySQL, [PostgresSQL](https://www.postgresql.org/download/), or [Microsoft SQL Server](https://www.microsoft.com/en-us/download/details.aspx?id=55994) database engine is required
23 
24 ### Installation
25 
26 1. [Download the latest V4 release .zip](https://github.com/tgstation/tgstation-server/releases/latest). The `ServerService` package will only work on Windows. Choose `ServerConsole` if that is not your target OS or you prefer not to use the Windows service.
27 2. Extract the .zip file to where you want the server to run from. Note the account running the server must have write and delete access to the `lib` subdirectory.
28 
29 #### Windows
30 
31 If you wish to install the TGS as a service, run `Tgstation.Server.Host.Service.exe`. It should prompt you to install it. Click `Yes` and accept a potential UAC elevation prompt and the setup wizard should run.
32 
33 #### Linux (Native)
34 
35 We recommend using Docker for Linux installations, see below. The content of this parent section may be skipped if you choose to do so.
36 
37 The following dependencies are required to run tgstation-server on Linux alongside the .NET Core runtime
38 
39 - libc6-i386
40 - libstdc++6:i386
41 - libssl1.0.0
42 - gdb (for using gcore to create core dumps)
43 - gcc-multilib (Only on 64-bit systems)
44 
45 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.
46 
47 #### Docker (Linux)
48 
49 tgstation-server supports running in a docker container and is the recommended deployment method for Linux systems. 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 -t <your tag name>` in the repository root.
50 
51 To create a container run
52 ```sh
53 docker run \
54  -ti \ #start interactive for manual configuration
55  --restart=always \ #if you want maximum uptime
56  --network="host" \ #if your sql server is on the same machine
57  --name="tgs" \ #or whatever else you wanna call it
58  --cap-add=sys_nice \ #allows tgs to schedule DreamDaemon as a higher priority process
59  --init \ #reaps potential zombie processes
60  -p <tgs port>:80 \
61  -p 0.0.0.0:<public game port>:<public game port> \
62  -v /path/to/your/configfile/directory:/config_data \ #only if you want to use manual configuration
63  -v /path/to/store/instances:/tgs4_instances \
64  -v /path/to/your/log/folder:/tgs_logs \
65  tgstation/server:<release version> #replace this with <your tag name> if you built the image locally
66 ```
67 with any additional options you desire (i.e. You'll have to expose more game ports in order to host more than one instance).
68 
69 - Important note about port exposure: The internal port used by DreamDaemon _**MUST**_ match the port you want users to connect on. If it doesn't, you'll still be able to have them connect HOWEVER links from the BYOND hub will point at what DreamDaemon thinks the port is.
70 
71 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.
72 
73 The configuration option `General:ValidInstancePaths` will be preconfigured to point to `/tgs4_instances`. It is recommended you don't change this.
74 
75 Note that this container is meant to be long running. Updates are handled internally as opposed to at the container level.
76 
77 If using manual configuration, before starting your container make sure the aforementioned `appsettings.Production.json` is setup properly. See below
78 
79 ### Configuring
80 
81 The first time you run TGS4 you should be prompted with a configuration wizard which will guide you through setting up your appsettings.Production.json
82 
83 This wizard will, generally, run whenever the server is launched without detecting the config json. Follow the instructions below to perform this process manually.
84 
85 #### Manual Configuration
86 
87 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:
88 
89 - `General:ConfigVersion`: Suppresses warnings about out of date config versions. You should change this after updating TGS to one with a new config version. The current version can be found on the releases page for your server version (This field did not exist before v4.4.0).
90 
91 - `General:MinimumPasswordLength`: Minimum password length requirement for database users
92 
93 - `General:ValidInstancePaths`: Array meant to limit the directories in which instances may be created.
94 
95 - `General:UserLimit`: Maximum number of users that may be created
96 
97 - `General:InstanceLimit`: Maximum number of instances that may be created
98 
99 - `General:GitHubAccessToken`: Specify a GitHub personal access token with no scopes here to highly mitigate the possiblity of 429 response codes from GitHub requests
100 
101 - `FileLogging:Directory`: Override the default directory where server logs are stored. Default is C:/ProgramData/tgstation-server/logs on Windows, /usr/share/tgstation-server/logs otherwise
102 
103 - `FileLogging:LogLevel`: Can be one of `Trace`, `Debug`, `Information`, `Warning`, `Error`, or `Critical`. Restricts what is put into the log files. Currently `Debug` is reccommended for help with error reporting.
104 
105 - `Kestrel:Endpoints:Http:Url`: The URL (i.e. interface and ports) your application should listen on. General use case should be `http://localhost:<port>` for restricted local connections. See the Remote Access section for configuring public access to the World Wide Web. This doesn't need to be changed using the docker setup and should be mapped with the `-p` option instead
106 
107 - `Database:DatabaseType`: Can be one of `SqlServer`, `MariaDB`, `MySql`, `PostgresSql`, or `Sqlite`.
108 
109 - `Database:ServerVersion`: The version of the database server. Used by the MySQL/MariaDB and Postgres providers for selection of certain features, ignore at your own risk. A string in the form `<major>.<minor>.<patch>` for MySQL/MariaDB or `<major>.<minor>` for PostgresSQL.
110 
111 - `Database:ConnectionString`: Connection string for your database. Click [here](https://www.developerfusion.com/tools/sql-connection-string/) for an SQL Server generator, or see [here](https://www.connectionstrings.com/postgresql/) for a Postgres guide or [here](https://www.connectionstrings.com/mysql/) for a MySQL guide ([You should probably use '127.0.0.1' instead of 'localhost'](https://stackoverflow.com/questions/19712307/mysql-localhost-127-0-0-1)). Sqlite connection strings should be in the format `Data Source=<PATH TO DATABASE FILE>;Mode=ReadWriteCreate`.
112 
113 - `ControlPanel:Enable`: Enable the javascript based control panel to be served from the server via /index.html
114 
115 - `ControlPanel:AllowAnyOrigin`: Set the Access-Control-Allow-Origin header to * for all responses (also enables all headers and methods)
116 
117 - `ControlPanel:AllowedOrigins`: Set the Access-Control-Allow-Origin headers to this list of origins for all responses (also enables all headers and methods). This is overridden by `ControlPanel:AllowAnyOrigin`
118 
119 ### Database Configuration
120 
121 If using a MariaDB/MySQL server, our client library [recommends you set 'utf8mb4' as your default charset](https://github.com/PomeloFoundation/Pomelo.EntityFrameworkCore.MySql#1-recommended-server-charset) disregard at your own risk.
122 
123 The user created for the application will need the privilege to create databases on the first run, do not create the database for it. Once the initial set of migrations is run, the create right may be revoked. The user should maintain DDL rights though for applying future migrations
124 
125 Note that the ratio of application installations to databases is 1:1. Do not attempt to share a database amongst multiple TGS installations.
126 
127 ### Starting
128 
129 For the Windows service version start the `tgstation-server-4` service. If it fails to start, check the Windows event log under Windows/Application for entries from tgstation-server-4 for errors.
130 
131 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, you must do this as admin to give the server permission to install the required DirectX dependency for certain 512 BYOND versions as well as create symlinks.
132 
133 For the docker version run `docker start <your container name>`
134 
135 Test your server is running by visiting the local port in your browser. You should receive a 401 Unauthorized response (You may need to view the developer console). Otherwise an error page will be present.
136 
137 ### Stopping
138 
139 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.
140 
141 For the Windows service version stop the `tgstation-server-4` service
142 
143 For the console version press `Ctrl+C` or send a SIGQUIT to the ORIGINAL dotnet process
144 
145 For the docker version run `docker stop <your container name>`
146 
147 ## Integrating
148 
149 tgstation-server 4 currently 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.
150 
151 1. Copy the [latest release of the DMAPI](https://github.com/tgstation/tgstation-server/releases) anywhere in your code base. `tgs.dm` can be seperated from the `tgs` folder, but do not modify or move the contents of the `tgs` folder
152 2. Modify your `.dme`(s) to include the `tgs.dm` and `tgs/includes.dm` files (ORDER OF APPEARANCE IS MANDATORY)
153 3. Follow the instructions in `tgs.dm` to integrate the API with your codebase.
154 
155 The DMAPI is fully backwards compatible and should function with any tgstation-server version to date. Updates can be performed in the same manner. Using the `TGS_EXTERNAL_CONFIGURATION` is recommended in order to make the process as easy as replacing `tgs.dm` and the `tgs` folder with a newer version
156 
157 ### Example
158 
159 Here is a bare minimum example project that implements the essential code changes for integrating the DMAPI
160 
161 Before `tgs.dm`:
162 ```dm
163 //Remember, every codebase is different, you probably have better methods for these defines than the ones given here
164 #define TGS_EXTERNAL_CONFIGURATION
165 #define TGS_DEFINE_AND_SET_GLOBAL(Name, Value) var/global/##Name = ##Value
166 #define TGS_READ_GLOBAL(Name) global.##Name
167 #define TGS_WRITE_GLOBAL(Name, Value) global.##Name = ##Value
168 #define TGS_WORLD_ANNOUNCE(message) world << ##message
169 #define TGS_INFO_LOG(message) world.log << "TGS Info: [##message]"
170 #define TGS_ERROR_LOG(message) world.log << "TGS Error: [##message]"
171 #define TGS_NOTIFY_ADMINS(event) world.log << "TGS Admin Message: [##event]"
172 #define TGS_CLIENT_COUNT global.client_cout
173 #define TGS_PROTECT_DATUM(Path) // Leave blank if your codebase doesn't give administrators code reflection capabilities
174 ```
175 
176 Anywhere else:
177 ```dm
178 var/global/client_count = 0
179 
180 /world/New()
181  ..()
182  TgsNew()
183  TgsInitializationsComplete()
184 
185 /world/Reboot()
186  TgsReboot()
187  ..()
188 
189 /world/Topic()
190  TGS_TOPIC
191  ..()
192 
193 /client/New()
194  ..()
195  ++global.client_count
196 
197 /client/Del()
198  ..()
199  --global.client_count
200 ```
201 
202 ## Remote Access
203 
204 tgstation-server is an [ASP.Net Core](https://docs.microsoft.com/en-us/aspnet/core/) app based on the Kestrel web server. This section is meant to serve as a general use case overview, but the entire Kestrel configuration can be modified to your liking with the configuration JSON. See [the official documentation](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel) for details.
205 
206 Exposing the builtin Kestrel server to the internet directly over HTTP is highly not reccommended due to the lack of security. The recommended way to expose tgstation-server to the internet is to host it through a reverse proxy with HTTPS support. Here are some step by step examples to achieve this for major web servers.
207 
208 System administrators will most likely have their own configuration plans, but here are some basic guides for beginners.
209 
210 Once complete, test that your configuration worked by visiting your proxy site from a browser on a different computer. You should recieve a 401 Unauthorized response.
211 
212 ### IIS (Reccommended for Windows)
213 
214 1. Acquire an HTTPS certificate. The easiet free way for Windows is [win-acme](https://github.com/PKISharp/win-acme) (requires you to set up the website first)
215 2. Install the [Web Platform Installer](https://www.microsoft.com/web/downloads/platform.aspx)
216 3. Open the web platform installer in the IIS Manager and install the Application Request Routing 3.0 module
217 4. Create a new website, bind it to HTTPS only with your chosen certificate and exposed port. The physical path won't matter since it won't be used. Use `Require Server Name Indication` if you want to limit requests to a specific URL prefix. Do not use the same port as the one TGS is running on.
218 5. Close and reopen the IIS Manager
219 5. Open the site and navigate to the `URL Rewrite` module
220 6. In the `Actions` Pane on the right click `Add Rule(s)...`
221 7. For the rule template, select `Reverse Proxy` under `Inbound and Outbound Rules` and click `OK`
222 8. You may get a prompt about enabling proxy functionality. Click `OK`
223 9. In the window that appears set the `Inbound Rules` textbox to the URL of your tgstation-server i.e. `http://localhost:5000`. Ensure `Enable SSL Offloading` is checked, then click `OK`
224 
225 ### Caddy (Reccommended for Linux, or those unfamilar with configuring NGINX or Apache)
226 
227 1. Setup a basic website configuration. Instructions on how to do so are out of scope.
228 2. In your Caddyfile, under a server entry, add the following (replace 8080 with the port TGS is hosted on):
229 ```
230 proxy /tgs localhost:8080 {
231  transparent
232 }
233 ```
234 
235 See https://caddyserver.com/docs/proxy
236 
237 ### NGINX (Reccommended for Linux)
238 
239 1. Setup a basic website configuration. Instructions on how to do so are out of scope.
240 2. Acquire an HTTPS certificate, likely via Let's Encrypt, and configure NGINX to use it.
241 3. Setup a path under a server like the following (replace 8080 with the port TGS is hosted on):
242 ```
243 location /tgs {
244  proxy_pass http://127.0.0.1:8080;
245  break;
246 }
247 ```
248 
249 See https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/
250 
251 ### Apache
252 
253 1. Ensure the `mod_proxy` extension is installed.
254 2. Setup a basic website configuration. Instructions on how to do so are out of scope.
255 3. Acquire an HTTPS certificate, likely via Let's Encrypt, and configure Apache to use it.
256 4. Under a VirtualHost entry, setup the following (replace 8080 with the port TGS is hosted on):
257 ```
258 ProxyPass / http://127.0.0.1:8080
259 ProxyPassReverse / http://127.0.0.1:8080
260 ```
261 
262 See https://httpd.apache.org/docs/2.4/howto/reverse_proxy.html
263 
264 Example VirtualHost Entry
265 ```
266 <IfModule mod_ssl.c>
267 <VirtualHost *:443>
268  ServerName tgs_subdomain.example.com
269 
270  SSLEngine on
271  SSLCertificateFile /etc/letsencrypt/live/example.com/fullchain.pem
272  SSLCertificateKeyFile /etc/letsencrypt/live/example.com/privkey.pem
273 
274  ProxyPass / http://127.0.0.1:8080/
275  ProxyPassReverse / http://127.0.0.1:8080/
276 </VirtualHost>
277 </IfModule>
278 ```
279 
280 ## Usage
281 
282 tgstation-server v4 is controlled via a RESTful HTTP json API. Documentation on this API can be found [here](https://tgstation.github.io/tgstation-server/api.html). This section serves to document the concepts of the server. The API is versioned separately from the release version. A specification for it can be found in the api-vX.X.X git releases/tags.
283 
284 ### Users
285 
286 All actions apart from logging in must be taken by a user. TGS installs with one default user whose credentials can be found [here](src/Tgstation.Server.Api/Models/User.cs). It is recommended to disable this user ASAP as it is used to create Jobs that are started by the server itself. If access to all users is lost, the default user can be reset using the `Database:ResetAdminPassword` configuration setting.
287 
288 Users can be enabled/disabled and have a very granular set of rights associated to them that determine the actions they are allowed to take (i.e. Modify the user list or create instances). Users can be _database based_ or _system based_. Database users are your standard web users with a username and password. System users, on the otherhand, are authenticated with the host OS. These users cannot have their password or names changed by TGS as they are managed by the system (and in reverse, login tokens don't expire when their password changes). The benefit to having these users is it allows the use of system ACLs for static file control. More on that later.
289 
290 ### Instances
291 
292 A TGS deployment is made up with a set of instances, which each represent a production BYOND server. As many instances as desired can be created. Be aware, however, due to the nature of BYOND, this will quickly result in system resource exhaustion.
293 
294 An instance is stored in a single folder anywhere on a system and is made up of several components: The source code git repository, the BYOND installations, the compiler, the watchdog, chat bots, and static file management systems.
295 
296 ##### Instance Users
297 
298 All users with access to an instance have an InstanceUser object associated with the two that defines more rights specific to that instance (i.e. Deploy code, modify bots, edit other InstanceUsers).
299 
300 #### Repository
301 
302 The `Repository` folder is a git repository containing the code of the game you wish to host. It can be cloned from any public or private remote repository and has capabilities to affect changes back to it. All the standard benefits of git are utilized (i.e. check out any revision or reference).
303 
304 Additional features become available if the remote repository is hosted on https://github.com/. Namely the Test Merge feature, which allows you to take a pull request opened on the repository and compile it into a game deployment for testing. Information about test merges is available in game via the DMAPI and via the main API as well.
305 
306 Manual operations on the repository while an instance is running may lead to git data corruption. Thankfully, it's simple enough to delete and reclone the repository via the API.
307 
308 #### Byond
309 
310 The `Byond` folder contains installations of [BYOND](https://secure.byond.com/) versions. The version which is used by your game code can be changed on a whim (Note that only versions >= 511.1385 have been thouroughly tested. Lower versions should work but if one doesn't function, please open an issue report) and the server will take care of installing it.
311 
312 #### Compiler
313 
314 The compiler deploys code from the `Repository` folder to the `Game` folder and compiles it either by autodetecting the `.dme` or having it set by configuration. Several other step are also run such as validating the DMAPI version and creating symlinks for static files are done at this point. The compiler also applies server side code modifications and duplicates compiled code for the watchdog as well (See following section).
315 
316 #### Watchdog
317 
318 The watchdog is responsible for starting and keeping your server running. It functions by launching two servers which are hot-swapped on `/world/Reboot`s and during crashes to prevent downtime. This hot swapping feature is also what allows TGS to deploy updates to live servers without bringing them down.
319 
320 DreamDaemon can be finicky and will crash with several high load games or bad DM code. The watchdog has several failure prevention methods to keep at least one server running while these issues are sorted out.
321 
322 #### Chat Bots
323 
324 TGS supports creating infinite chat bots for notifying staff or players of things like code deployments and uptime in. Currently the following providers are supported
325 
326 - Internet Relay Chat (IRC)
327 - Discord
328 
329 More can be added by providing a new implementation of the [IProvider](src/Tgstation.Server.Host/Components/Chat/Providers/IProvider.cs) interface
330 
331 Bots have a set of built-in commands that can be triggered via `!tgs`, mentioning, or private messaging them. Along with these, custom commands can be defined using the DMAPI by creating a subtype of the `/datum/tgs_chat_command` type (See `tgs.dm` for details). Invocation for custom commands can be restricted to certain channels.
332 
333 #### Static Files
334 
335 All files in game code deployments are considered transient by default, meaning when new code is deployed, changes will be lost. Static files allow you to specify which files and folders stick around throughout all deployments.
336 
337 The `StaticFiles` folder contains 3 root folders which cannot be deleted and operate under special rules
338  - `CodeModifications`
339  - `EventScripts`
340  - `GameStaticFiles`
341 
342 These files can be modified either in host mode or system user mode. In host mode, TGS itself is responsible for reading and writing the files. In system user mode read and write actions are performed using the system account of the logged on User, enabling the use of ACLs to control access to files. Database users will not be able to use the static file system if this mode is configured for an instance.
343 
344 This folder may be freely modified manually just beware this may cause in-progress deployments to error if done on Windows systems.
345 
346 #### CodeModifications
347 
348 When a deployment is made by the compiler, all the contents of this folder are copied over the repository contents. Then one of two code change modes are selected based on the prescense of certain files.
349 
350 If `<target dme>.dm` is present, that .dme will be used instead of the repository's `.dme`
351 
352 Otherwise the files `HeadInclude.dm` and `TailInclude.dm` are searched for and added as include lines to the top and bottom of the target `.dme` repsectively if they exist. These files can contain any valid DreamMaker code (Including `#include`ing other `.dm` files!) allowing you to modify the a repository's code on a per instance basis
353 
354 #### EventScripts
355 
356 This folder can contain anything. But, when certain events occur in the instance, TGS will look here for `.bat` or `.sh` files with the same name and run those with corresponding arguments. List of supported events can be found [here](src/Tgstation.Server.Host/Components/Events/EventType.cs).
357 
358 #### GameStaticFiles
359 
360 Any files and folders contained in this root level of this folder will be symbolically linked to all deployments at the time they are created. This allows persistent game data (BYOND `.sav`s or code configuration files for example) to persist across all deployments. This folder contains a .tgsignore file which can be used to prevent symlinks from being generated by entering the names of files and folders (1 per line)
361 
362 ### Updating
363 
364 TGS 4 can self update without stopping your DreamDaemon servers. Any V4 release made to this repository is bound by a contract that allows changes of the runtime assemblies without stopping your servers. Database migrations are automatically applied as well. Because of this REVERTING TO LOWER VERSIONS IS NOT OFFICIALLY SUPPORTED, do so at your own risk (check changes made to `/src/Tgstation.Server.Host/Models/Migrations`).
365 
366 ### Clients
367 
368 Here are tools for interacting with the TGS 4 web API
369 
370 - [tgstation-server-control-panel]: Official client and included with the server. A react web app for using tgstation-server.
371 - [Tgstation.Server.ControlPanel](https://github.com/tgstation/Tgstation.Server.ControlPanel): Official client. A cross platform GUI for using tgstation-server
372 - [Tgstation.Server.Client](https://www.nuget.org/packages/Tgstation.Server.Client): A nuget .NET Standard 2.0 TAP based library for communicating with tgstation-server
373 - [Tgstation.Server.Api](https://www.nuget.org/packages/Tgstation.Server.Api): A nuget .NET Standard 2.0 library containing API definitions for tgstation-server
374 - [Postman](https://www.getpostman.com/): This repository contains [TGS.postman_collection.json](tools/TGS.postman_collection.json) which is used during development for testing. Contains example requests for all endpoints but takes some knowledge to use (Note that the pre-request script is configured to login the default admin user for every request)
375 
376 Contact project maintainers to get your client added to this list
377 
378 ## Backup/Restore
379 
380 Note that tgstation-server is NOT a backup solution, the onus is on the server runners.
381 
382 The `Repository` folder should be backed up on the remote server, do not rely on the instance copy to store changes.
383 
384 The `BYOND` and `Game` folders should never be backed up due to being intertwined with instance data.
385 
386 The `Configuration` folder should be fully backed up.
387 
388 The database should be fully backed up.
389 
390 To restore an installation from backups, first restore the instance `Configuration` folder in its new home. Then restore the database, modifying the `Path` column in the `Instances` table where necessary to point to the new instances. Then start the server pointed at the new database.
391 
392 Should you end up with a lost database for some reason or want to reattach a detached instance you can reattach an existing folder by creating an empty file named `TGS4_ALLOW_INSTANCE_ATTACH` inside it (This is automatically created when detaching instances). Then create a new instance with that path, this will bypass the empty folder check. Note that this will not restore things such as user permissions, server config options, or deployment metadata. Those must be reconfigured manually.
393 
394 ## Troubleshooting
395 
396 Feel free to ask for help at the coderbus discord in \#hosting-questions: https://discord.gg/Vh8TJp9. Cyberboss#8246 can answer most questions.
397 
398 ## Contributing
399 
400 * See [CONTRIBUTING.md](.github/CONTRIBUTING.md)
401 
402 ## Licensing
403 
404 * The DMAPI for the project is licensed under the MIT license.
405 * The /tg/station 13 icon is licensed under [Creative Commons 3.0 BY-SA](http://creativecommons.org/licenses/by-sa/3.0/).
406 * The remainder of the project is licensed under [GNU AGPL v3](http://www.gnu.org/licenses/agpl-3.0.html)
407 
408 See the files in the `/src/DMAPI` tree for the MIT license
+Go to the documentation of this file.
1 # tgstation-server v4:
2 
3 [![Build status](https://ci.appveyor.com/api/projects/status/7t1h7bvuha0p9j5f/branch/master?svg=true)](https://ci.appveyor.com/project/Cyberboss/tgstation-server-tools/branch/master) [![Build Status](https://travis-ci.org/tgstation/tgstation-server.svg?branch=master)](https://travis-ci.org/tgstation/tgstation-server) [![codecov](https://codecov.io/gh/tgstation/tgstation-server/branch/master/graph/badge.svg)](https://codecov.io/gh/tgstation/tgstation-server)
4 
5 [![GitHub license](https://img.shields.io/github/license/tgstation/tgstation-server.svg)](LICENSE) [![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/tgstation/tgstation-server.svg)](http://isitmaintained.com/project/tgstation/tgstation-server "Average time to resolve an issue") [![NuGet version](https://img.shields.io/nuget/v/Tgstation.Server.Api.svg)](https://www.nuget.org/packages/Tgstation.Server.Api) [![NuGet version](https://img.shields.io/nuget/v/Tgstation.Server.Client.svg)](https://www.nuget.org/packages/Tgstation.Server.Client)
6 
7 [![forthebadge](http://forthebadge.com/images/badges/made-with-c-sharp.svg)](http://forthebadge.com) [![forinfinityandbyond](https://user-images.githubusercontent.com/5211576/29499758-4efff304-85e6-11e7-8267-62919c3688a9.gif)](https://www.reddit.com/r/SS13/comments/5oplxp/what_is_the_main_problem_with_byond_as_an_engine/dclbu1a)
8 
9 [![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](http://forthebadge.com) [![forthebadge](http://forthebadge.com/images/badges/60-percent-of-the-time-works-every-time.svg)](http://forthebadge.com)
10 
11 This is a toolset to manage production BYOND servers. It includes the ability to update the server without having to stop or shutdown the server (the update will take effect on a "reboot" of the server) the ability start the server and restart it if it crashes, as well as systems for managing code and game files, and merging GitHub Pull Requests for test deployments.
12 
13 ### Legacy Servers
14 
15 Older server versions can be found in the V# branches of this repository. Note that V4 is nearly fully incompatible with existing installations. Only some static files may be copied over: https://github.com/tgstation/tgstation-server#static-files
16 
17 ## Setup
18 
19 ### Pre-Requisites
20 
21 - [ASP .NET Core Runtime (>= v3.1)](https://dotnet.microsoft.com/download/dotnet-core/current/runtime) (Choose the option to `Run Server Apps` for your system) If you plan to install tgstation-server as a Windows service, you should also ensure that your .NET Framework runtime version is >= v4.7.2 (Download can be found on same page). Ensure that the `dotnet` executable file is in your system's `PATH` variable (or that of the user's that will be running the server).
22 - A [MariaDB](https://downloads.mariadb.org/), MySQL, [PostgresSQL](https://www.postgresql.org/download/), or [Microsoft SQL Server](https://www.microsoft.com/en-us/download/details.aspx?id=55994) database engine is required
23 
24 ### Installation
25 
26 1. [Download the latest V4 release .zip](https://github.com/tgstation/tgstation-server/releases/latest). The `ServerService` package will only work on Windows. Choose `ServerConsole` if that is not your target OS or you prefer not to use the Windows service.
27 2. Extract the .zip file to where you want the server to run from. Note the account running the server must have write and delete access to the `lib` subdirectory.
28 
29 #### Windows
30 
31 If you wish to install the TGS as a service, run `Tgstation.Server.Host.Service.exe`. It should prompt you to install it. Click `Yes` and accept a potential UAC elevation prompt and the setup wizard should run.
32 
33 #### Linux (Native)
34 
35 We recommend using Docker for Linux installations, see below. The content of this parent section may be skipped if you choose to do so.
36 
37 The following dependencies are required to run tgstation-server on Linux alongside the .NET Core runtime
38 
39 - libc6-i386
40 - libstdc++6:i386
41 - libssl1.0.0
42 - gdb (for using gcore to create core dumps)
43 - gcc-multilib (Only on 64-bit systems)
44 
45 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.
46 
47 #### Docker (Linux)
48 
49 tgstation-server supports running in a docker container and is the recommended deployment method for Linux systems. 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 -t <your tag name>` in the repository root.
50 
51 To create a container run
52 ```sh
53 docker run \
54  -ti \ #start interactive for manual configuration
55  --restart=always \ #if you want maximum uptime
56  --network="host" \ #if your sql server is on the same machine
57  --name="tgs" \ #or whatever else you wanna call it
58  --cap-add=sys_nice \ #allows tgs to schedule DreamDaemon as a higher priority process
59  --init \ #reaps potential zombie processes
60  -p <tgs port>:80 \
61  -p 0.0.0.0:<public game port>:<public game port> \
62  -v /path/to/your/configfile/directory:/config_data \ #only if you want to use manual configuration
63  -v /path/to/store/instances:/tgs4_instances \
64  -v /path/to/your/log/folder:/tgs_logs \
65  tgstation/server:<release version> #replace this with <your tag name> if you built the image locally
66 ```
67 with any additional options you desire (i.e. You'll have to expose more game ports in order to host more than one instance).
68 
69 - Important note about port exposure: The internal port used by DreamDaemon _**MUST**_ match the port you want users to connect on. If it doesn't, you'll still be able to have them connect HOWEVER links from the BYOND hub will point at what DreamDaemon thinks the port is.
70 
71 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.
72 
73 The configuration option `General:ValidInstancePaths` will be preconfigured to point to `/tgs4_instances`. It is recommended you don't change this.
74 
75 Note that this container is meant to be long running. Updates are handled internally as opposed to at the container level.
76 
77 If using manual configuration, before starting your container make sure the aforementioned `appsettings.Production.json` is setup properly. See below
78 
79 ### Configuring
80 
81 The first time you run TGS4 you should be prompted with a configuration wizard which will guide you through setting up your appsettings.Production.json
82 
83 This wizard will, generally, run whenever the server is launched without detecting the config json. Follow the instructions below to perform this process manually.
84 
85 #### Manual Configuration
86 
87 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:
88 
89 - `General:ConfigVersion`: Suppresses warnings about out of date config versions. You should change this after updating TGS to one with a new config version. The current version can be found on the releases page for your server version (This field did not exist before v4.4.0).
90 
91 - `General:MinimumPasswordLength`: Minimum password length requirement for database users
92 
93 - `General:ValidInstancePaths`: Array meant to limit the directories in which instances may be created.
94 
95 - `General:UserLimit`: Maximum number of users that may be created
96 
97 - `General:InstanceLimit`: Maximum number of instances that may be created
98 
99 - `General:GitHubAccessToken`: Specify a GitHub personal access token with no scopes here to highly mitigate the possiblity of 429 response codes from GitHub requests
100 
101 - `FileLogging:Directory`: Override the default directory where server logs are stored. Default is C:/ProgramData/tgstation-server/logs on Windows, /usr/share/tgstation-server/logs otherwise
102 
103 - `FileLogging:LogLevel`: Can be one of `Trace`, `Debug`, `Information`, `Warning`, `Error`, or `Critical`. Restricts what is put into the log files. Currently `Debug` is reccommended for help with error reporting.
104 
105 - `Kestrel:Endpoints:Http:Url`: The URL (i.e. interface and ports) your application should listen on. General use case should be `http://localhost:<port>` for restricted local connections. See the Remote Access section for configuring public access to the World Wide Web. This doesn't need to be changed using the docker setup and should be mapped with the `-p` option instead
106 
107 - `Database:DatabaseType`: Can be one of `SqlServer`, `MariaDB`, `MySql`, `PostgresSql`, or `Sqlite`.
108 
109 - `Database:ServerVersion`: The version of the database server. Used by the MySQL/MariaDB and Postgres providers for selection of certain features, ignore at your own risk. A string in the form `<major>.<minor>.<patch>` for MySQL/MariaDB or `<major>.<minor>` for PostgresSQL.
110 
111 - `Database:ConnectionString`: Connection string for your database. Click [here](https://www.developerfusion.com/tools/sql-connection-string/) for an SQL Server generator, or see [here](https://www.connectionstrings.com/postgresql/) for a Postgres guide or [here](https://www.connectionstrings.com/mysql/) for a MySQL guide ([You should probably use '127.0.0.1' instead of 'localhost'](https://stackoverflow.com/questions/19712307/mysql-localhost-127-0-0-1)). Sqlite connection strings should be in the format `Data Source=<PATH TO DATABASE FILE>;Mode=ReadWriteCreate`.
112 
113 - `ControlPanel:Enable`: Enable the javascript based control panel to be served from the server via /index.html
114 
115 - `ControlPanel:AllowAnyOrigin`: Set the Access-Control-Allow-Origin header to * for all responses (also enables all headers and methods)
116 
117 - `ControlPanel:AllowedOrigins`: Set the Access-Control-Allow-Origin headers to this list of origins for all responses (also enables all headers and methods). This is overridden by `ControlPanel:AllowAnyOrigin`
118 
119 ### Database Configuration
120 
121 If using a MariaDB/MySQL server, our client library [recommends you set 'utf8mb4' as your default charset](https://github.com/PomeloFoundation/Pomelo.EntityFrameworkCore.MySql#1-recommended-server-charset) disregard at your own risk.
122 
123 The user created for the application will need the privilege to create databases on the first run, do not create the database for it. Once the initial set of migrations is run, the create right may be revoked. The user should maintain DDL rights though for applying future migrations
124 
125 Note that the ratio of application installations to databases is 1:1. Do not attempt to share a database amongst multiple TGS installations.
126 
127 ### Starting
128 
129 For the Windows service version start the `tgstation-server-4` service. If it fails to start, check the Windows event log under Windows/Application for entries from tgstation-server-4 for errors.
130 
131 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, you must do this as admin to give the server permission to install the required DirectX dependency for certain 512 BYOND versions as well as create symlinks.
132 
133 For the docker version run `docker start <your container name>`
134 
135 Test your server is running by visiting the local port in your browser. You should receive a 401 Unauthorized response (You may need to view the developer console). Otherwise an error page will be present.
136 
137 ### Stopping
138 
139 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.
140 
141 For the Windows service version stop the `tgstation-server-4` service
142 
143 For the console version press `Ctrl+C` or send a SIGQUIT to the ORIGINAL dotnet process
144 
145 For the docker version run `docker stop <your container name>`
146 
147 ## Integrating
148 
149 tgstation-server 4 provides the DMAPI which can be be integrated into any BYOND codebase for heavily enhanced functionality. The integration process is a fairly simple set of code changes.
150 
151 1. Copy the [latest release of the DMAPI](https://github.com/tgstation/tgstation-server/releases) anywhere in your code base. `tgs.dm` can be seperated from the `tgs` folder, but do not modify or move the contents of the `tgs` folder
152 2. Modify your `.dme`(s) to include the `tgs.dm` and `tgs/includes.dm` files (ORDER OF APPEARANCE IS MANDATORY)
153 3. Follow the instructions in `tgs.dm` to integrate the API with your codebase.
154 
155 The DMAPI is fully backwards compatible and should function with any tgstation-server version to date. Updates can be performed in the same manner. Using the `TGS_EXTERNAL_CONFIGURATION` is recommended in order to make the process as easy as replacing `tgs.dm` and the `tgs` folder with a newer version
156 
157 ### Example
158 
159 Here is a bare minimum example project that implements the essential code changes for integrating the DMAPI
160 
161 Before `tgs.dm`:
162 ```dm
163 //Remember, every codebase is different, you probably have better methods for these defines than the ones given here
164 #define TGS_EXTERNAL_CONFIGURATION
165 #define TGS_DEFINE_AND_SET_GLOBAL(Name, Value) var/global/##Name = ##Value
166 #define TGS_READ_GLOBAL(Name) global.##Name
167 #define TGS_WRITE_GLOBAL(Name, Value) global.##Name = ##Value
168 #define TGS_WORLD_ANNOUNCE(message) world << ##message
169 #define TGS_INFO_LOG(message) world.log << "TGS Info: [##message]"
170 #define TGS_ERROR_LOG(message) world.log << "TGS Error: [##message]"
171 #define TGS_NOTIFY_ADMINS(event) world.log << "TGS Admin Message: [##event]"
172 #define TGS_CLIENT_COUNT global.client_cout
173 #define TGS_PROTECT_DATUM(Path) // Leave blank if your codebase doesn't give administrators code reflection capabilities
174 ```
175 
176 Anywhere else:
177 ```dm
178 var/global/client_count = 0
179 
180 /world/New()
181  ..()
182  TgsNew()
183  TgsInitializationsComplete()
184 
185 /world/Reboot()
186  TgsReboot()
187  ..()
188 
189 /world/Topic()
190  TGS_TOPIC
191  ..()
192 
193 /client/New()
194  ..()
195  ++global.client_count
196 
197 /client/Del()
198  ..()
199  --global.client_count
200 ```
201 
202 ## Remote Access
203 
204 tgstation-server is an [ASP.Net Core](https://docs.microsoft.com/en-us/aspnet/core/) app based on the Kestrel web server. This section is meant to serve as a general use case overview, but the entire Kestrel configuration can be modified to your liking with the configuration JSON. See [the official documentation](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel) for details.
205 
206 Exposing the builtin Kestrel server to the internet directly over HTTP is highly not reccommended due to the lack of security. The recommended way to expose tgstation-server to the internet is to host it through a reverse proxy with HTTPS support. Here are some step by step examples to achieve this for major web servers.
207 
208 System administrators will most likely have their own configuration plans, but here are some basic guides for beginners.
209 
210 Once complete, test that your configuration worked by visiting your proxy site from a browser on a different computer. You should recieve a 401 Unauthorized response.
211 
212 ### IIS (Reccommended for Windows)
213 
214 1. Acquire an HTTPS certificate. The easiet free way for Windows is [win-acme](https://github.com/PKISharp/win-acme) (requires you to set up the website first)
215 2. Install the [Web Platform Installer](https://www.microsoft.com/web/downloads/platform.aspx)
216 3. Open the web platform installer in the IIS Manager and install the Application Request Routing 3.0 module
217 4. Create a new website, bind it to HTTPS only with your chosen certificate and exposed port. The physical path won't matter since it won't be used. Use `Require Server Name Indication` if you want to limit requests to a specific URL prefix. Do not use the same port as the one TGS is running on.
218 5. Close and reopen the IIS Manager
219 5. Open the site and navigate to the `URL Rewrite` module
220 6. In the `Actions` Pane on the right click `Add Rule(s)...`
221 7. For the rule template, select `Reverse Proxy` under `Inbound and Outbound Rules` and click `OK`
222 8. You may get a prompt about enabling proxy functionality. Click `OK`
223 9. In the window that appears set the `Inbound Rules` textbox to the URL of your tgstation-server i.e. `http://localhost:5000`. Ensure `Enable SSL Offloading` is checked, then click `OK`
224 
225 ### Caddy (Reccommended for Linux, or those unfamilar with configuring NGINX or Apache)
226 
227 1. Setup a basic website configuration. Instructions on how to do so are out of scope.
228 2. In your Caddyfile, under a server entry, add the following (replace 8080 with the port TGS is hosted on):
229 ```
230 proxy /tgs localhost:8080 {
231  transparent
232 }
233 ```
234 
235 See https://caddyserver.com/docs/proxy
236 
237 ### NGINX (Reccommended for Linux)
238 
239 1. Setup a basic website configuration. Instructions on how to do so are out of scope.
240 2. Acquire an HTTPS certificate, likely via Let's Encrypt, and configure NGINX to use it.
241 3. Setup a path under a server like the following (replace 8080 with the port TGS is hosted on):
242 ```
243 location /tgs {
244  proxy_pass http://127.0.0.1:8080;
245  break;
246 }
247 ```
248 
249 See https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/
250 
251 ### Apache
252 
253 1. Ensure the `mod_proxy` extension is installed.
254 2. Setup a basic website configuration. Instructions on how to do so are out of scope.
255 3. Acquire an HTTPS certificate, likely via Let's Encrypt, and configure Apache to use it.
256 4. Under a VirtualHost entry, setup the following (replace 8080 with the port TGS is hosted on):
257 ```
258 ProxyPass / http://127.0.0.1:8080
259 ProxyPassReverse / http://127.0.0.1:8080
260 ```
261 
262 See https://httpd.apache.org/docs/2.4/howto/reverse_proxy.html
263 
264 Example VirtualHost Entry
265 ```
266 <IfModule mod_ssl.c>
267 <VirtualHost *:443>
268  ServerName tgs_subdomain.example.com
269 
270  SSLEngine on
271  SSLCertificateFile /etc/letsencrypt/live/example.com/fullchain.pem
272  SSLCertificateKeyFile /etc/letsencrypt/live/example.com/privkey.pem
273 
274  ProxyPass / http://127.0.0.1:8080/
275  ProxyPassReverse / http://127.0.0.1:8080/
276 </VirtualHost>
277 </IfModule>
278 ```
279 
280 ## Usage
281 
282 tgstation-server v4 is controlled via a RESTful HTTP json API. Documentation on this API can be found [here](https://tgstation.github.io/tgstation-server/api.html). This section serves to document the concepts of the server. The API is versioned separately from the release version. A specification for it can be found in the api-vX.X.X git releases/tags.
283 
284 ### Users
285 
286 All actions apart from logging in must be taken by a user. TGS installs with one default user whose credentials can be found [here](src/Tgstation.Server.Api/Models/User.cs). It is recommended to disable this user ASAP as it is used to create Jobs that are started by the server itself. If access to all users is lost, the default user can be reset using the `Database:ResetAdminPassword` configuration setting.
287 
288 Users can be enabled/disabled and have a very granular set of rights associated to them that determine the actions they are allowed to take (i.e. Modify the user list or create instances). Users can be _database based_ or _system based_. Database users are your standard web users with a username and password. System users, on the otherhand, are authenticated with the host OS. These users cannot have their password or names changed by TGS as they are managed by the system (and in reverse, login tokens don't expire when their password changes). The benefit to having these users is it allows the use of system ACLs for static file control. More on that later.
289 
290 ### Instances
291 
292 A TGS deployment is made up with a set of instances, which each represent a production BYOND server. As many instances as desired can be created. Be aware, however, due to the nature of BYOND, this will quickly result in system resource exhaustion.
293 
294 An instance is stored in a single folder anywhere on a system and is made up of several components: The source code git repository, the BYOND installations, the compiler, the watchdog, chat bots, and static file management systems.
295 
296 ##### Instance Users
297 
298 All users with access to an instance have an InstanceUser object associated with the two that defines more rights specific to that instance (i.e. Deploy code, modify bots, edit other InstanceUsers).
299 
300 #### Repository
301 
302 The `Repository` folder is a git repository containing the code of the game you wish to host. It can be cloned from any public or private remote repository and has capabilities to affect changes back to it. All the standard benefits of git are utilized (i.e. check out any revision or reference).
303 
304 Additional features become available if the remote repository is hosted on https://github.com/. Namely the Test Merge feature, which allows you to take a pull request opened on the repository and compile it into a game deployment for testing. Information about test merges is available in game via the DMAPI and via the main API as well.
305 
306 Manual operations on the repository while an instance is running may lead to git data corruption. Thankfully, it's simple enough to delete and reclone the repository via the API.
307 
308 #### Byond
309 
310 The `Byond` folder contains installations of [BYOND](https://secure.byond.com/) versions. The version which is used by your game code can be changed on a whim (Note that only versions >= 511.1385 have been thouroughly tested. Lower versions should work but if one doesn't function, please open an issue report) and the server will take care of installing it.
311 
312 #### Compiler
313 
314 The compiler deploys code from the `Repository` folder to the `Game` folder and compiles it either by autodetecting the `.dme` or having it set by configuration. Several other step are also run such as validating the DMAPI version and creating symlinks for static files are done at this point. The compiler also applies server side code modifications and duplicates compiled code for the watchdog as well (See following section).
315 
316 #### Watchdog
317 
318 The watchdog is responsible for starting and keeping your server running. It functions by launching two servers which are hot-swapped on `/world/Reboot`s and during crashes to prevent downtime. This hot swapping feature is also what allows TGS to deploy updates to live servers without bringing them down.
319 
320 DreamDaemon can be finicky and will crash with several high load games or bad DM code. The watchdog has several failure prevention methods to keep at least one server running while these issues are sorted out.
321 
322 #### Chat Bots
323 
324 TGS supports creating infinite chat bots for notifying staff or players of things like code deployments and uptime in. Currently the following providers are supported
325 
326 - Internet Relay Chat (IRC)
327 - Discord
328 
329 More can be added by providing a new implementation of the [IProvider](src/Tgstation.Server.Host/Components/Chat/Providers/IProvider.cs) interface
330 
331 Bots have a set of built-in commands that can be triggered via `!tgs`, mentioning, or private messaging them. Along with these, custom commands can be defined using the DMAPI by creating a subtype of the `/datum/tgs_chat_command` type (See `tgs.dm` for details). Invocation for custom commands can be restricted to certain channels.
332 
333 #### Static Files
334 
335 All files in game code deployments are considered transient by default, meaning when new code is deployed, changes will be lost. Static files allow you to specify which files and folders stick around throughout all deployments.
336 
337 The `StaticFiles` folder contains 3 root folders which cannot be deleted and operate under special rules
338  - `CodeModifications`
339  - `EventScripts`
340  - `GameStaticFiles`
341 
342 These files can be modified either in host mode or system user mode. In host mode, TGS itself is responsible for reading and writing the files. In system user mode read and write actions are performed using the system account of the logged on User, enabling the use of ACLs to control access to files. Database users will not be able to use the static file system if this mode is configured for an instance.
343 
344 This folder may be freely modified manually just beware this may cause in-progress deployments to error if done on Windows systems.
345 
346 #### CodeModifications
347 
348 When a deployment is made by the compiler, all the contents of this folder are copied over the repository contents. Then one of two code change modes are selected based on the prescense of certain files.
349 
350 If `<target dme>.dm` is present, that .dme will be used instead of the repository's `.dme`
351 
352 Otherwise the files `HeadInclude.dm` and `TailInclude.dm` are searched for and added as include lines to the top and bottom of the target `.dme` repsectively if they exist. These files can contain any valid DreamMaker code (Including `#include`ing other `.dm` files!) allowing you to modify the a repository's code on a per instance basis
353 
354 #### EventScripts
355 
356 This folder can contain anything. But, when certain events occur in the instance, TGS will look here for `.bat` or `.sh` files with the same name and run those with corresponding arguments. List of supported events can be found [here](src/Tgstation.Server.Host/Components/Events/EventType.cs).
357 
358 #### GameStaticFiles
359 
360 Any files and folders contained in this root level of this folder will be symbolically linked to all deployments at the time they are created. This allows persistent game data (BYOND `.sav`s or code configuration files for example) to persist across all deployments. This folder contains a .tgsignore file which can be used to prevent symlinks from being generated by entering the names of files and folders (1 per line)
361 
362 ### Updating
363 
364 TGS 4 can self update without stopping your DreamDaemon servers. Any V4 release made to this repository is bound by a contract that allows changes of the runtime assemblies without stopping your servers. Database migrations are automatically applied as well. Because of this REVERTING TO LOWER VERSIONS IS NOT OFFICIALLY SUPPORTED, do so at your own risk (check changes made to `/src/Tgstation.Server.Host/Models/Migrations`).
365 
366 ### Clients
367 
368 Here are tools for interacting with the TGS 4 web API
369 
370 - [tgstation-server-control-panel]: Official client and included with the server. A react web app for using tgstation-server.
371 - [Tgstation.Server.ControlPanel](https://github.com/tgstation/Tgstation.Server.ControlPanel): Official client. A cross platform GUI for using tgstation-server
372 - [Tgstation.Server.Client](https://www.nuget.org/packages/Tgstation.Server.Client): A nuget .NET Standard 2.0 TAP based library for communicating with tgstation-server
373 - [Tgstation.Server.Api](https://www.nuget.org/packages/Tgstation.Server.Api): A nuget .NET Standard 2.0 library containing API definitions for tgstation-server
374 - [Postman](https://www.getpostman.com/): This repository contains [TGS.postman_collection.json](tools/TGS.postman_collection.json) which is used during development for testing. Contains example requests for all endpoints but takes some knowledge to use (Note that the pre-request script is configured to login the default admin user for every request)
375 
376 Contact project maintainers to get your client added to this list
377 
378 ## Backup/Restore
379 
380 Note that tgstation-server is NOT a backup solution, the onus is on the server runners.
381 
382 The `Repository` folder should be backed up on the remote server, do not rely on the instance copy to store changes.
383 
384 The `BYOND` and `Game` folders should never be backed up due to being intertwined with instance data.
385 
386 The `Configuration` folder should be fully backed up.
387 
388 The database should be fully backed up.
389 
390 To restore an installation from backups, first restore the instance `Configuration` folder in its new home. Then restore the database, modifying the `Path` column in the `Instances` table where necessary to point to the new instances. Then start the server pointed at the new database.
391 
392 Should you end up with a lost database for some reason or want to reattach a detached instance you can reattach an existing folder by creating an empty file named `TGS4_ALLOW_INSTANCE_ATTACH` inside it (This is automatically created when detaching instances). Then create a new instance with that path, this will bypass the empty folder check. Note that this will not restore things such as user permissions, server config options, or deployment metadata. Those must be reconfigured manually.
393 
394 ## Troubleshooting
395 
396 Feel free to ask for help at the coderbus discord in \#hosting-questions: https://discord.gg/Vh8TJp9. Cyberboss#8246 can answer most questions.
397 
398 ## Contributing
399 
400 * See [CONTRIBUTING.md](.github/CONTRIBUTING.md)
401 
402 ## Licensing
403 
404 * The DMAPI for the project is licensed under the MIT license.
405 * The /tg/station 13 icon is licensed under [Creative Commons 3.0 BY-SA](http://creativecommons.org/licenses/by-sa/3.0/).
406 * The remainder of the project is licensed under [GNU AGPL v3](http://www.gnu.org/licenses/agpl-3.0.html)
407 
408 See the files in the `/src/DMAPI` tree for the MIT license
Generated by   diff --git a/class_tgstation_1_1_server_1_1_api_1_1_api_headers.html b/class_tgstation_1_1_server_1_1_api_1_1_api_headers.html index fef65ca7ba..f97c573492 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_api_headers.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_api_headers.html @@ -113,8 +113,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); Collaboration diagram for Tgstation.Server.Api.ApiHeaders:
Collaboration graph
- -
[legend]

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_headers_exception.html b/class_tgstation_1_1_server_1_1_api_1_1_headers_exception.html index 72ed5735aa..f97015a72d 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_headers_exception.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_headers_exception.html @@ -108,15 +108,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); Inheritance diagram for Tgstation.Server.Api.HeadersException:
Inheritance graph
- -
[legend]
Collaboration diagram for Tgstation.Server.Api.HeadersException:
Collaboration graph
- -
[legend]

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_limits.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_limits.html index 90e20ec98f..24a3182632 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_limits.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_limits.html @@ -107,8 +107,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); Collaboration diagram for Tgstation.Server.Api.Models.Limits:
Collaboration graph
- -
[legend]

diff --git a/class_tgstation_1_1_server_1_1_api_1_1_routes.html b/class_tgstation_1_1_server_1_1_api_1_1_routes.html index 8b0cc426d6..1a65fab6ae 100644 --- a/class_tgstation_1_1_server_1_1_api_1_1_routes.html +++ b/class_tgstation_1_1_server_1_1_api_1_1_routes.html @@ -108,8 +108,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); Collaboration diagram for Tgstation.Server.Api.Routes:
Collaboration graph
- -
[legend]

diff --git a/index.html b/index.html index 025d6539fe..a7e93ebe36 100644 --- a/index.html +++ b/index.html @@ -166,7 +166,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

For the console version press Ctrl+C or send a SIGQUIT to the ORIGINAL dotnet process

For the docker version run docker stop <your container name>

Integrating

-

tgstation-server 4 currently 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.

+

tgstation-server 4 provides the DMAPI which can be be integrated into any BYOND codebase for heavily enhanced functionality. The integration process is a fairly simple set of code changes.

  1. Copy the latest release of the DMAPI anywhere in your code base. tgs.dm can be seperated from the tgs folder, but do not modify or move the contents of the tgs folder
  2. Modify your .dme(s) to include the tgs.dm and tgs/includes.dm files (ORDER OF APPEARANCE IS MANDATORY)