Update writing.md

apply suggestions

Signed-off-by: Alex <52247724+Elya29@users.noreply.github.com>
This commit is contained in:
Alex
2024-02-02 14:19:22 +01:00
committed by GitHub
parent 93bb6b425f
commit 4841d6db89
+5 -2
View File
@@ -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.