mirror of
https://github.com/tgstation/tgstation-server.git
synced 2026-08-24 21:46:52 +01:00
206 lines
7.9 KiB
HTML
206 lines
7.9 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>tgstation-server: Features</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">tgstation-server<span id="projectnumber"> 6.19.3</span>
|
|
</div>
|
|
<div id="projectbrief">The /tg/station 13 server suite</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div><div class="header">
|
|
<div class="headertitle"><div class="title">Features</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="toc"><h3>Table of Contents</h3>
|
|
<ul><li class="level1"><a href="#features_list">Comprehensive Feature List</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="textblock"><h1><a class="anchor" id="features_list"></a>
|
|
Comprehensive Feature List</h1>
|
|
<p>tgstation-server is a DreamMaker server managment suite. It includes all the following features</p>
|
|
<ul>
|
|
<li>Standalone server with OpenAPI 3.0 defined HTTP REST API</li>
|
|
<li>Web based client included</li>
|
|
<li>Secure user authentication, management, and permissions system</li>
|
|
<li>Support for using Windows accounts as logins</li>
|
|
<li>OAuth 2.0 support with several providers<ul>
|
|
<li>InvisionCommunity</li>
|
|
<li>/tg/ Forums</li>
|
|
<li>Discord</li>
|
|
<li>GitHub</li>
|
|
<li>Keycloak</li>
|
|
</ul>
|
|
</li>
|
|
<li>Long running operation support via the jobs subsystem with error handling and stage reporting</li>
|
|
<li>Logging system with configurable levels of verbosity<ul>
|
|
<li>Logs can be downloaded via the API</li>
|
|
<li>Supports Elasticsearch ingesting</li>
|
|
</ul>
|
|
</li>
|
|
<li>Able to self update with user input<ul>
|
|
<li>Updates are sourced from our (or anyone else's if configured to do so) GitHub releases or uploaded directly by the user.</li>
|
|
<li>Can also self update using official installation packages</li>
|
|
</ul>
|
|
</li>
|
|
<li>Able to shutdown and restart without interrupting DreamDaemon processes</li>
|
|
<li>Windows service integration with service commands</li>
|
|
<li>SystemD integration with notify-reload support</li>
|
|
<li>Swarm system to coordinate servers across systems</li>
|
|
<li>Database backend supporting several providers<ul>
|
|
<li>Microsoft SQL Server</li>
|
|
<li>MySQL/MariaDB</li>
|
|
<li>PostgresSQL</li>
|
|
<li>SQLite</li>
|
|
</ul>
|
|
</li>
|
|
<li>Instances: Managing multiple sets of the below features seperately on the same machine<ul>
|
|
<li>Git repository managment<ul>
|
|
<li>Cloning</li>
|
|
<li>Checking out SHAs and references</li>
|
|
<li>Local Merging</li>
|
|
<li>Hard resetting to references</li>
|
|
<li>Merging GitHub pull requests locally, optionally commenting on them</li>
|
|
<li>Optionally pushing commits for GitHub visibility</li>
|
|
<li>Can be deleted and changed to a different origin</li>
|
|
</ul>
|
|
</li>
|
|
<li>BYOND version management<ul>
|
|
<li>Downloading and installing a given BYOND version<ul>
|
|
<li>Includes DirectX installation on Windows and proper handling of POSIX shared libraries</li>
|
|
</ul>
|
|
</li>
|
|
<li>Supporting any amount of installed versions</li>
|
|
<li>Cleaning the BYOND cache</li>
|
|
<li>Uploading a custom version .zip</li>
|
|
</ul>
|
|
</li>
|
|
<li>Code Deployment<ul>
|
|
<li>Compiles git code with DreamMaker and the active BYOND version</li>
|
|
<li>Validates interop with the compiled binary</li>
|
|
<li>Can be scheduled to pull the repository and build on a given interval</li>
|
|
<li>Test merge commenting support for GitHub and GitLab</li>
|
|
<li>GitHub Deployment Environments support</li>
|
|
</ul>
|
|
</li>
|
|
<li>The Watchdog, a DreamDaemon uptime monitor<ul>
|
|
<li>Automatically restarts the server when crashed until told to stop</li>
|
|
<li>"Health Check" system for checking DreamDaemon isn't hung</li>
|
|
<li>Seamless automatic application of new deployments on /world/Reboot</li>
|
|
<li>Automatic startup at server boot time</li>
|
|
<li>Automatically handles Windows prompts related to trusted mode</li>
|
|
<li>TGS restarts/updates do not interrupt the DreamDaemon process</li>
|
|
<li>Raises process priority of DreamDaemon for increased performance</li>
|
|
<li>Support for logging DreamDaemon output</li>
|
|
<li>Support for the <code>-profile</code> command line option</li>
|
|
<li>Safe session recovery from TGS crashes</li>
|
|
</ul>
|
|
</li>
|
|
<li>Chat System<ul>
|
|
<li>Support multiple chat bots per instance. Current providers:<ul>
|
|
<li>Discord<ul>
|
|
<li>Supports rich embeds created from DM code and when deployments occur</li>
|
|
</ul>
|
|
</li>
|
|
<li>IRC<ul>
|
|
<li>Supports several authentication types</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>Bots come out of the box with some basic commands like showing the server revision</li>
|
|
<li>Support different chat channel types & tags for use in DM code</li>
|
|
</ul>
|
|
</li>
|
|
<li>Configuration system<ul>
|
|
<li>Allows specifying files/directories to be permanently symlinked with active game code</li>
|
|
<li>Support for scripts that run on certain events. e.g. Before/after compiling</li>
|
|
<li>Allows including arbitrary .dm code in compilations</li>
|
|
<li>ACL support with Windows based logins</li>
|
|
</ul>
|
|
</li>
|
|
<li>DMAPI, DM code interop<ul>
|
|
<li>Provides metadata such as the current TGS version, git revision, active pull requests, security level</li>
|
|
<li>Provides API for responding to TGS events (compile, update, etc)</li>
|
|
<li>Provides API for sending chat bot messages</li>
|
|
<li>Provides API for implementing chat bot commands in DM code</li>
|
|
<li>Gives the ability to restart the DreamDaemon process from DM code</li>
|
|
<li>Functions with all 3 DreamDaemon security levels</li>
|
|
<li>Provides notifications of TGS side events</li>
|
|
<li>Allows specifying the .dmb's minimum required security level</li>
|
|
<li>Broadcast messages to clients </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div></div><!-- contents -->
|
|
</div><!-- PageDoc -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
|
|
</small></address>
|
|
</body>
|
|
</html>
|