diff --git a/_administration_controller_8cs_source.html b/_administration_controller_8cs_source.html index 85c7a83c64..1c3cbdc612 100644 --- a/_administration_controller_8cs_source.html +++ b/_administration_controller_8cs_source.html @@ -113,15 +113,15 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
Go to the source code of this file.
++Classes | |
| class | Tgstation.Server.Host.IO.Console |
+Namespaces | |
| namespace | Tgstation.Server.Host.IO |
+ 1.8.11
+
+
+
diff --git a/_console_8cs_source.html b/_console_8cs_source.html
new file mode 100644
index 0000000000..7f181a67d1
--- /dev/null
+++ b/_console_8cs_source.html
@@ -0,0 +1,109 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+ 1.8.11
+
+
+
diff --git a/_credentials_provider_8cs_source.html b/_credentials_provider_8cs_source.html
index 7f01d26a06..fb49f80f6b 100644
--- a/_credentials_provider_8cs_source.html
+++ b/_credentials_provider_8cs_source.html
@@ -95,7 +95,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Go to the documentation of this file.|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
Go to the source code of this file.
++Classes | |
| class | Tgstation.Server.Host.Core.DBConnectionFactory |
+Namespaces | |
| namespace | Tgstation.Server.Host.Core |
+ 1.8.11
+
+
+
diff --git a/_d_b_connection_factory_8cs_source.html b/_d_b_connection_factory_8cs_source.html
new file mode 100644
index 0000000000..4738430f50
--- /dev/null
+++ b/_d_b_connection_factory_8cs_source.html
@@ -0,0 +1,114 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+ 1.8.11
+
+
+
diff --git a/_database_configuration_8cs_source.html b/_database_configuration_8cs_source.html
index 993604b0d5..db9b47bab8 100644
--- a/_database_configuration_8cs_source.html
+++ b/_database_configuration_8cs_source.html
@@ -92,7 +92,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
Go to the source code of this file.
++Classes | |
| interface | Tgstation.Server.Host.IO.IConsole |
| Abstraction for System.Console More... | |
+Namespaces | |
| namespace | Tgstation.Server.Host.IO |
+ 1.8.11
+
+
+
diff --git a/_i_console_8cs_source.html b/_i_console_8cs_source.html
new file mode 100644
index 0000000000..15e1707b6c
--- /dev/null
+++ b/_i_console_8cs_source.html
@@ -0,0 +1,107 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+ 1.8.11
+
+
+
diff --git a/_i_d_b_connection_factory_8cs.html b/_i_d_b_connection_factory_8cs.html
new file mode 100644
index 0000000000..70589a5570
--- /dev/null
+++ b/_i_d_b_connection_factory_8cs.html
@@ -0,0 +1,120 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
Go to the source code of this file.
++Classes | |
| interface | Tgstation.Server.Host.Core.IDBConnectionFactory |
| For creating DbConnection More... | |
+Namespaces | |
| namespace | Tgstation.Server.Host.Core |
+ 1.8.11
+
+
+
diff --git a/_i_d_b_connection_factory_8cs_source.html b/_i_d_b_connection_factory_8cs_source.html
new file mode 100644
index 0000000000..2544fbc2f9
--- /dev/null
+++ b/_i_d_b_connection_factory_8cs_source.html
@@ -0,0 +1,111 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+ 1.8.11
+
+
+
diff --git a/_i_network_prompt_reaper_8cs_source.html b/_i_network_prompt_reaper_8cs_source.html
index 2154ec5fd2..594b6648f8 100644
--- a/_i_network_prompt_reaper_8cs_source.html
+++ b/_i_network_prompt_reaper_8cs_source.html
@@ -93,7 +93,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
Go to the source code of this file.
++Classes | |
| interface | Tgstation.Server.Host.Core.ISetupWizard |
| The command line Configuration setup wizard More... | |
+Namespaces | |
| namespace | Tgstation.Server.Host.Core |
+ 1.8.11
+
+
+
diff --git a/_i_setup_wizard_8cs_source.html b/_i_setup_wizard_8cs_source.html
new file mode 100644
index 0000000000..d100926ce1
--- /dev/null
+++ b/_i_setup_wizard_8cs_source.html
@@ -0,0 +1,107 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+ 1.8.11
+
+
+
diff --git a/_i_token_factory_8cs_source.html b/_i_token_factory_8cs_source.html
index 5ec20026cd..7deeebb241 100644
--- a/_i_token_factory_8cs_source.html
+++ b/_i_token_factory_8cs_source.html
@@ -92,9 +92,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
Go to the source code of this file.
++Classes | |
| class | Tgstation.Server.Host.Core.SetupWizard |
+Namespaces | |
| namespace | Tgstation.Server.Host.Core |
+ 1.8.11
+
+
+
diff --git a/_setup_wizard_8cs_source.html b/_setup_wizard_8cs_source.html
new file mode 100644
index 0000000000..87661dd5ac
--- /dev/null
+++ b/_setup_wizard_8cs_source.html
@@ -0,0 +1,144 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+ 1.8.11
+
+
+
diff --git a/_setup_wizard_mode_8cs.html b/_setup_wizard_mode_8cs.html
new file mode 100644
index 0000000000..3ed6e1ae18
--- /dev/null
+++ b/_setup_wizard_mode_8cs.html
@@ -0,0 +1,124 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
Go to the source code of this file.
++Namespaces | |
| namespace | Tgstation.Server.Host.Configuration |
+Enumerations | |
| enum | Tgstation.Server.Host.Configuration.SetupWizardMode { Tgstation.Server.Host.Configuration.SetupWizardMode.Autodetect, +Tgstation.Server.Host.Configuration.SetupWizardMode.Force, +Tgstation.Server.Host.Configuration.SetupWizardMode.Only, +Tgstation.Server.Host.Configuration.SetupWizardMode.Never + } |
| Determines if the Core.ISetupWizard will run More... | |
+ 1.8.11
+
+
+
diff --git a/_setup_wizard_mode_8cs_source.html b/_setup_wizard_mode_8cs_source.html
new file mode 100644
index 0000000000..7d45aa87aa
--- /dev/null
+++ b/_setup_wizard_mode_8cs_source.html
@@ -0,0 +1,111 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+ 1.8.11
+
+
+
diff --git a/_sql_server_database_context_8cs_source.html b/_sql_server_database_context_8cs_source.html
index 5518f3f950..b65d0d2a55 100644
--- a/_sql_server_database_context_8cs_source.html
+++ b/_sql_server_database_context_8cs_source.html
@@ -92,15 +92,15 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
Go to the source code of this file.
++Namespaces | |
| namespace | Tgstation.Server.Host.Core.Tests |
+ 1.8.11
+
+
+
diff --git a/_test_application_8cs_source.html b/_test_application_8cs_source.html
new file mode 100644
index 0000000000..b5d24d13ec
--- /dev/null
+++ b/_test_application_8cs_source.html
@@ -0,0 +1,121 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+ 1.8.11
+
+
+
diff --git a/_test_console_8cs.html b/_test_console_8cs.html
new file mode 100644
index 0000000000..9cea070d99
--- /dev/null
+++ b/_test_console_8cs.html
@@ -0,0 +1,119 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
Go to the source code of this file.
++Classes | |
| class | Tgstation.Server.Host.IO.Tests.TestConsole |
+Namespaces | |
| namespace | Tgstation.Server.Host.IO.Tests |
+ 1.8.11
+
+
+
diff --git a/_test_console_8cs_source.html b/_test_console_8cs_source.html
new file mode 100644
index 0000000000..30669715f5
--- /dev/null
+++ b/_test_console_8cs_source.html
@@ -0,0 +1,110 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+ 1.8.11
+
+
+
diff --git a/_test_d_b_connection_factory_8cs.html b/_test_d_b_connection_factory_8cs.html
new file mode 100644
index 0000000000..dbf5b2e8de
--- /dev/null
+++ b/_test_d_b_connection_factory_8cs.html
@@ -0,0 +1,119 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
Go to the source code of this file.
++Classes | |
| class | Tgstation.Server.Host.Core.Tests.TestDBConnectionFactory |
+Namespaces | |
| namespace | Tgstation.Server.Host.Core.Tests |
+ 1.8.11
+
+
+
diff --git a/_test_d_b_connection_factory_8cs_source.html b/_test_d_b_connection_factory_8cs_source.html
new file mode 100644
index 0000000000..9ffd778250
--- /dev/null
+++ b/_test_d_b_connection_factory_8cs_source.html
@@ -0,0 +1,115 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+ 1.8.11
+
+
+
diff --git a/_test_database_context_factory_8cs_source.html b/_test_database_context_factory_8cs_source.html
index 7445686152..c1c39d8bd9 100644
--- a/_test_database_context_factory_8cs_source.html
+++ b/_test_database_context_factory_8cs_source.html
@@ -92,7 +92,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
Go to the source code of this file.
++Classes | |
| class | Tgstation.Server.Host.Core.Tests.TestSetupWizard |
+Namespaces | |
| namespace | Tgstation.Server.Host.Core.Tests |
+ 1.8.11
+
+
+
diff --git a/_test_setup_wizard_8cs_source.html b/_test_setup_wizard_8cs_source.html
new file mode 100644
index 0000000000..164730324b
--- /dev/null
+++ b/_test_setup_wizard_8cs_source.html
@@ -0,0 +1,119 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+ 1.8.11
+
+
+
diff --git a/_test_symlink_factory_8cs_source.html b/_test_symlink_factory_8cs_source.html
index 885d89e822..78cfee9079 100644
--- a/_test_symlink_factory_8cs_source.html
+++ b/_test_symlink_factory_8cs_source.html
@@ -92,7 +92,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+
+
+ 1.8.11
+
+
+
diff --git a/class_i_application_lifetime.png b/class_i_application_lifetime.png
new file mode 100644
index 0000000000..af76b2c1fb
Binary files /dev/null and b/class_i_application_lifetime.png differ
diff --git a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_token.html b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_token.html
index 4c8fc2c8cb..6d90f02ca8 100644
--- a/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_token.html
+++ b/class_tgstation_1_1_server_1_1_api_1_1_models_1_1_token.html
@@ -138,7 +138,7 @@ Properties
Definition at line 13 of file Token.cs.
-Referenced by Tgstation.Server.Client.ServerClientFactory.CreateServerClient(), and Tgstation.Server.Client.ServerClient.ServerClient().
+Referenced by Tgstation.Server.Client.ServerClientFactory.CreateServerClient(), Tgstation.Server.Tests.IntegrationTest.FullMonty(), and Tgstation.Server.Client.ServerClient.ServerClient().
@@ -164,6 +164,8 @@ PropertiesDefinition at line 18 of file Token.cs.
+Referenced by Tgstation.Server.Tests.IntegrationTest.FullMonty().
+Configuration options for the Models.DatabaseContext<TParentContext>
-Definition at line 6 of file DatabaseConfiguration.cs.
+Definition at line 9 of file DatabaseConfiguration.cs.
The key for the Microsoft.Extensions.Configuration.IConfigurationSection the DatabaseConfiguration resides in
-Definition at line 11 of file DatabaseConfiguration.cs.
+Definition at line 14 of file DatabaseConfiguration.cs.
-Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices(), and Tgstation.Server.Host.Models.Migrations.DesignTimeDbContextFactoryHelpers.GetDbContextOptions().
+Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices(), Tgstation.Server.Host.Models.Migrations.DesignTimeDbContextFactoryHelpers.GetDbContextOptions(), and Tgstation.Server.Host.Core.SetupWizard.SaveConfiguration().
The connection string for the database
-Definition at line 26 of file DatabaseConfiguration.cs.
+Definition at line 30 of file DatabaseConfiguration.cs.
Referenced by Tgstation.Server.Host.Models.SqlServerDatabaseContext.OnConfiguring(), and Tgstation.Server.Host.Models.MySqlDatabaseContext.OnConfiguring().
@@ -197,9 +197,9 @@ PropertiesThe Configuration.DatabaseType to create
-Definition at line 16 of file DatabaseConfiguration.cs.
+Definition at line 20 of file DatabaseConfiguration.cs.
-Referenced by Tgstation.Server.Host.Models.MySqlDatabaseContext.OnConfiguring().
+Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices(), and Tgstation.Server.Host.Models.MySqlDatabaseContext.OnConfiguring().
@@ -223,7 +223,7 @@ PropertiesIf the database should be deleted on application startup. Should not be used in production!
-Definition at line 31 of file DatabaseConfiguration.cs.
+Definition at line 35 of file DatabaseConfiguration.cs.
Referenced by Tgstation.Server.Host.Models.DatabaseContext< SqlServerDatabaseContext >.Initialize().
@@ -249,7 +249,7 @@ PropertiesThe string form of the System.Version of a target MySQL/MariaDB server
-Definition at line 36 of file DatabaseConfiguration.cs.
+Definition at line 40 of file DatabaseConfiguration.cs.
Referenced by Tgstation.Server.Host.Models.MySqlDatabaseContext.OnConfiguring().
@@ -275,7 +275,7 @@ PropertiesIf the admin user should be enabled and have it's password reset
-Definition at line 21 of file DatabaseConfiguration.cs.
+Definition at line 25 of file DatabaseConfiguration.cs.
Referenced by Tgstation.Server.Host.Models.DatabaseContext< SqlServerDatabaseContext >.Initialize().
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_file_logging_configuration-members.html b/class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_file_logging_configuration-members.html index aafa1c5b7b..fb0a9c5491 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_file_logging_configuration-members.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_file_logging_configuration-members.html @@ -98,10 +98,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');This is the complete list of members for Tgstation.Server.Host.Configuration.FileLoggingConfiguration, including all inherited members.
[get, set] [get, set] [get, set] [get, set] [get, set]+Private Attributes | |
| const LogLevel | DefaultLogLevel = LogLevel.Debug |
| Default value for LogLevel More... | |
| const LogLevel | DefaultMicrosoftLogLevel = LogLevel.Warning |
| Default value for MicrosoftLogLevel More... | |
File logging configuration options
-Definition at line 6 of file FileLoggingConfiguration.cs.
+Definition at line 10 of file FileLoggingConfiguration.cs.
+
|
+ +private | +
Default value for LogLevel
+ +Definition at line 20 of file FileLoggingConfiguration.cs.
+ +
+
|
+ +private | +
Default value for MicrosoftLogLevel
+ +Definition at line 25 of file FileLoggingConfiguration.cs.
+ +The key for the Microsoft.Extensions.Configuration.IConfigurationSection the FileLoggingConfiguration resides in
-Definition at line 11 of file FileLoggingConfiguration.cs.
+Definition at line 15 of file FileLoggingConfiguration.cs.
-Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices().
+Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices(), and Tgstation.Server.Host.Core.SetupWizard.SaveConfiguration().
Where log files are stored
-Definition at line 16 of file FileLoggingConfiguration.cs.
+Definition at line 30 of file FileLoggingConfiguration.cs.
-Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices().
+Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices().
@@ -194,11 +252,13 @@ PropertiesIf file logging is disabled
-Definition at line 21 of file FileLoggingConfiguration.cs.
+Definition at line 35 of file FileLoggingConfiguration.cs.
+ +Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices().
- +
|
@@ -216,13 +276,15 @@ Properties
The stringified minimum Microsoft.Extensions.Logging.LogLevel to display in logs
+The minimum Microsoft.Extensions.Logging.LogLevel to display in logs
-Definition at line 26 of file FileLoggingConfiguration.cs.
+Definition at line 41 of file FileLoggingConfiguration.cs.
+ +Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices().
|
@@ -240,9 +302,11 @@ Properties
The stringified minimum Microsoft.Extensions.Logging.LogLevel to display in logs for Microsoft library sources
+The minimum Microsoft.Extensions.Logging.LogLevel to display in logs for Microsoft library sources
-Definition at line 32 of file FileLoggingConfiguration.cs.
+Definition at line 48 of file FileLoggingConfiguration.cs.
+ +Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices().
This is the complete list of members for Tgstation.Server.Host.Configuration.GeneralConfiguration, including all inherited members.
[get, set] [get, set] [get, set] [get, set] [get, set]+Private Attributes | |
| const uint | DefaultMinimumPasswordLength = 15 |
| The default value for MinimumPasswordLength More... | |
| const int | DefaultByondTopicTimeout = 5000 |
| The default value for ByondTopicTimeout More... | |
General configuration options
-Definition at line 6 of file GeneralConfiguration.cs.
+Definition at line 9 of file GeneralConfiguration.cs.
+
|
+ +private | +
The default value for ByondTopicTimeout
+ +Definition at line 24 of file GeneralConfiguration.cs.
+ +
+
|
+ +private | +
The default value for MinimumPasswordLength
+ +Definition at line 19 of file GeneralConfiguration.cs.
+ +The key for the Microsoft.Extensions.Configuration.IConfigurationSection the GeneralConfiguration resides in
-Definition at line 11 of file GeneralConfiguration.cs.
+Definition at line 14 of file GeneralConfiguration.cs.
-Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices().
+Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices(), and Tgstation.Server.Host.Core.SetupWizard.SaveConfiguration().
+
|
+ +getset | +
The timeout in milliseconds for sending and receiving topics to/from DreamDaemon. Note that a single topic exchange can take up to twice this value
+ +Definition at line 45 of file GeneralConfiguration.cs.
+ +| string Tgstation.Server.Host.Configuration.GeneralConfiguration.GitHubAccessToken | +string Tgstation.Server.Host.Configuration.GeneralConfiguration.GitHubAccessToken = DefaultMinimumPasswordLength |
A GitHub personal access token to use for bypassing rate limits on requests. Requires no scopes
-Definition at line 21 of file GeneralConfiguration.cs.
+Definition at line 34 of file GeneralConfiguration.cs.
Minimum length of database user passwords
-Definition at line 16 of file GeneralConfiguration.cs.
+Definition at line 29 of file GeneralConfiguration.cs.
+ +Referenced by Tgstation.Server.Host.Core.SetupWizard.ConfigureGeneral().
+ + + + +
+
|
+ +getset | +
The SetupWizardMode
+ +Definition at line 40 of file GeneralConfiguration.cs.
Definition at line 11 of file UpdatesConfiguration.cs.
-Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices().
+Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices().
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_console_1_1_tests_1_1_test_program.html b/class_tgstation_1_1_server_1_1_host_1_1_console_1_1_tests_1_1_test_program.html index 41d5ddb3ef..a7f0c22394 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_console_1_1_tests_1_1_test_program.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_console_1_1_tests_1_1_test_program.html @@ -122,7 +122,7 @@ Public Member FunctionsDefinition at line 15 of file TestProgram.cs.
-Definition at line 38 of file Application.cs.
+Definition at line 37 of file Application.cs.
Definition at line 66 of file Application.cs.
-Definition at line 68 of file Application.cs.
+inheritdoc />
-Definition at line 292 of file Application.cs.
+Definition at line 308 of file Application.cs.
References Tgstation.Server.Host.Core.IServerControl.Restart().
@@ -279,35 +280,38 @@ Private Attributes -Definition at line 81 of file Application.cs.
+Definition at line 83 of file Application.cs.
-References Tgstation.Server.Host.Configuration.FileLoggingConfiguration.Directory, Tgstation.Server.Host.Configuration.UpdatesConfiguration.Section, Tgstation.Server.Host.Configuration.FileLoggingConfiguration.Section, Tgstation.Server.Host.Configuration.DatabaseConfiguration.Section, Tgstation.Server.Host.Configuration.GeneralConfiguration.Section, Tgstation.Server.Host.Security.TokenFactory.TokenAudience, Tgstation.Server.Host.Security.TokenFactory.TokenIssuer, and Tgstation.Server.Host.Security.TokenFactory.TokenSigningKey.
-References Tgstation.Server.Host.Core.ISetupWizard.CheckRunWizard(), Tgstation.Server.Host.IO.IIOManager.ConcatPath(), Tgstation.Server.Host.Configuration.DatabaseConfiguration.DatabaseType, Tgstation.Server.Host.Configuration.FileLoggingConfiguration.Directory, Tgstation.Server.Host.Configuration.FileLoggingConfiguration.Disable, Tgstation.Server.Host.Configuration.FileLoggingConfiguration.LogLevel, Tgstation.Server.Host.Configuration.FileLoggingConfiguration.MicrosoftLogLevel, Tgstation.Server.Host.Configuration.UpdatesConfiguration.Section, Tgstation.Server.Host.Configuration.DatabaseConfiguration.Section, Tgstation.Server.Host.Configuration.GeneralConfiguration.Section, Tgstation.Server.Host.Configuration.FileLoggingConfiguration.Section, and Tgstation.Server.Host.Security.ITokenFactory.ValidationParameters.
+Implements Tgstation.Server.Host.Core.IApplication.
-Definition at line 324 of file Application.cs.
-Definition at line 350 of file Application.cs.
+The IConfiguration for the Application
-Definition at line 52 of file Application.cs.
+Definition at line 51 of file Application.cs.
The Microsoft.AspNetCore.Hosting.IHostingEnvironment for the Application
-Definition at line 57 of file Application.cs.
+Definition at line 56 of file Application.cs.
@@ -443,7 +449,9 @@ Private AttributesDefinition at line 59 of file Application.cs.
+The TaskCompletionSource<TResult> used for determining when the Application is Ready(Exception)
+ +Definition at line 61 of file Application.cs.
Definition at line 41 of file Application.cs.
+Definition at line 40 of file Application.cs.
@@ -484,7 +492,7 @@ Private Attributes -Definition at line 44 of file Application.cs.
+Definition at line 43 of file Application.cs.
@@ -508,7 +516,7 @@ Private Attributes -Definition at line 47 of file Application.cs.
+Definition at line 46 of file Application.cs.
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_d_b_connection_factory-members.html b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_d_b_connection_factory-members.html new file mode 100644 index 0000000000..c7bb68c3b3 --- /dev/null +++ b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_d_b_connection_factory-members.html @@ -0,0 +1,110 @@ + + + + + + +|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
This is the complete list of members for Tgstation.Server.Host.Core.DBConnectionFactory, including all inherited members.
+| CreateConnection(string connectionString, DatabaseType databaseType) | Tgstation.Server.Host.Core.DBConnectionFactory |
+ 1.8.11
+
+
+
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_d_b_connection_factory.html b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_d_b_connection_factory.html
new file mode 100644
index 0000000000..ccbdeccaf9
--- /dev/null
+++ b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_d_b_connection_factory.html
@@ -0,0 +1,168 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+ More...
+
+
+ +Public Member Functions | |
| DbConnection | CreateConnection (string connectionString, DatabaseType databaseType) |
| Create a DbConnection More... | |
Definition at line 11 of file DBConnectionFactory.cs.
+| DbConnection Tgstation.Server.Host.Core.DBConnectionFactory.CreateConnection | +( | +string | +connectionString, | +
| + | + | DatabaseType | +databaseType | +
| + | ) | ++ |
Create a DbConnection
+ +Implements Tgstation.Server.Host.Core.IDBConnectionFactory.
+ +Definition at line 14 of file DBConnectionFactory.cs.
+
+ 1.8.11
+
+
+
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_d_b_connection_factory.png b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_d_b_connection_factory.png
new file mode 100644
index 0000000000..e93ff7efd3
Binary files /dev/null and b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_d_b_connection_factory.png differ
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_setup_wizard-members.html b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_setup_wizard-members.html
new file mode 100644
index 0000000000..2cc0e123b1
--- /dev/null
+++ b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_setup_wizard-members.html
@@ -0,0 +1,125 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
This is the complete list of members for Tgstation.Server.Host.Core.SetupWizard, including all inherited members.
+| application | Tgstation.Server.Host.Core.SetupWizard | private |
| CheckRunWizard(CancellationToken cancellationToken) | Tgstation.Server.Host.Core.SetupWizard | |
| ConfigureDatabase(CancellationToken cancellationToken) | Tgstation.Server.Host.Core.SetupWizard | private |
| ConfigureGeneral(CancellationToken cancellationToken) | Tgstation.Server.Host.Core.SetupWizard | private |
| ConfigureLogging(CancellationToken cancellationToken) | Tgstation.Server.Host.Core.SetupWizard | private |
| console | Tgstation.Server.Host.Core.SetupWizard | private |
| dbConnectionFactory | Tgstation.Server.Host.Core.SetupWizard | private |
| generalConfiguration | Tgstation.Server.Host.Core.SetupWizard | private |
| hostingEnvironment | Tgstation.Server.Host.Core.SetupWizard | private |
| ioManager | Tgstation.Server.Host.Core.SetupWizard | private |
| logger | Tgstation.Server.Host.Core.SetupWizard | private |
| PromptForHostingPort(CancellationToken cancellationToken) | Tgstation.Server.Host.Core.SetupWizard | private |
| PromptYesNo(string question, CancellationToken cancellationToken) | Tgstation.Server.Host.Core.SetupWizard | private |
| RunWizard(string userConfigFileName, CancellationToken cancellationToken) | Tgstation.Server.Host.Core.SetupWizard | private |
| SaveConfiguration(string userConfigFileName, ushort?hostingPort, DatabaseConfiguration databaseConfiguration, GeneralConfiguration newGeneralConfiguration, FileLoggingConfiguration fileLoggingConfiguration, CancellationToken cancellationToken) | Tgstation.Server.Host.Core.SetupWizard | private |
| SetupWizard(IIOManager ioManager, IConsole console, IHostingEnvironment hostingEnvironment, IApplication application, IDBConnectionFactory dbConnectionFactory, ILogger< SetupWizard > logger, IOptions< GeneralConfiguration > generalConfigurationOptions) | Tgstation.Server.Host.Core.SetupWizard |
+ 1.8.11
+
+
+
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_setup_wizard.html b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_setup_wizard.html
new file mode 100644
index 0000000000..f097065a5a
--- /dev/null
+++ b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_setup_wizard.html
@@ -0,0 +1,834 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+ More...
+
+
+ +Public Member Functions | |
| SetupWizard (IIOManager ioManager, IConsole console, IHostingEnvironment hostingEnvironment, IApplication application, IDBConnectionFactory dbConnectionFactory, ILogger< SetupWizard > logger, IOptions< GeneralConfiguration > generalConfigurationOptions) | |
| Construct a SetupWizard More... | |
| async Task< bool > | CheckRunWizard (CancellationToken cancellationToken) |
| Run the setup wizard if necessary More... | |
+Private Member Functions | |
| async Task< bool > | PromptYesNo (string question, CancellationToken cancellationToken) |
| A prompt for a yes or no value More... | |
| async Task< ushort?> | PromptForHostingPort (CancellationToken cancellationToken) |
| Prompts the user to enter the port to host TGS on More... | |
| async Task< DatabaseConfiguration > | ConfigureDatabase (CancellationToken cancellationToken) |
| Prompts the user to create a DatabaseConfiguration More... | |
| async Task< GeneralConfiguration > | ConfigureGeneral (CancellationToken cancellationToken) |
| Prompts the user to create a GeneralConfiguration More... | |
| async Task< FileLoggingConfiguration > | ConfigureLogging (CancellationToken cancellationToken) |
| Prompts the user to create a FileLoggingConfiguration More... | |
| async Task | SaveConfiguration (string userConfigFileName, ushort?hostingPort, DatabaseConfiguration databaseConfiguration, GeneralConfiguration newGeneralConfiguration, FileLoggingConfiguration fileLoggingConfiguration, CancellationToken cancellationToken) |
| Saves a given Configuration set to userConfigFileName More... | |
| async Task | RunWizard (string userConfigFileName, CancellationToken cancellationToken) |
| Runs the SetupWizard More... | |
+Private Attributes | |
| readonly IIOManager | ioManager |
| The IIOManager for the SetupWizard More... | |
| readonly IConsole | console |
| The IConsole for the SetupWizard More... | |
| readonly IHostingEnvironment | hostingEnvironment |
| The IHostingEnvironment for the SetupWizard More... | |
| readonly IApplication | application |
| The IApplication for the SetupWizard More... | |
| readonly IDBConnectionFactory | dbConnectionFactory |
| The IDBConnectionFactory for the SetupWizard More... | |
| readonly ILogger< SetupWizard > | logger |
| The ILogger for the SetupWizard More... | |
| readonly GeneralConfiguration | generalConfiguration |
| The GeneralConfiguration for the SetupWizard More... | |
Definition at line 21 of file SetupWizard.cs.
+| Tgstation.Server.Host.Core.SetupWizard.SetupWizard | +( | +IIOManager | +ioManager, | +
| + | + | IConsole | +console, | +
| + | + | IHostingEnvironment | +hostingEnvironment, | +
| + | + | IApplication | +application, | +
| + | + | IDBConnectionFactory | +dbConnectionFactory, | +
| + | + | ILogger< SetupWizard > | +logger, | +
| + | + | IOptions< GeneralConfiguration > | +generalConfigurationOptions | +
| + | ) | ++ |
Construct a SetupWizard
+| ioManager | The value of ioManager |
| console | The value of console |
| hostingEnvironment | The value of hostingEnvironment |
| application | The value of application |
| dbConnectionFactory | The value of dbConnectionFactory |
| logger | The value of logger |
| generalConfigurationOptions | The IOptions<TOptions> containing the value of generalConfiguration |
Definition at line 68 of file SetupWizard.cs.
+| async Task<bool> Tgstation.Server.Host.Core.SetupWizard.CheckRunWizard | +( | +CancellationToken | +cancellationToken | ) | ++ |
Run the setup wizard if necessary
+ +Implements Tgstation.Server.Host.Core.ISetupWizard.
+ +Definition at line 527 of file SetupWizard.cs.
+
+
|
+ +private | +
Prompts the user to create a DatabaseConfiguration
+| cancellationToken | The CancellationToken for the operation |
Definition at line 130 of file SetupWizard.cs.
+
+
|
+ +private | +
Prompts the user to create a GeneralConfiguration
+| cancellationToken | The CancellationToken for the operation |
Definition at line 310 of file SetupWizard.cs.
+ +References Tgstation.Server.Host.Configuration.GeneralConfiguration.MinimumPasswordLength.
+
+
|
+ +private | +
Prompts the user to create a FileLoggingConfiguration
+| cancellationToken | The CancellationToken for the operation |
Definition at line 362 of file SetupWizard.cs.
+
+
|
+ +private | +
Prompts the user to enter the port to host TGS on
+| cancellationToken | The CancellationToken for the operation |
Definition at line 106 of file SetupWizard.cs.
+
+
|
+ +private | +
A prompt for a yes or no value
+| question | The question string |
| cancellationToken | The CancellationToken for the operation |
Definition at line 85 of file SetupWizard.cs.
+
+
|
+ +private | +
Runs the SetupWizard
+| userConfigFileName | The path to the settings json to build |
| cancellationToken | The CancellationToken for the operation |
Definition at line 506 of file SetupWizard.cs.
+
+
|
+ +private | +
Saves a given Configuration set to userConfigFileName
+| userConfigFileName | The file to save the Configuration to |
| hostingPort | The hosting port to save |
| databaseConfiguration | The DatabaseConfiguration to save |
| newGeneralConfiguration | The GeneralConfiguration to save |
| fileLoggingConfiguration | The FileLoggingConfiguration to save |
| cancellationToken | The CancellationToken for the operation |
Definition at line 447 of file SetupWizard.cs.
+ +References Tgstation.Server.Host.Configuration.DatabaseConfiguration.Section, Tgstation.Server.Host.Configuration.GeneralConfiguration.Section, and Tgstation.Server.Host.Configuration.FileLoggingConfiguration.Section.
+
+
|
+ +private | +
The IApplication for the SetupWizard
+ +Definition at line 41 of file SetupWizard.cs.
+ +
+
|
+ +private | +
The IConsole for the SetupWizard
+ +Definition at line 31 of file SetupWizard.cs.
+ +
+
|
+ +private | +
The IDBConnectionFactory for the SetupWizard
+ +Definition at line 46 of file SetupWizard.cs.
+ +
+
|
+ +private | +
The GeneralConfiguration for the SetupWizard
+ +Definition at line 56 of file SetupWizard.cs.
+ +
+
|
+ +private | +
The IHostingEnvironment for the SetupWizard
+ +Definition at line 36 of file SetupWizard.cs.
+ +
+
|
+ +private | +
The IIOManager for the SetupWizard
+ +Definition at line 26 of file SetupWizard.cs.
+ +
+
|
+ +private | +
The ILogger for the SetupWizard
+ +Definition at line 51 of file SetupWizard.cs.
+ +
+ 1.8.11
+
+
+
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_setup_wizard.png b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_setup_wizard.png
new file mode 100644
index 0000000000..caf4c1605e
Binary files /dev/null and b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_setup_wizard.png differ
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application-members.html b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application-members.html
new file mode 100644
index 0000000000..10b021a4ff
--- /dev/null
+++ b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application-members.html
@@ -0,0 +1,111 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
This is the complete list of members for Tgstation.Server.Host.Core.Tests.TestApplication, including all inherited members.
+| TestConfigureServicesThrowsWhenSetupWizardConfigurationDemands() | Tgstation.Server.Host.Core.Tests.TestApplication | |
| TestMethodThrows() | Tgstation.Server.Host.Core.Tests.TestApplication |
+ 1.8.11
+
+
+
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application.html b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application.html
new file mode 100644
index 0000000000..942cdafb96
--- /dev/null
+++ b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application.html
@@ -0,0 +1,173 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
Tests for Application + More...
++Classes | |
| class | MockApplicationLifetime |
| class | MockSetupWizard |
+Public Member Functions | |
| void | TestMethodThrows () |
| void | TestConfigureServicesThrowsWhenSetupWizardConfigurationDemands () |
Tests for Application
+ +Definition at line 21 of file TestApplication.cs.
+| void Tgstation.Server.Host.Core.Tests.TestApplication.TestConfigureServicesThrowsWhenSetupWizardConfigurationDemands | +( | +) | ++ |
Definition at line 61 of file TestApplication.cs.
+| void Tgstation.Server.Host.Core.Tests.TestApplication.TestMethodThrows | +( | +) | ++ |
Definition at line 24 of file TestApplication.cs.
+
+ 1.8.11
+
+
+
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application_1_1_mock_application_lifetime-members.html b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application_1_1_mock_application_lifetime-members.html
new file mode 100644
index 0000000000..0f29956bc8
--- /dev/null
+++ b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application_1_1_mock_application_lifetime-members.html
@@ -0,0 +1,113 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
This is the complete list of members for Tgstation.Server.Host.Core.Tests.TestApplication.MockApplicationLifetime, including all inherited members.
+
+ 1.8.11
+
+
+
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application_1_1_mock_application_lifetime.html b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application_1_1_mock_application_lifetime.html
new file mode 100644
index 0000000000..50cd70ee39
--- /dev/null
+++ b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application_1_1_mock_application_lifetime.html
@@ -0,0 +1,201 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+
+ +Public Member Functions | |
| void | StopApplication () |
+Public Attributes | |
| CancellationToken | ApplicationStarted => default |
| CancellationToken | ApplicationStopping => default |
| CancellationToken | ApplicationStopped => default |
Definition at line 49 of file TestApplication.cs.
+| void Tgstation.Server.Host.Core.Tests.TestApplication.MockApplicationLifetime.StopApplication | +( | +) | ++ |
Definition at line 57 of file TestApplication.cs.
+ +| CancellationToken Tgstation.Server.Host.Core.Tests.TestApplication.MockApplicationLifetime.ApplicationStarted => default | +
Definition at line 51 of file TestApplication.cs.
+ +| CancellationToken Tgstation.Server.Host.Core.Tests.TestApplication.MockApplicationLifetime.ApplicationStopped => default | +
Definition at line 55 of file TestApplication.cs.
+ +| CancellationToken Tgstation.Server.Host.Core.Tests.TestApplication.MockApplicationLifetime.ApplicationStopping => default | +
Definition at line 53 of file TestApplication.cs.
+ +
+ 1.8.11
+
+
+
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application_1_1_mock_application_lifetime.png b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application_1_1_mock_application_lifetime.png
new file mode 100644
index 0000000000..a1a9f89d29
Binary files /dev/null and b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application_1_1_mock_application_lifetime.png differ
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application_1_1_mock_setup_wizard-members.html b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application_1_1_mock_setup_wizard-members.html
new file mode 100644
index 0000000000..e82e6ebcff
--- /dev/null
+++ b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application_1_1_mock_setup_wizard-members.html
@@ -0,0 +1,110 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
This is the complete list of members for Tgstation.Server.Host.Core.Tests.TestApplication.MockSetupWizard, including all inherited members.
+| CheckRunWizard(CancellationToken cancellationToken) | Tgstation.Server.Host.Core.Tests.TestApplication.MockSetupWizard |
+ 1.8.11
+
+
+
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application_1_1_mock_setup_wizard.html b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application_1_1_mock_setup_wizard.html
new file mode 100644
index 0000000000..a48cc1faa3
--- /dev/null
+++ b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application_1_1_mock_setup_wizard.html
@@ -0,0 +1,159 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+
+ +Public Member Functions | |
| Task< bool > | CheckRunWizard (CancellationToken cancellationToken) |
| Run the setup wizard if necessary More... | |
Definition at line 44 of file TestApplication.cs.
+| Task<bool> Tgstation.Server.Host.Core.Tests.TestApplication.MockSetupWizard.CheckRunWizard | +( | +CancellationToken | +cancellationToken | ) | ++ |
Run the setup wizard if necessary
+| cancellationToken |
Implements Tgstation.Server.Host.Core.ISetupWizard.
+ +
+ 1.8.11
+
+
+
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application_1_1_mock_setup_wizard.png b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application_1_1_mock_setup_wizard.png
new file mode 100644
index 0000000000..d0a42203b2
Binary files /dev/null and b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_application_1_1_mock_setup_wizard.png differ
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_d_b_connection_factory-members.html b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_d_b_connection_factory-members.html
new file mode 100644
index 0000000000..afce287295
--- /dev/null
+++ b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_d_b_connection_factory-members.html
@@ -0,0 +1,111 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
This is the complete list of members for Tgstation.Server.Host.Core.Tests.TestDBConnectionFactory, including all inherited members.
+| TestBadParameters() | Tgstation.Server.Host.Core.Tests.TestDBConnectionFactory | |
| TestWorks() | Tgstation.Server.Host.Core.Tests.TestDBConnectionFactory |
+ 1.8.11
+
+
+
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_d_b_connection_factory.html b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_d_b_connection_factory.html
new file mode 100644
index 0000000000..468a5fb8e4
--- /dev/null
+++ b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_d_b_connection_factory.html
@@ -0,0 +1,160 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+Public Member Functions | |
| void | TestBadParameters () |
| void | TestWorks () |
Definition at line 10 of file TestDBConnectionFactory.cs.
+| void Tgstation.Server.Host.Core.Tests.TestDBConnectionFactory.TestBadParameters | +( | +) | ++ |
Definition at line 13 of file TestDBConnectionFactory.cs.
+| void Tgstation.Server.Host.Core.Tests.TestDBConnectionFactory.TestWorks | +( | +) | ++ |
Definition at line 21 of file TestDBConnectionFactory.cs.
+
+ 1.8.11
+
+
+
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_setup_wizard-members.html b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_setup_wizard-members.html
new file mode 100644
index 0000000000..6c1f8f6365
--- /dev/null
+++ b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_setup_wizard-members.html
@@ -0,0 +1,111 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
This is the complete list of members for Tgstation.Server.Host.Core.Tests.TestSetupWizard, including all inherited members.
+| TestConstructionThrows() | Tgstation.Server.Host.Core.Tests.TestSetupWizard | |
| TestWithUserStupiditiy() | Tgstation.Server.Host.Core.Tests.TestSetupWizard |
+ 1.8.11
+
+
+
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_setup_wizard.html b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_setup_wizard.html
new file mode 100644
index 0000000000..6d20b312cb
--- /dev/null
+++ b/class_tgstation_1_1_server_1_1_host_1_1_core_1_1_tests_1_1_test_setup_wizard.html
@@ -0,0 +1,162 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+Public Member Functions | |
| void | TestConstructionThrows () |
| async Task | TestWithUserStupiditiy () |
Definition at line 20 of file TestSetupWizard.cs.
+| void Tgstation.Server.Host.Core.Tests.TestSetupWizard.TestConstructionThrows | +( | +) | ++ |
Definition at line 23 of file TestSetupWizard.cs.
+| async Task Tgstation.Server.Host.Core.Tests.TestSetupWizard.TestWithUserStupiditiy | +( | +) | ++ |
Definition at line 41 of file TestSetupWizard.cs.
+
+ 1.8.11
+
+
+
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_console-members.html b/class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_console-members.html
new file mode 100644
index 0000000000..d8c8e6d3ae
--- /dev/null
+++ b/class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_console-members.html
@@ -0,0 +1,114 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
This is the complete list of members for Tgstation.Server.Host.IO.Console, including all inherited members.
+| Available | Tgstation.Server.Host.IO.Console | |
| CheckAvailable() | Tgstation.Server.Host.IO.Console | private |
| PressAnyKeyAsync(CancellationToken cancellationToken) | Tgstation.Server.Host.IO.Console | |
| ReadLineAsync(bool usePasswordChar, CancellationToken cancellationToken) | Tgstation.Server.Host.IO.Console | |
| WriteAsync(string text, bool newLine, CancellationToken cancellationToken) | Tgstation.Server.Host.IO.Console |
+ 1.8.11
+
+
+
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_console.html b/class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_console.html
new file mode 100644
index 0000000000..f6a25a5080
--- /dev/null
+++ b/class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_console.html
@@ -0,0 +1,289 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+ More...
+
+
+ +Public Member Functions | |
| Task | PressAnyKeyAsync (CancellationToken cancellationToken) |
| Wait for a key press on the IConsole More... | |
| Task< string > | ReadLineAsync (bool usePasswordChar, CancellationToken cancellationToken) |
| Read a line from the IConsole More... | |
| Task | WriteAsync (string text, bool newLine, CancellationToken cancellationToken) |
| Write some text to the IConsole More... | |
+Public Attributes | |
| bool | Available => Environment.UserInteractive |
+Private Member Functions | |
| void | CheckAvailable () |
+Additional Inherited Members | |
Properties inherited from Tgstation.Server.Host.IO.IConsole | |
| bool | Available [get] |
| If the IConsole is visible to the user More... | |
Definition at line 9 of file Console.cs.
+
+
|
+ +private | +
Definition at line 14 of file Console.cs.
+| Task Tgstation.Server.Host.IO.Console.PressAnyKeyAsync | +( | +CancellationToken | +cancellationToken | ) | ++ |
Wait for a key press on the IConsole
+ +Implements Tgstation.Server.Host.IO.IConsole.
+ +| Task<string> Tgstation.Server.Host.IO.Console.ReadLineAsync | +( | +bool | +usePasswordChar, | +
| + | + | CancellationToken | +cancellationToken | +
| + | ) | ++ |
Read a line from the IConsole
+ +Implements Tgstation.Server.Host.IO.IConsole.
+ +| Task Tgstation.Server.Host.IO.Console.WriteAsync | +( | +string | +text, | +
| + | + | bool | +newLine, | +
| + | + | CancellationToken | +cancellationToken | +
| + | ) | ++ |
Write some text to the IConsole
+ +Implements Tgstation.Server.Host.IO.IConsole.
+ +| bool Tgstation.Server.Host.IO.Console.Available => Environment.UserInteractive | +
Definition at line 12 of file Console.cs.
+ +
+ 1.8.11
+
+
+
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_console.png b/class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_console.png
new file mode 100644
index 0000000000..5901149f5f
Binary files /dev/null and b/class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_console.png differ
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_tests_1_1_test_console-members.html b/class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_tests_1_1_test_console-members.html
new file mode 100644
index 0000000000..4ea5b5ca6f
--- /dev/null
+++ b/class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_tests_1_1_test_console-members.html
@@ -0,0 +1,111 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
This is the complete list of members for Tgstation.Server.Host.IO.Tests.TestConsole, including all inherited members.
+| TestUserInteractive() | Tgstation.Server.Host.IO.Tests.TestConsole | |
| TestWriteLine() | Tgstation.Server.Host.IO.Tests.TestConsole |
+ 1.8.11
+
+
+
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_tests_1_1_test_console.html b/class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_tests_1_1_test_console.html
new file mode 100644
index 0000000000..b71f5c10d4
--- /dev/null
+++ b/class_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_tests_1_1_test_console.html
@@ -0,0 +1,158 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
+Public Member Functions | |
| async Task | TestWriteLine () |
| void | TestUserInteractive () |
Definition at line 10 of file TestConsole.cs.
+| void Tgstation.Server.Host.IO.Tests.TestConsole.TestUserInteractive | +( | +) | ++ |
Definition at line 29 of file TestConsole.cs.
+ +| async Task Tgstation.Server.Host.IO.Tests.TestConsole.TestWriteLine | +( | +) | ++ |
Definition at line 13 of file TestConsole.cs.
+ +
+ 1.8.11
+
+
+
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_database_context.html b/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_database_context.html
index e8b7d3594a..d8247b9161 100644
--- a/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_database_context.html
+++ b/class_tgstation_1_1_server_1_1_host_1_1_models_1_1_database_context.html
@@ -279,7 +279,7 @@ Private Attributes
Definition at line 86 of file DatabaseContext.cs.
-Definition at line 137 of file DatabaseContext.cs.
Definition at line 24 of file DesignTimeDbContextFactoryHelpers.cs.
-References Tgstation.Server.Host.Configuration.DatabaseConfiguration.Section.
-References Tgstation.Server.Host.Configuration.DatabaseConfiguration.Section.
+Definition at line 26 of file MySqlDatabaseContext.cs.
-References Tgstation.Server.Host.Configuration.DatabaseConfiguration.ConnectionString, Tgstation.Server.Host.Configuration.DatabaseConfiguration.DatabaseType, and Tgstation.Server.Host.Configuration.DatabaseConfiguration.MySqlServerVersion.
-References Tgstation.Server.Host.Configuration.DatabaseConfiguration.ConnectionString, Tgstation.Server.Host.Configuration.DatabaseConfiguration.DatabaseType, and Tgstation.Server.Host.Configuration.DatabaseConfiguration.MySqlServerVersion.
+Definition at line 24 of file SqlServerDatabaseContext.cs.
-References Tgstation.Server.Host.Configuration.DatabaseConfiguration.ConnectionString.
-References Tgstation.Server.Host.Configuration.DatabaseConfiguration.ConnectionString.
+Definition at line 15 of file CryptographySuite.cs.
+ +Referenced by Tgstation.Server.Host.Security.TokenFactory.TokenFactory().
This is the complete list of members for Tgstation.Server.Host.Security.TokenFactory, including all inherited members.
Public Member Functions | |
| TokenFactory () | |
| Construct a TokenFactory More... | |
| Token | CreateToken (Models.User user) |
| Create a Token for a given user More... | |
-Static Public Attributes | |
| static readonly string | TokenAudience = typeof(Token).Assembly.GetName().Name |
| static readonly string | TokenIssuer = Assembly.GetExecutingAssembly().GetName().Name |
| static readonly byte[] | TokenSigningKey = CryptographySuite.GetSecureBytes(256) |
+Properties | |
| TokenValidationParameters | ValidationParameters [get] |
Properties inherited from Tgstation.Server.Host.Security.ITokenFactory | |
| TokenValidationParameters | ValidationParameters [get] |
| The TokenValidationParameters for the ITokenFactory More... | |
Private Attributes | |||||||||||||
| Tgstation.Server.Host.Security.TokenFactory.TokenFactory | +( | +) | ++ |
Construct a TokenFactory
+ +Definition at line 25 of file TokenFactory.cs.
+ +References Tgstation.Server.Host.Security.CryptographySuite.GetSecureBytes().
+Implements Tgstation.Server.Host.Security.ITokenFactory.
-Definition at line 24 of file TokenFactory.cs.
-Definition at line 48 of file TokenFactory.cs.
+
-
|
- -static | -
Definition at line 19 of file TokenFactory.cs.
- -Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices().
- -
|
-static | +get
Definition at line 20 of file TokenFactory.cs.
-Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices().
- -
-
|
- -static | -
Definition at line 21 of file TokenFactory.cs.
- -Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices().
-Implements Tgstation.Server.Host.IServer.
Definition at line 70 of file Server.cs.
-Implements Tgstation.Server.Host.IServerFactory.
-Referenced by Tgstation.Server.Tests.TestingServer.TestingServer().
+Referenced by Tgstation.Server.Tests.TestingServer.TestingServer().
This is the complete list of members for Tgstation.Server.Host.Service.Program, including all inherited members.
Public Member Functions | |
| void | OnExecute () |
| Command line handler, always runs More... | |
| async Task | OnExecuteAsync () |
| Command line handler, always runs More... | |
Properties | |
| bool | Install [get, set] |
| The –install or -i option More... | |
| bool | Configure [get, set] |
| The –configure or -c option More... | |
| bool | Trace [get, set] |
| The –trace or -t option. Enables trace logs More... | |
| static bool | IsAdministrator () |
| Check if the running user is a system administrator More... | |
| static int | Main (string[] args) |
| Entrypoint for the application More... | |
| static Task< int > | Main (string[] args) |
| Entrypoint for the application More... | |
+Static Private Attributes | |
| static readonly IWatchdogFactory | watchdogFactory = new WatchdogFactory() |
Contains the entrypoint for the application
-Definition at line 20 of file Program.cs.
+Definition at line 21 of file Program.cs.
Check if the running user is a system administrator
Definition at line 50 of file Program.cs.
-Definition at line 59 of file Program.cs.
+
+
+
Definition at line 53 of file Program.cs. +Property Documentation+ +
+
+
+
+
+The –configure or -c option + +Definition at line 39 of file Program.cs. + +
@@ -242,7 +301,7 @@ Static Private Member Functions
The –debug or -d option. Enables debug logs -Definition at line 44 of file Program.cs. +Definition at line 51 of file Program.cs. The –install or -i option -Definition at line 32 of file Program.cs. +Definition at line 33 of file Program.cs. @@ -290,7 +349,7 @@ Static Private Member FunctionsThe –trace or -t option. Enables trace logs -Definition at line 38 of file Program.cs. +Definition at line 45 of file Program.cs. @@ -314,7 +373,7 @@ Static Private Member FunctionsThe –uninstall or -u option -Definition at line 26 of file Program.cs. +Definition at line 27 of file Program.cs. diff --git a/class_tgstation_1_1_server_1_1_host_1_1_service_1_1_server_service-members.html b/class_tgstation_1_1_server_1_1_host_1_1_service_1_1_server_service-members.html index 32594333df..61c61e8179 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_service_1_1_server_service-members.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_service_1_1_server_service-members.html @@ -104,10 +104,11 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');Name | Tgstation.Server.Host.Service.ServerService | OnStart(string[] args) | Tgstation.Server.Host.Service.ServerService | protected | OnStop() | Tgstation.Server.Host.Service.ServerService | protected | ServerService(IWatchdogFactory watchdogFactory, ILoggerFactory loggerFactory, LogLevel minumumLogLevel) | Tgstation.Server.Host.Service.ServerService | watchdog | Tgstation.Server.Host.Service.ServerService | private | watchdogTask | Tgstation.Server.Host.Service.ServerService | private | WriteEntry(string message, EventLogEntryType type, int eventID, short category) | Tgstation.Server.Host.Service.ServerService | RunWatchdog(string[] args, CancellationToken cancellationToken) | Tgstation.Server.Host.Service.ServerService | private | ServerService(IWatchdogFactory watchdogFactory, ILoggerFactory loggerFactory, LogLevel minumumLogLevel) | Tgstation.Server.Host.Service.ServerService | watchdog | Tgstation.Server.Host.Service.ServerService | private | watchdogTask | Tgstation.Server.Host.Service.ServerService | private | WriteEntry(string message, EventLogEntryType type, int eventID, short category) | Tgstation.Server.Host.Service.ServerService | diff --git a/class_tgstation_1_1_server_1_1_host_1_1_service_1_1_server_service.html b/class_tgstation_1_1_server_1_1_host_1_1_service_1_1_server_service.html index b60f69cefe..9e4782a072 100644 --- a/class_tgstation_1_1_server_1_1_host_1_1_service_1_1_server_service.html +++ b/class_tgstation_1_1_server_1_1_host_1_1_service_1_1_server_service.html @@ -95,6 +95,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); Public Member Functions | Public Attributes | Protected Member Functions | +Private Member Functions | Private Attributes | List of all members
@@ -140,13 +141,19 @@ Protected Member Functions
override void | OnStop () | |
+
+
Executes the watchdog, stopping the service if it exits +
Definition at line 75 of file ServerService.cs. + 88 EventLog.WriteEntry(String.Format(CultureInfo.InvariantCulture, "Error stopping service! Exception: {0}", e));
+Task RunAsync(bool runConfigure, string[] args, CancellationToken cancellationToken) Run the IWatchdog CancellationTokenSource cancellationTokenSource The cancellationTokenSource for the ServerService Definition: ServerService.cs:38 The cancellationTokenSource for the ServerService -Definition at line 37 of file ServerService.cs. +Definition at line 38 of file ServerService.cs. @@ -376,7 +432,7 @@ Private Attributes -Definition at line 63 of file ServerService.cs. +Definition at line 64 of file ServerService.cs. @@ -392,9 +448,9 @@ Private AttributesThe canonical windows service name -Definition at line 22 of file ServerService.cs. +Definition at line 23 of file ServerService.cs. -Referenced by Tgstation.Server.Host.Service.Program.OnExecute(). +Referenced by Tgstation.Server.Host.Service.Program.OnExecuteAsync(). @@ -418,7 +474,7 @@ Private AttributesThe IWatchdog for the ServerService -Definition at line 27 of file ServerService.cs. +Definition at line 28 of file ServerService.cs. @@ -440,9 +496,9 @@ Private Attributes
-
diff --git a/class_tgstation_1_1_server_1_1_host_1_1_service_1_1_tests_1_1_test_server_service.html b/class_tgstation_1_1_server_1_1_host_1_1_service_1_1_tests_1_1_test_server_service.html
index 8c598508bf..c0e4ab6b6d 100644
--- a/class_tgstation_1_1_server_1_1_host_1_1_service_1_1_tests_1_1_test_server_service.html
+++ b/class_tgstation_1_1_server_1_1_host_1_1_service_1_1_tests_1_1_test_server_service.html
@@ -129,7 +129,7 @@ Public Member FunctionsThe Task recieved from IWatchdog.RunAsync(string[], CancellationToken) of watchdog +The Task recieved from IWatchdog.RunAsync(bool, string[], CancellationToken) of watchdog -Definition at line 32 of file ServerService.cs. +Definition at line 33 of file ServerService.cs. |
| logger | Tgstation.Server.Host.Watchdog.Watchdog | private |
| RunAsync(string[] args, CancellationToken cancellationToken) | Tgstation.Server.Host.Watchdog.Watchdog | |
| RunAsync(bool runConfigure, string[] args, CancellationToken cancellationToken) | Tgstation.Server.Host.Watchdog.Watchdog | |
| Watchdog(ILogger< Watchdog > logger) | Tgstation.Server.Host.Watchdog.Watchdog |
Private Attributes | |||
| async Task Tgstation.Server.Host.Watchdog.Watchdog.RunAsync | ( | +bool | +runConfigure, | +
| + | string[] | args, |
Definition at line 12 of file TestingServer.cs.
+Definition at line 13 of file TestingServer.cs.
Definition at line 21 of file TestingServer.cs.
+Definition at line 22 of file TestingServer.cs.
References Tgstation.Server.Host.ServerFactory.CreateServer().
-Definition at line 54 of file TestingServer.cs.
-Definition at line 56 of file TestingServer.cs.
+Definition at line 19 of file TestingServer.cs.
+Definition at line 20 of file TestingServer.cs.
Definition at line 17 of file TestingServer.cs.
+Definition at line 18 of file TestingServer.cs.
Definition at line 16 of file TestingServer.cs.
+Definition at line 17 of file TestingServer.cs.
Definition at line 14 of file TestingServer.cs.
+Definition at line 15 of file TestingServer.cs.
Directories | |
| directory | netcoreapp2.1 |
| directory | netcoreapp2.1 |
Directories | |
| directory | netcoreapp2.1 |
| directory | netcoreapp2.1 |
Directories | |
| directory | Release |
| directory | Debug |
Files | |
| file | TestApplication.cs [code] |
| file | TestDatabaseContextFactory.cs [code] |
| file | TestDBConnectionFactory.cs [code] |
| file | TestGitHubClientFactory.cs [code] |
| file | TestJobException.cs [code] |
| file | TestSetupWizard.cs [code] |
Directories | |
| directory | Release |
| directory | Debug |
Directories | |
| directory | netcoreapp2.1 |
| directory | netcoreapp2.1 |
Directories | |
| directory | netstandard2.0 |
| directory | netstandard2.0 |
Directories | |
| directory | Release |
| directory | Debug |
Directories | |
| directory | netstandard2.0 |
| directory | netstandard2.0 |
Directories | |
| directory | Release |
| directory | Debug |
Directories | |
| directory | Release |
| directory | Debug |
Directories | |
| directory | Release |
| directory | Debug |
Directories | |
| directory | netcoreapp2.1 |
| directory | netcoreapp2.1 |
Directories | |
| directory | Release |
| directory | Debug |
Files | |
| file | Console.cs [code] |
| file | DefaultIOManager.cs [code] |
| file | IConsole.cs [code] |
| file | IIOManager.cs [code] |
| file | IPostWriteHandler.cs [code] |
Directories | |
| directory | Release |
| directory | Debug |
Directories | |
| directory | netcoreapp2.1 |
| directory | netcoreapp2.1 |
Directories | |
| directory | netcoreapp2.1 |
| directory | netcoreapp2.1 |
Files | |
| file | TestConsole.cs [code] |
| file | TestSymlinkFactory.cs [code] |
Directories | |
| directory | Release |
| directory | Debug |
Directories | |
| directory | netcoreapp2.1 |
| directory | netcoreapp2.1 |
Directories | |
| directory | netstandard2.0 |
| directory | netstandard2.0 |
Directories | |
| directory | Release |
| directory | Debug |
Directories | |
| directory | netcoreapp2.1 |
| directory | netcoreapp2.1 |
Directories | |
| directory | Release |
| directory | Debug |
Note that tgstation-server has only ever been tested on Linux via it's docker environment. If you are having trouble with something, or figure out a required workaround, please contact project maintainers so this documentation may be better updated.
tgstation-server supports running in a docker container and is the recommended deployment method for Linux systems due being the only robustly tested environment. The official image repository is located at https://hub.docker.com/r/tgstation/server. It can also be built locally by running docker build . -f build/Dockerfile in the repository root.
To create a container run
with any additional options you desire (i.e. You'll have to expose more game ports in order to host more than one instance).
+To create a container run
with any additional options you desire (i.e. You'll have to expose more game ports in order to host more than one instance).
Note although /app/lib is specified as a volume mount point in the Dockerfile, unless you REALLY know what you're doing. Do not mount any volumes over this for fear of breaking your container.
Before starting your container make sure the aforemention appsettings.Production.json is configured properly. See below
If using manual configuration, before starting your container make sure the aforemention appsettings.Production.json is setup properly. See below
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
+
+This wizard will, generally, run whenever the server is launched without detecting the config json. Follow the instructions below to perform this process manually.
+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:
General:MinimumPasswordLength: Minimum password length requirement for database usersDefinition at line 21 of file IServerClient.cs.
+Referenced by Tgstation.Server.Tests.IntegrationTest.FullMonty().
+ diff --git a/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_d_b_connection_factory-members.html b/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_d_b_connection_factory-members.html new file mode 100644 index 0000000000..17e5876ba9 --- /dev/null +++ b/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_d_b_connection_factory-members.html @@ -0,0 +1,110 @@ + + + + + + +|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
This is the complete list of members for Tgstation.Server.Host.Core.IDBConnectionFactory, including all inherited members.
+| CreateConnection(string connectionString, DatabaseType databaseType) | Tgstation.Server.Host.Core.IDBConnectionFactory |
+ 1.8.11
+
+
+
diff --git a/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_d_b_connection_factory.html b/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_d_b_connection_factory.html
new file mode 100644
index 0000000000..70b346a097
--- /dev/null
+++ b/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_d_b_connection_factory.html
@@ -0,0 +1,174 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
For creating DbConnection + More...
+
+
+ +Public Member Functions | |
| DbConnection | CreateConnection (string connectionString, DatabaseType databaseType) |
| Create a DbConnection More... | |
For creating DbConnection
+ +Definition at line 9 of file IDBConnectionFactory.cs.
+| DbConnection Tgstation.Server.Host.Core.IDBConnectionFactory.CreateConnection | +( | +string | +connectionString, | +
| + | + | DatabaseType | +databaseType | +
| + | ) | ++ |
Create a DbConnection
+| connectionString | The DbConnection.ConnectionString |
| databaseType | The DatabaseType to create |
Implemented in Tgstation.Server.Host.Core.DBConnectionFactory.
+ +
+ 1.8.11
+
+
+
diff --git a/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_d_b_connection_factory.png b/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_d_b_connection_factory.png
new file mode 100644
index 0000000000..75f5ebabc2
Binary files /dev/null and b/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_d_b_connection_factory.png differ
diff --git a/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_server_control.html b/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_server_control.html
index 95870d69f5..26f7366bed 100644
--- a/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_server_control.html
+++ b/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_server_control.html
@@ -227,7 +227,7 @@ Public Member Functions
Implemented in Tgstation.Server.Host.Server.
-Referenced by Tgstation.Server.Host.Core.Application.Configure().
+Referenced by Tgstation.Server.Host.Core.Application.Configure().
diff --git a/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_setup_wizard-members.html b/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_setup_wizard-members.html new file mode 100644 index 0000000000..116f573933 --- /dev/null +++ b/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_setup_wizard-members.html @@ -0,0 +1,110 @@ + + + + + + +|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
This is the complete list of members for Tgstation.Server.Host.Core.ISetupWizard, including all inherited members.
+| CheckRunWizard(CancellationToken cancellationToken) | Tgstation.Server.Host.Core.ISetupWizard |
+ 1.8.11
+
+
+
diff --git a/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_setup_wizard.html b/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_setup_wizard.html
new file mode 100644
index 0000000000..8fa7a06736
--- /dev/null
+++ b/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_setup_wizard.html
@@ -0,0 +1,166 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
The command line Configuration setup wizard + More...
+
+
+ +Public Member Functions | |
| Task< bool > | CheckRunWizard (CancellationToken cancellationToken) |
| Run the setup wizard if necessary More... | |
The command line Configuration setup wizard
+ +Definition at line 9 of file ISetupWizard.cs.
+| Task<bool> Tgstation.Server.Host.Core.ISetupWizard.CheckRunWizard | +( | +CancellationToken | +cancellationToken | ) | ++ |
Run the setup wizard if necessary
+| cancellationToken |
Implemented in Tgstation.Server.Host.Core.SetupWizard, and Tgstation.Server.Host.Core.Tests.TestApplication.MockSetupWizard.
+ +Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices().
+ +
+ 1.8.11
+
+
+
diff --git a/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_setup_wizard.png b/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_setup_wizard.png
new file mode 100644
index 0000000000..341ee71511
Binary files /dev/null and b/interface_tgstation_1_1_server_1_1_host_1_1_core_1_1_i_setup_wizard.png differ
diff --git a/interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console-members.html b/interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console-members.html
new file mode 100644
index 0000000000..0fedf07dfb
--- /dev/null
+++ b/interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console-members.html
@@ -0,0 +1,113 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
This is the complete list of members for Tgstation.Server.Host.IO.IConsole, including all inherited members.
+| Available | Tgstation.Server.Host.IO.IConsole | |
| PressAnyKeyAsync(CancellationToken cancellationToken) | Tgstation.Server.Host.IO.IConsole | |
| ReadLineAsync(bool usePasswordChar, CancellationToken cancellationToken) | Tgstation.Server.Host.IO.IConsole | |
| WriteAsync(string text, bool newLine, CancellationToken cancellationToken) | Tgstation.Server.Host.IO.IConsole |
+ 1.8.11
+
+
+
diff --git a/interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html b/interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html
new file mode 100644
index 0000000000..fa3a3e7386
--- /dev/null
+++ b/interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.html
@@ -0,0 +1,284 @@
+
+
+
+
+
+
+|
+ tgstation-server
+
+ The /tg/station 13 server suite
+ |
+
Abstraction for System.Console + More...
+
+
+ +Public Member Functions | |
| Task | WriteAsync (string text, bool newLine, CancellationToken cancellationToken) |
| Write some text to the IConsole More... | |
| Task | PressAnyKeyAsync (CancellationToken cancellationToken) |
| Wait for a key press on the IConsole More... | |
| Task< string > | ReadLineAsync (bool usePasswordChar, CancellationToken cancellationToken) |
| Read a line from the IConsole More... | |
+Properties | |
| bool | Available [get] |
| If the IConsole is visible to the user More... | |
Abstraction for System.Console
+ +Definition at line 9 of file IConsole.cs.
+| Task Tgstation.Server.Host.IO.IConsole.PressAnyKeyAsync | +( | +CancellationToken | +cancellationToken | ) | ++ |
Wait for a key press on the IConsole
+| cancellationToken | The CancellationToken for the operations |
Implemented in Tgstation.Server.Host.IO.Console.
+ +| Task<string> Tgstation.Server.Host.IO.IConsole.ReadLineAsync | +( | +bool | +usePasswordChar, | +
| + | + | CancellationToken | +cancellationToken | +
| + | ) | ++ |
Read a line from the IConsole
+| usePasswordChar | If the input should be retrieved using the '*' character |
| cancellationToken | The CancellationToken for the operation |
Implemented in Tgstation.Server.Host.IO.Console.
+ +| Task Tgstation.Server.Host.IO.IConsole.WriteAsync | +( | +string | +text, | +
| + | + | bool | +newLine, | +
| + | + | CancellationToken | +cancellationToken | +
| + | ) | ++ |
Write some text to the IConsole
+| text | The string to write |
| newLine | If there should be a new line after the text |
| cancellationToken | The CancellationToken for the operation |
Implemented in Tgstation.Server.Host.IO.Console.
+ +
+
|
+ +get | +
If the IConsole is visible to the user
+ +Definition at line 14 of file IConsole.cs.
+ +
+ 1.8.11
+
+
+
diff --git a/interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.png b/interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.png
new file mode 100644
index 0000000000..6d5733769c
Binary files /dev/null and b/interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_console.png differ
diff --git a/interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_i_o_manager.html b/interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_i_o_manager.html
index ec68c5653e..c4316b31da 100644
--- a/interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_i_o_manager.html
+++ b/interface_tgstation_1_1_server_1_1_host_1_1_i_o_1_1_i_i_o_manager.html
@@ -211,6 +211,8 @@ Public Member Functions
Implemented in Tgstation.Server.Host.IO.DefaultIOManager.
+Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices().
+ diff --git a/interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_token_factory-members.html b/interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_token_factory-members.html index 59803c5bac..41602eb35e 100644 --- a/interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_token_factory-members.html +++ b/interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_token_factory-members.html @@ -99,6 +99,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');This is the complete list of members for Tgstation.Server.Host.Security.ITokenFactory, including all inherited members.
| CreateToken(Models.User user) | Tgstation.Server.Host.Security.ITokenFactory | |
| ValidationParameters | Tgstation.Server.Host.Security.ITokenFactory |
+Properties | |
| TokenValidationParameters | ValidationParameters [get] |
| The TokenValidationParameters for the ITokenFactory More... | |
For creating Tokens
@@ -147,6 +154,33 @@ Public Member FunctionsImplemented in Tgstation.Server.Host.Security.TokenFactory.
+
+
|
+ +get | +
The TokenValidationParameters for the ITokenFactory
+ +Definition at line 14 of file ITokenFactory.cs.
+ +Referenced by Tgstation.Server.Host.Core.Application.ConfigureServices().
+This is the complete list of members for Tgstation.Server.Host.Watchdog.IWatchdog, including all inherited members.
| RunAsync(string[] args, CancellationToken cancellationToken) | Tgstation.Server.Host.Watchdog.IWatchdog | |
| RunAsync(bool runConfigure, string[] args, CancellationToken cancellationToken) | Tgstation.Server.Host.Watchdog.IWatchdog |
Public Member Functions | |
| Task | RunAsync (string[] args, CancellationToken cancellationToken) |
| Run the IWatchdog More... | |
| Task | RunAsync (bool runConfigure, string[] args, CancellationToken cancellationToken) |
| Run the IWatchdog More... | |
The watchdog for a Host
Definition at line 9 of file IWatchdog.cs.
| Task Tgstation.Server.Host.Watchdog.IWatchdog.RunAsync | ( | +bool | +runConfigure, | +
| + | string[] | args, | |
| runConfigure | If the IWatchdog should just run the host configuration wizard and exit |
| args | The arguments for the IWatchdog |
| cancellationToken | The CancellationToken for the operation |
Implemented in Tgstation.Server.Host.Watchdog.Watchdog.
+Implemented in Tgstation.Server.Host.Watchdog.Watchdog.
diff --git a/interface_tgstation_1_1_server_1_1_host_1_1_watchdog_1_1_i_watchdog_factory.html b/interface_tgstation_1_1_server_1_1_host_1_1_watchdog_1_1_i_watchdog_factory.html index f67b7db9ef..717e7118d4 100644 --- a/interface_tgstation_1_1_server_1_1_host_1_1_watchdog_1_1_i_watchdog_factory.html +++ b/interface_tgstation_1_1_server_1_1_host_1_1_watchdog_1_1_i_watchdog_factory.html @@ -147,7 +147,7 @@ Public Member FunctionsImplemented in Tgstation.Server.Host.Watchdog.WatchdogFactory.
-Referenced by Tgstation.Server.Host.Service.ServerService.ServerService().
+Referenced by Tgstation.Server.Host.Service.ServerService.ServerService().
diff --git a/namespace_tgstation_1_1_server_1_1_host_1_1_configuration.html b/namespace_tgstation_1_1_server_1_1_host_1_1_configuration.html index 994547911c..1ea2bf48d4 100644 --- a/namespace_tgstation_1_1_server_1_1_host_1_1_configuration.html +++ b/namespace_tgstation_1_1_server_1_1_host_1_1_configuration.html @@ -120,6 +120,13 @@ Enumerations }
+
|
+ +strong | +
Determines if the Core.ISetupWizard will run
+| Enumerator | |
|---|---|
| Autodetect |
+ Run the wizard if the appsettings.{Environment}.json is not present or empty + |
| Force |
+ Force run the wizard + |
| Only |
+ Only run the wizard and exit + |
| Never |
+ Never run the wizard + |
Definition at line 6 of file SetupWizardMode.cs.
+Classes | |
| class | TestApplication |
| Tests for Application More... | |
| class | TestDatabaseContextFactory |
| class | TestDBConnectionFactory |
| class | TestGitHubClientFactory |
| class | TestJobException |
| class | TestSetupWizard |
Classes | |
| class | Console |
| class | DefaultIOManager |
| IIOManager that resolves paths to Environment.CurrentDirectory More... | |
| interface | IConsole |
| Abstraction for System.Console More... | |
| interface | IIOManager |
| Interface for using filesystems More... | |
Classes | |
| class | TestConsole |
| class | TestSymlinkFactory |