updating the documentation of the SilverLinux Insftracture
This commit is contained in:
+205
@@ -0,0 +1,205 @@
|
||||
# Email Configuration
|
||||
|
||||
## Overview
|
||||
|
||||
SilverLinux uses a centralized SMTP configuration for application email delivery.
|
||||
|
||||
Email is used for:
|
||||
|
||||
* Password resets
|
||||
* User invitations
|
||||
* Notifications
|
||||
* System alerts
|
||||
* Future CI/CD notifications
|
||||
|
||||
---
|
||||
|
||||
## Sender Address
|
||||
|
||||
```text
|
||||
noreply@silveressence.net
|
||||
```
|
||||
|
||||
Purpose:
|
||||
|
||||
* Automated emails
|
||||
* Application notifications
|
||||
* No inbound processing required
|
||||
|
||||
---
|
||||
|
||||
## SMTP Provider
|
||||
|
||||
Provider:
|
||||
|
||||
```text
|
||||
Gmail SMTP
|
||||
```
|
||||
|
||||
Server:
|
||||
|
||||
```text
|
||||
smtp.gmail.com
|
||||
```
|
||||
|
||||
Port:
|
||||
|
||||
```text
|
||||
587
|
||||
```
|
||||
|
||||
Security:
|
||||
|
||||
```text
|
||||
STARTTLS
|
||||
```
|
||||
|
||||
Authentication:
|
||||
|
||||
```text
|
||||
Login
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Secret Storage
|
||||
|
||||
SMTP credentials are stored in:
|
||||
|
||||
```text
|
||||
/srv/secrets/company.env
|
||||
```
|
||||
|
||||
Variables:
|
||||
|
||||
```text
|
||||
SMTP_HOST
|
||||
SMTP_PORT
|
||||
SMTP_USERNAME
|
||||
SMTP_PASSWORD
|
||||
```
|
||||
|
||||
These values must never be committed to Git repositories.
|
||||
|
||||
---
|
||||
|
||||
## Applications Using Email
|
||||
|
||||
### OpenProject
|
||||
|
||||
Purpose:
|
||||
|
||||
* Password reset emails
|
||||
* Work package notifications
|
||||
* Mention notifications
|
||||
* User invitations
|
||||
|
||||
Sender:
|
||||
|
||||
```text
|
||||
noreply@silveressence.net
|
||||
```
|
||||
|
||||
Status:
|
||||
|
||||
Configured
|
||||
|
||||
---
|
||||
|
||||
### Gitea
|
||||
|
||||
Purpose:
|
||||
|
||||
* Password reset emails
|
||||
* Repository notifications
|
||||
* User invitations
|
||||
|
||||
Sender:
|
||||
|
||||
```text
|
||||
noreply@silveressence.net
|
||||
```
|
||||
|
||||
Status:
|
||||
|
||||
Configured
|
||||
|
||||
---
|
||||
|
||||
## Future Applications
|
||||
|
||||
Future services should use the centralized SMTP configuration whenever possible.
|
||||
|
||||
Examples:
|
||||
|
||||
* BaGet
|
||||
* CI/CD notifications
|
||||
* Monitoring systems
|
||||
* Alerting systems
|
||||
|
||||
---
|
||||
|
||||
## Testing
|
||||
|
||||
### OpenProject
|
||||
|
||||
Test by:
|
||||
|
||||
1. Creating a user.
|
||||
2. Triggering a password reset.
|
||||
3. Verifying email delivery.
|
||||
|
||||
### Gitea
|
||||
|
||||
Test by:
|
||||
|
||||
1. Opening "Forgot Password".
|
||||
2. Requesting a password reset.
|
||||
3. Verifying email delivery.
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### OpenProject
|
||||
|
||||
View logs:
|
||||
|
||||
```bash
|
||||
docker logs openproject
|
||||
```
|
||||
|
||||
### Gitea
|
||||
|
||||
View logs:
|
||||
|
||||
```bash
|
||||
docker logs gitea
|
||||
```
|
||||
|
||||
### Gmail Authentication
|
||||
|
||||
Verify:
|
||||
|
||||
* App password is valid
|
||||
* SMTP credentials match company.env
|
||||
* STARTTLS is enabled
|
||||
* Port 587 is used
|
||||
|
||||
---
|
||||
|
||||
## Security Notes
|
||||
|
||||
* Use Gmail App Passwords.
|
||||
* Never use personal Gmail passwords.
|
||||
* Store SMTP credentials only in company.env.
|
||||
* Rotate credentials if they become exposed.
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
* docs/secrets.md
|
||||
* docs/security.md
|
||||
* openproject/README.md
|
||||
* gitea/README.md
|
||||
|
||||
Reference in New Issue
Block a user