diff --git a/docs/conf/writing.md b/docs/conf/writing.md index aef9620373..e0eb72f828 100644 --- a/docs/conf/writing.md +++ b/docs/conf/writing.md @@ -220,6 +220,8 @@ clientSecret: someGithubAppClientSecret webhookSecret: someWebhookSecret privateKey: | -----BEGIN RSA PRIVATE KEY----- - SomeRsaPrivateKey + SomeRsaPrivateKeySecurelyStored -----END RSA PRIVATE KEY----- ``` + +**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.