Skip to content

Commit bbeb1b5

Browse files
authored
feat: add documentation about smtp server (#51)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Added a section in the documentation detailing the requirements for configuring an SMTP server for email integration with the BTP platform. - Included clear descriptions of necessary parameters and an example YAML configuration to assist users in setup. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent f9b4047 commit bbeb1b5

File tree

1 file changed

+22
-0
lines changed
  • docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites

1 file changed

+22
-0
lines changed

docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites/Infrastructure.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,28 @@ observability:
280280
enabled: true
281281
```
282282

283+
## SMTP Server
284+
285+
An SMTP server is required to send emails, such as invitation emails, from the BTP platform.
286+
287+
### A typical set of parameters you should collect:
288+
289+
- `host`: the hostname of the SMTP server
290+
- `port`: the port of the SMTP server
291+
- `username`: the username for the SMTP server
292+
- `password`: the password for the SMTP server
293+
- `fromAddress`: the email address that will appear in the 'from' field of the emails sent by the BTP platform
294+
295+
[In your values file](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation/)
296+
297+
```yaml
298+
internal:
299+
email:
300+
enabled: true
301+
from: "fromAddress"
302+
server: "smtps://username:password@host:port"
303+
```
304+
283305
## Kubernetes Target Clusters
284306

285307
To deploy your blockchain nodes and additional services with the SettleMint Blockchain Transformation Platform (BTP), it's crucial to correctly set up your Kubernetes clusters. Here is a refined explanation that captures all the essential details:

0 commit comments

Comments
 (0)