|
tgstation-server 6.8.0
The /tg/station 13 server suite
|
Go to the source code of this file.
Classes | |
| class | Tgstation.Server.Host.Setup.SetupWizard |
Namespaces | |
| namespace | Tgstation |
| namespace | Tgstation.Server |
| namespace | Tgstation.Server.Host |
| namespace | Tgstation.Server.Host.Setup |
Functions | |
| Tgstation.Server.Host.Setup.while (true) | |
| async ValueTask< GeneralConfiguration > | ConfigureGeneral (CancellationToken cancellationToken) |
| Prompts the user to create a GeneralConfiguration. More... | |
| async ValueTask< FileLoggingConfiguration > | ConfigureLogging (CancellationToken cancellationToken) |
| Prompts the user to create a FileLoggingConfiguration. More... | |
| async ValueTask< ElasticsearchConfiguration > | ConfigureElasticsearch (CancellationToken cancellationToken) |
| Prompts the user to create a ElasticsearchConfiguration. More... | |
| async ValueTask< ControlPanelConfiguration > | ConfigureControlPanel (CancellationToken cancellationToken) |
| Prompts the user to create a ControlPanelConfiguration. More... | |
| async ValueTask< SwarmConfiguration?> | ConfigureSwarm (CancellationToken cancellationToken) |
| Prompts the user to create a SwarmConfiguration. More... | |
| async ValueTask | SaveConfiguration (string userConfigFileName, ushort? hostingPort, DatabaseConfiguration databaseConfiguration, GeneralConfiguration newGeneralConfiguration, FileLoggingConfiguration? fileLoggingConfiguration, ElasticsearchConfiguration? elasticsearchConfiguration, ControlPanelConfiguration controlPanelConfiguration, SwarmConfiguration? swarmConfiguration, CancellationToken cancellationToken) |
| Saves a given Configuration set to userConfigFileName . More... | |
| async ValueTask | RunWizard (string userConfigFileName, CancellationToken cancellationToken) |
| Runs the SetupWizard. More... | |
| async ValueTask | CheckRunWizard (CancellationToken cancellationToken) |
| Check if it should and run the SetupWizard if necessary. More... | |
| async ValueTask CheckRunWizard | ( | CancellationToken | cancellationToken | ) |
Check if it should and run the SetupWizard if necessary.
| cancellationToken | The CancellationToken for the operation. |
Definition at line 1078 of file SetupWizard.cs.
References Tgstation.Server.Host.Configuration.DatabaseConfiguration.ConnectionString, Tgstation.Server.Host.Properties.MasterVersionsAttribute.Instance, Tgstation.Server.Host.Properties.MasterVersionsAttribute.RawMariaDBRedistVersion, RunWizard(), and SaveConfiguration().
Referenced by Tgstation.Server.Host.Setup.SetupWizard.ExecuteAsync().


| async ValueTask< ControlPanelConfiguration > ConfigureControlPanel | ( | CancellationToken | cancellationToken | ) |
Prompts the user to create a ControlPanelConfiguration.
| cancellationToken | The CancellationToken for the operation. |
Definition at line 861 of file SetupWizard.cs.
Referenced by RunWizard().

| async ValueTask< ElasticsearchConfiguration > ConfigureElasticsearch | ( | CancellationToken | cancellationToken | ) |
Prompts the user to create a ElasticsearchConfiguration.
| cancellationToken | The CancellationToken for the operation. |
Definition at line 809 of file SetupWizard.cs.
Referenced by RunWizard().

| async ValueTask< GeneralConfiguration > ConfigureGeneral | ( | CancellationToken | cancellationToken | ) |
Prompts the user to create a GeneralConfiguration.
| cancellationToken | The CancellationToken for the operation. |
Definition at line 666 of file SetupWizard.cs.
Referenced by RunWizard().

| async ValueTask< FileLoggingConfiguration > ConfigureLogging | ( | CancellationToken | cancellationToken | ) |
Prompts the user to create a FileLoggingConfiguration.
| cancellationToken | The CancellationToken for the operation. |
Definition at line 724 of file SetupWizard.cs.
Referenced by RunWizard().

| async ValueTask< SwarmConfiguration?> ConfigureSwarm | ( | CancellationToken | cancellationToken | ) |
Prompts the user to create a SwarmConfiguration.
| cancellationToken | The CancellationToken for the operation. |
Definition at line 891 of file SetupWizard.cs.
Referenced by RunWizard().

| async ValueTask RunWizard | ( | string | userConfigFileName, |
| CancellationToken | cancellationToken | ||
| ) |
Runs the SetupWizard.
| userConfigFileName | The path to the settings json to build. |
| cancellationToken | The CancellationToken for the operation. |
Definition at line 1038 of file SetupWizard.cs.
References ConfigureControlPanel(), ConfigureElasticsearch(), ConfigureGeneral(), ConfigureLogging(), ConfigureSwarm(), and SaveConfiguration().
Referenced by CheckRunWizard().


| async ValueTask SaveConfiguration | ( | string | userConfigFileName, |
| ushort? | hostingPort, | ||
| DatabaseConfiguration | databaseConfiguration, | ||
| GeneralConfiguration | newGeneralConfiguration, | ||
| FileLoggingConfiguration? | fileLoggingConfiguration, | ||
| ElasticsearchConfiguration? | elasticsearchConfiguration, | ||
| ControlPanelConfiguration | controlPanelConfiguration, | ||
| SwarmConfiguration? | swarmConfiguration, | ||
| CancellationToken | cancellationToken | ||
| ) |
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. |
| elasticsearchConfiguration | The ElasticsearchConfiguration to save. |
| controlPanelConfiguration | The ControlPanelConfiguration to save. |
| swarmConfiguration | The SwarmConfiguration to save. |
| cancellationToken | The CancellationToken for the operation. |
Definition at line 966 of file SetupWizard.cs.
References Tgstation.Server.Host.Configuration.GeneralConfiguration.CurrentConfigVersion, Tgstation.Server.Host.Configuration.GeneralConfiguration.DefaultApiPort, Tgstation.Server.Host.Configuration.ControlPanelConfiguration.Section, Tgstation.Server.Host.Configuration.DatabaseConfiguration.Section, Tgstation.Server.Host.Configuration.ElasticsearchConfiguration.Section, Tgstation.Server.Host.Configuration.FileLoggingConfiguration.Section, Tgstation.Server.Host.Configuration.GeneralConfiguration.Section, and Tgstation.Server.Host.Configuration.SwarmConfiguration.Section.
Referenced by CheckRunWizard(), and RunWizard().
