wild-directory/matrix/README.md

Matrix (Synapse)

Matrix is an open standard for secure, decentralized, real-time communication. This deploys the Synapse homeserver for self-hosted Matrix federation and 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: matrix.{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: 50Gi)
• mediaStorage - Persistent volume for uploaded media (default: 100Gi)
• SMTP - Email delivery settings inherited from your Wild Cloud instance

Access

After deployment, the Synapse homeserver will be available at:

• https://matrix.{your-cloud-domain}

Connect using any Matrix client (Element, FluffyChat, etc.) with your server name.

First-Time Setup

1. Add and deploy the app:

   wild app add matrix
   wild app deploy matrix
   

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