cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-24 21:46:52 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
tgstation-server/_internal_configuration_8cs_source.html
T

138 lines
19 KiB
HTML
Raw Permalink Blame History

<!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: src/Tgstation.Server.Host/Configuration/InternalConfiguration.cs Source File</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">&#160;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&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_34761767c1c3cd212f9d2f80ea0828a8.html">Tgstation.Server.Host</a></li><li class="navelem"><a class="el" href="dir_08963d262fa9e27215dce7b7c6e97f1b.html">Configuration</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">InternalConfiguration.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_internal_configuration_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_configuration.html">Tgstation.Server.Host.Configuration</a></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span>{</div>
<div class="foldopen" id="foldopen00006" data-start="{" data-end="};">
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html"> 6</a></span> <span class="keyword">public</span> <span class="keyword">sealed</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html">InternalConfiguration</a></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> {</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#a983f7d101d4448c1cdc3c5bad205ef3b"> 11</a></span> <span class="keyword">public</span> <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#a983f7d101d4448c1cdc3c5bad205ef3b">Section</a> = <span class="stringliteral">&quot;Internal&quot;</span>;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#a67691759fb5b1fbc6f3bfac576e6063c"> 16</a></span> <span class="keyword">public</span> <span class="keywordtype">string</span>? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#a67691759fb5b1fbc6f3bfac576e6063c">CommandPipe</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#aabc6655b3374de5309d88a6a8b074c56"> 21</a></span> <span class="keyword">public</span> <span class="keywordtype">string</span>? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#aabc6655b3374de5309d88a6a8b074c56">ReadyPipe</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#ab57493826c9b76fcd8f0fc0fdaa3fdf7"> 26</a></span> <span class="keyword">public</span> <span class="keywordtype">bool</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#ab57493826c9b76fcd8f0fc0fdaa3fdf7">UsingSystemD</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#a1f50fda278b5586a9bc01c4f50f83f77"> 31</a></span> <span class="keyword">public</span> <span class="keywordtype">bool</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#a1f50fda278b5586a9bc01c4f50f83f77">UsingDocker</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#ad05efeef4b191400c7c15f0cc630c61e"> 36</a></span> <span class="keyword">public</span> <span class="keywordtype">string</span>? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#ad05efeef4b191400c7c15f0cc630c61e">DumpGraphQLApiPath</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="foldopen" id="foldopen00041" data-start="{" data-end="};">
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#a3852d47f676956516d770d2e14beb968"> 41</a></span> <span class="keyword">public</span> <span class="keywordtype">bool</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#a3852d47f676956516d770d2e14beb968">EnableGraphQL</a></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="preprocessor">#if DEBUG</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> =&gt; <span class="keyword">true</span>;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#add1fd36adcba522710b5f52fe6fb5649"> 51</a></span> <span class="keyword">public</span> <span class="keywordtype">string</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#add1fd36adcba522710b5f52fe6fb5649">AppSettingsBasePath</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; } = <span class="stringliteral">&quot;UNINITIALIZED&quot;</span>; <span class="comment">// this is set in a hacky way in ServerFactory</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#a6e5cf99a281100c024bdadc52baa5081"> 56</a></span> <span class="keyword">public</span> <span class="keywordtype">bool</span> <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#a6e5cf99a281100c024bdadc52baa5081">MariaDBSetup</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#a13fdaf7fa69a89f806d2f5abce0d67c4"> 61</a></span> <span class="keyword">public</span> <span class="keywordtype">string</span>? <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#a13fdaf7fa69a89f806d2f5abce0d67c4">MariaDBDefaultRootPassword</a> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> }</div>
</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html">Tgstation.Server.Host.Configuration.InternalConfiguration</a></div><div class="ttdoc">Unstable configuration options used internally by TGS.</div><div class="ttdef"><b>Definition</b> <a href="_internal_configuration_8cs_source.html#l00006">InternalConfiguration.cs:7</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration_html_a13fdaf7fa69a89f806d2f5abce0d67c4"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#a13fdaf7fa69a89f806d2f5abce0d67c4">Tgstation.Server.Host.Configuration.InternalConfiguration.MariaDBDefaultRootPassword</a></div><div class="ttdeci">string? MariaDBDefaultRootPassword</div><div class="ttdoc">Generate default configuration using the given DatabaseType.MariaDB default password.</div><div class="ttdef"><b>Definition</b> <a href="_internal_configuration_8cs_source.html#l00061">InternalConfiguration.cs:61</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration_html_a1f50fda278b5586a9bc01c4f50f83f77"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#a1f50fda278b5586a9bc01c4f50f83f77">Tgstation.Server.Host.Configuration.InternalConfiguration.UsingDocker</a></div><div class="ttdeci">bool UsingDocker</div><div class="ttdoc">If the server is running inside of a Docker container.</div><div class="ttdef"><b>Definition</b> <a href="_internal_configuration_8cs_source.html#l00031">InternalConfiguration.cs:31</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration_html_a3852d47f676956516d770d2e14beb968"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#a3852d47f676956516d770d2e14beb968">Tgstation.Server.Host.Configuration.InternalConfiguration.EnableGraphQL</a></div><div class="ttdeci">bool EnableGraphQL</div><div class="ttdoc">Enables hosting the experimental GraphQL API in Release builds.</div><div class="ttdef"><b>Definition</b> <a href="_internal_configuration_8cs_source.html#l00041">InternalConfiguration.cs:45</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration_html_a67691759fb5b1fbc6f3bfac576e6063c"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#a67691759fb5b1fbc6f3bfac576e6063c">Tgstation.Server.Host.Configuration.InternalConfiguration.CommandPipe</a></div><div class="ttdeci">string? CommandPipe</div><div class="ttdoc">The name of the pipe opened by the host watchdog for sending commands, if any.</div><div class="ttdef"><b>Definition</b> <a href="_internal_configuration_8cs_source.html#l00016">InternalConfiguration.cs:16</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration_html_a6e5cf99a281100c024bdadc52baa5081"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#a6e5cf99a281100c024bdadc52baa5081">Tgstation.Server.Host.Configuration.InternalConfiguration.MariaDBSetup</a></div><div class="ttdeci">bool MariaDBSetup</div><div class="ttdoc">Coerce the Setup.SetupWizard to select DatabaseType.MariaDB.</div><div class="ttdef"><b>Definition</b> <a href="_internal_configuration_8cs_source.html#l00056">InternalConfiguration.cs:56</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration_html_a983f7d101d4448c1cdc3c5bad205ef3b"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#a983f7d101d4448c1cdc3c5bad205ef3b">Tgstation.Server.Host.Configuration.InternalConfiguration.Section</a></div><div class="ttdeci">const string Section</div><div class="ttdoc">The key for the Microsoft.Extensions.Configuration.IConfigurationSection the InternalConfiguration re...</div><div class="ttdef"><b>Definition</b> <a href="_internal_configuration_8cs_source.html#l00011">InternalConfiguration.cs:11</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration_html_aabc6655b3374de5309d88a6a8b074c56"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#aabc6655b3374de5309d88a6a8b074c56">Tgstation.Server.Host.Configuration.InternalConfiguration.ReadyPipe</a></div><div class="ttdeci">string? ReadyPipe</div><div class="ttdoc">The name of the pipe opened by the host watchdog for receiving commands, if any.</div><div class="ttdef"><b>Definition</b> <a href="_internal_configuration_8cs_source.html#l00021">InternalConfiguration.cs:21</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration_html_ab57493826c9b76fcd8f0fc0fdaa3fdf7"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#ab57493826c9b76fcd8f0fc0fdaa3fdf7">Tgstation.Server.Host.Configuration.InternalConfiguration.UsingSystemD</a></div><div class="ttdeci">bool UsingSystemD</div><div class="ttdoc">If the server is running under SystemD.</div><div class="ttdef"><b>Definition</b> <a href="_internal_configuration_8cs_source.html#l00026">InternalConfiguration.cs:26</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration_html_ad05efeef4b191400c7c15f0cc630c61e"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#ad05efeef4b191400c7c15f0cc630c61e">Tgstation.Server.Host.Configuration.InternalConfiguration.DumpGraphQLApiPath</a></div><div class="ttdeci">string? DumpGraphQLApiPath</div><div class="ttdoc">Used at compile time to write the GraphQL API schema to this path and exit.</div><div class="ttdef"><b>Definition</b> <a href="_internal_configuration_8cs_source.html#l00036">InternalConfiguration.cs:36</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration_html_add1fd36adcba522710b5f52fe6fb5649"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_internal_configuration.html#add1fd36adcba522710b5f52fe6fb5649">Tgstation.Server.Host.Configuration.InternalConfiguration.AppSettingsBasePath</a></div><div class="ttdeci">string AppSettingsBasePath</div><div class="ttdoc">The base path for the app settings configuration files.</div><div class="ttdef"><b>Definition</b> <a href="_internal_configuration_8cs_source.html#l00051">InternalConfiguration.cs:51</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_configuration_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_configuration.html">Tgstation.Server.Host.Configuration</a></div><div class="ttdef"><b>Definition</b> <a href="_control_panel_configuration_8cs_source.html#l00003">ControlPanelConfiguration.cs:4</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>
Reference in New Issue View Git Blame Copy Permalink