summaryrefslogtreecommitdiffstats
path: root/server/src/Data/Static
diff options
context:
space:
mode:
authorivarlovlie <git@ivarlovlie.no>2022-07-03 12:27:56 +0200
committerivarlovlie <git@ivarlovlie.no>2022-07-03 12:27:56 +0200
commit79a0c629b7d7d187ac04ad4069adfe8aa927cac3 (patch)
treed67efc919f097487d53a6131df8bd6bddfd2d550 /server/src/Data/Static
parentba80d7e34ef739b2db00e6087fde92eae5c40e11 (diff)
downloadgreatoffice-79a0c629b7d7d187ac04ad4069adfe8aa927cac3.tar.xz
greatoffice-79a0c629b7d7d187ac04ad4069adfe8aa927cac3.zip
refactor: Clarify which environment variables the app consumes
Diffstat (limited to 'server/src/Data/Static')
-rw-r--r--server/src/Data/Static/AppEnvironmentVariables.cs12
1 files changed, 12 insertions, 0 deletions
diff --git a/server/src/Data/Static/AppEnvironmentVariables.cs b/server/src/Data/Static/AppEnvironmentVariables.cs
index 4555bfb..2a2d591 100644
--- a/server/src/Data/Static/AppEnvironmentVariables.cs
+++ b/server/src/Data/Static/AppEnvironmentVariables.cs
@@ -2,8 +2,20 @@ namespace IOL.GreatOffice.Api.Data.Static;
public static class AppEnvironmentVariables
{
+ /// <summary>
+ /// An access token that can be used to access the Hashicorp Vault instance that is available at VAULT_URL
+ /// </summary>
public const string VAULT_TOKEN = "VAULT_TOKEN";
+ /// <summary>
+ /// An url pointing to the Hashicorp Vault instance the app should use
+ /// </summary>
public const string VAULT_URL = "VAULT_URL";
+ /// <summary>
+ /// The vault key name for the main configuration json object, described by <see cref="AppConfiguration"/>
+ /// </summary>
public const string MAIN_CONFIG_SHEET = "MAIN_CONFIG_SHEET";
+ /// <summary>
+ /// The duration of which to keep a local cached version of the configuration
+ /// </summary>
public const string VAULT_CACHE_TTL = "CONFIG_CACHE_TTL";
}