diff --git a/docs/conf/writing.md b/docs/conf/writing.md index b5515f8618..e0eb72f828 100644 --- a/docs/conf/writing.md +++ b/docs/conf/writing.md @@ -218,7 +218,10 @@ webhookUrl: https://smee.io/foo clientId: someGithubAppClientId clientSecret: someGithubAppClientSecret webhookSecret: someWebhookSecret -privateKey: someSecretRsaPrivateKey +privateKey: | + -----BEGIN RSA PRIVATE KEY----- + SomeRsaPrivateKeySecurelyStored + -----END RSA PRIVATE KEY----- ``` -**Warning: RSA private keys should not be hard coded**. We recommend that this entire file should be a secret and stored as such in a secure storage solution like Vault, to ensure they are neither exposed nor misused. +**Warning: Sensitive information, such as private keys, should not be hard coded**. We recommend that this entire file should be a secret and stored as such in a secure storage solution like Vault, to ensure they are neither exposed nor misused. This example key part only shows the format on how to use the yaml | syntax to make sure that the key is valid.