Secrets Management
If your Umbraco Cloud project uses sensitive information such as API keys, encryption keys, and connection strings, it is recommended to store these as secrets.
There are two ways to add secrets to your Cloud project, as an Environment Secrets or as a Shared Secrets.
Environment Secrets are intended to be utilized exclusively within a particular environment during the runtime of your Umbraco solution.
Shared Secrets are utilized across all environments and will be seamlessly integrated into any new environment you create. Shared Secrets are particularly well-suited for safeguarding credentials necessary for project development, such as access to private NuGet feeds.
Utilizing environment-specific secrets for private NuGet feeds will result in the unsuccessful creation of new environments due to the unknown status of the secret. In such instances, Shared Secrets should be used.
Typical secrets are Private Keys, 3rd-party API tokens, database passwords, or otherwise sensitive data that needs to be kept secret.
When the secrets have been added they will be exposed exclusively to the assigned environments.
It will be assigned as an environment variable at runtime using the assigned name for the secret.
It will then use a reference that only the managed identity of the environment has access to.
How to add secrets
When adding a secret to your environment it will restart.
To add a secret to your environment follow these steps:
Go to your Umbraco Cloud project
Go to the Settings section and go to Secret Management
Choose either shared or environment secrets
Choose the environment to add the secret and click Add secret
Add the Key and the Value in the fields and click Add secret
Save the key to the environment.
Working locally with secrets
When you develop locally, you cannot access secrets that are stored in the key vault associated with a cloud environment.
We recommend that you use common methods for handling secrets locally, such as using app settings in the appsettings.development.json.
The app setting should not be committed to the code repository or it needs to be ignored via a gitignore file.
An example could be that you have a secret in a cloud environment with the key name "ApiKey",
You should specify this with a corresponding name in a configuration file such as appsettings.development.json:
Access secrets in a Umbraco Solution
Secrets for cloud environments are stored in a key vault and loaded by the app service (using a key vault reference) as an environment variable.
This enables you to get the value at runtime as you normally would fetch an environment variable.
You can use the method, getting it from the System namespace in .NET as below:
_secretMessage = Environment.GetEnvironmentVariable("SecretMessage");
Secrets can also be used to override AppSettings defined in appsettings.json files.
In order for this to work, when adding the secret, the Key value should be all the settings' names joined by double underscores.
For example, to change the Serilog's default options under Serilog:MinimumLevel:Default, the Secret key would look like this:
Serilog__MinimumLevel__Default
The value defined in appsettings.json file will be overwritten with the Cloud Secret's value.
Naming standards for secrets
When naming a secret, it is possible to use alphanumeric characters as well as '_' (underscore).
Some words are reserved and cannot be accepted:
COMMANDHOMEPORTREMOTEDEBUGGINGVERSIONREGION_NAMECONNECTIONSTRINGS__UMBRACODBDSN
The following prefixes are not accepted.
The list consists of:
UMBRACO_WEBSITE_SCM_SDEPLOY_DEPLOYMENT_DOCKER_CONTAINER_DIAGNOSTICS_APPSERVICEAPPLOGS_WEBSITE_DOTNET_IDENTITY_MSI_WEBJOBS_FUNCTIONS_AzureWebJobsWP_PHP_FILE_DATABASE_WORDPRESS_MACHINEKEY_SQLCONNSTRSQLAZURECONNSTR_POSTGRESQLCONNSTR_CUSTOMCONNSTR_MYSQLCONNSTR_AZUREFILESSTORAGE_AZUREBLOBSTORAGE_NOTIFICATIONHUBCONNSTR_SERVICEBUSCONNSTR_EVENTHUBCONNSTR_DOCDBCONNSTR_REDISCACHECONNSTR_FILESHARESTORAGE_
Accepted Prefixes
The following prefixes are allowed for Secrets on Umbraco Cloud:
Umbraco__CMS__Global__Smtp__Umbraco__Forms__Security__FormsApiKey__Umbraco__Forms__FieldTypes__Recaptcha__Umbraco__CMS__Integrations__Umbraco__CMS__DeliveryAPI__UMBRACO__LICENSES__UMBRACO__AUTHORIZEDSERVICES__UMBRACO__COMMERCE__
It is also possible to use Secrets to save API keys, Passwords, and ReChaptcha for all our Umbraco products on Umbraco Cloud.
Do you have an existing or new secret that you want to add to a key vault that conflicts with the name restrictions?
Then please contact Umbraco support, then we will consider it as soon as possible.
Last updated
Was this helpful?