From 68349dc91f6f2444cb83ed7b4699059d5383ccf3 Mon Sep 17 00:00:00 2001 From: Jordan Dominion Date: Fri, 16 Aug 2024 16:06:30 -0400 Subject: [PATCH] Specify classic GitHub tokens --- README.md | 2 +- docs/Features.dox | 2 +- src/Tgstation.Server.Host/Configuration/GeneralConfiguration.cs | 2 +- src/Tgstation.Server.Host/Setup/SetupWizard.cs | 2 +- src/Tgstation.Server.Host/appsettings.yml | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 794543dc854..58b341d571a 100644 --- a/README.md +++ b/README.md @@ -239,7 +239,7 @@ Create an `appsettings.Production.yml` file next to `appsettings.yml`. This will - `General:InstanceLimit`: Maximum number of instances that may be created -- `General:GitHubAccessToken`: Specify a GitHub personal access token with no scopes here to highly mitigate the possiblity of 429 response codes from GitHub requests +- `General:GitHubAccessToken`: Specify a classic GitHub personal access token with no scopes here to highly mitigate the possiblity of 429 response codes from GitHub requests - `General:SkipAddingByondFirewallException`: Set to `true` if you have Windows firewall disabled diff --git a/docs/Features.dox b/docs/Features.dox index 64eca5a3f7c..6600cb295f7 100644 --- a/docs/Features.dox +++ b/docs/Features.dox @@ -5,7 +5,7 @@ @section features_list Comprehensive Feature List -tgstation-server is a BYOND server managment suite. It includes all the following features +tgstation-server is a DreamMaker server managment suite. It includes all the following features - Standalone server with OpenAPI 3.0 defined HTTP REST API - Web based client included diff --git a/src/Tgstation.Server.Host/Configuration/GeneralConfiguration.cs b/src/Tgstation.Server.Host/Configuration/GeneralConfiguration.cs index bc9c11e2f36..1790316e370 100644 --- a/src/Tgstation.Server.Host/Configuration/GeneralConfiguration.cs +++ b/src/Tgstation.Server.Host/Configuration/GeneralConfiguration.cs @@ -89,7 +89,7 @@ public sealed class GeneralConfiguration : ServerInformationBase public ushort ApiPort { get; set; } /// - /// A GitHub personal access token to use for bypassing rate limits on requests. Requires no scopes. + /// A classic GitHub personal access token to use for bypassing rate limits on requests. Requires no scopes. /// public string? GitHubAccessToken { get; set; } diff --git a/src/Tgstation.Server.Host/Setup/SetupWizard.cs b/src/Tgstation.Server.Host/Setup/SetupWizard.cs index 04cc54a3bfd..5c77ecffebc 100644 --- a/src/Tgstation.Server.Host/Setup/SetupWizard.cs +++ b/src/Tgstation.Server.Host/Setup/SetupWizard.cs @@ -705,7 +705,7 @@ async ValueTask ConfigureGeneral(CancellationToken cancell while (true); await console.WriteAsync(null, true, cancellationToken); - await console.WriteAsync("Enter a GitHub personal access token to bypass some rate limits (this is optional and does not require any scopes)", true, cancellationToken); + await console.WriteAsync("Enter a classic GitHub personal access token to bypass some rate limits (this is optional and does not require any scopes)", true, cancellationToken); await console.WriteAsync("GitHub personal access token: ", false, cancellationToken); newGeneralConfiguration.GitHubAccessToken = await console.ReadLineAsync(true, cancellationToken); if (String.IsNullOrWhiteSpace(newGeneralConfiguration.GitHubAccessToken)) diff --git a/src/Tgstation.Server.Host/appsettings.yml b/src/Tgstation.Server.Host/appsettings.yml index 526f38ab386..732a61e54b2 100644 --- a/src/Tgstation.Server.Host/appsettings.yml +++ b/src/Tgstation.Server.Host/appsettings.yml @@ -3,7 +3,7 @@ General: # ConfigVersion: # Basic semver. Differs from TGS version to version. See changelog for current version MinimumPasswordLength: 15 # Minimum TGS user password length - GitHubAccessToken: # GitHub personal access token with no scopes used to bypass rate-limits + GitHubAccessToken: # A classic GitHub personal access token with no scopes used to bypass rate-limits SetupWizardMode: AutoDetect # If the interactive TGS setup wizard should run ByondTopicTimeout: 5000 # Timeout for BYOND /world/Topic() calls in milliseconds RestartTimeoutMinutes: 1 # Timeout for server restarts after requested by SIGTERM or the HTTP API