39 lines
1.3 KiB
Markdown
39 lines
1.3 KiB
Markdown
# Synapse
|
|
|
|
Synapse is the reference Matrix homeserver for self-hosted, federated, end-to-end encrypted messaging.
|
|
|
|
## Dependencies
|
|
|
|
- **PostgreSQL** - Database for storing messages and account data
|
|
- **Redis** - Used for inter-worker communication
|
|
|
|
## Configuration
|
|
|
|
Key settings configured through your instance's `config.yaml`:
|
|
|
|
- **domain** - Where the Synapse web client will be accessible (default: `synapse.{your-cloud-domain}`)
|
|
- **serverName** - Your Matrix server identity, used in user IDs like `@user:{serverName}` (default: `{your-cloud-domain}`)
|
|
- **enableRegistration** - Whether to allow public account creation (default: `false`)
|
|
- **storage** - Persistent volume for Synapse data (default: `2Gi`)
|
|
- **mediaStorage** - Persistent volume for uploaded media (default: `2Gi`)
|
|
- **SMTP** - Email delivery settings inherited from your Wild Cloud instance
|
|
|
|
## Access
|
|
|
|
After deployment, the Synapse homeserver will be available at:
|
|
- `https://synapse.{your-cloud-domain}`
|
|
|
|
Connect using any Matrix client (Element, FluffyChat, etc.) with your server name.
|
|
|
|
## First-Time Setup
|
|
|
|
1. Add and deploy the app:
|
|
```bash
|
|
wild app add synapse
|
|
wild app deploy synapse
|
|
```
|
|
|
|
2. Use the registration shared secret (in your `secrets.yaml`) to create your first admin account, or enable public registration temporarily
|
|
|
|
3. Connect with a Matrix client and start messaging
|