Quick Start

Get SirrChat up and running in minutes with our one-click installation script.

Prerequisites

System Requirements

System Requirements:
  OS: Ubuntu 20.04+ / macOS 12+ / CentOS 8+
  CPU: 2+ cores
  RAM: 2GB minimum (4GB recommended)
  Storage: 20GB SSD
  Network: 100Mbps

Software Dependencies:
  Go: 1.24+ (for building from source)
  Git: Latest
  Make: Latest

Required Ports

Ensure the following ports are available:

Port	Service	Required
25	SMTP	Optional
587	Submission	Yes
465	SMTPS	Optional
993	IMAPS	Yes
143	IMAP	Optional
8825	SMTP Alt	Yes

One-Click Installation

Install and configure SirrChat with a single command:

# Download and run the installation script
curl -sSL https://raw.githubusercontent.com/mail-chat-chain/mailchatd/main/start.sh | bash

The automated installer will:

1. Download & Install the sirrchatd binary for your platform
2. Domain Configuration - Set up your email domain
3. DNS Provider Setup - Choose from 15 supported providers
4. TLS Certificate - Automatic ACME DNS-01 challenge setup
5. Service Management - Create and start systemd services

Supported DNS Providers

The installation script supports automatic TLS certificate provisioning with the following DNS providers:

Provider	Type	Authentication
Cloudflare	Global CDN	API Token
Amazon Route53	AWS DNS	Access Key + Secret
DigitalOcean	Cloud DNS	API Token
Google Cloud DNS	GCP DNS	Service Account JSON
Vultr	Cloud DNS	API Key
Hetzner	European DNS	API Token
Gandi	Domain Registrar	API Token
Namecheap	Domain Registrar	API Credentials
+ 7 more	Various	Various

Manual Installation

If you prefer manual installation:

1. Build from Source

# Clone the repository
git clone https://github.com/mail-chat-chain/mailchatd.git
cd sirrchatd

# Build the binary
make build

# Verify installation
./build/sirrchatd --help

2. Start the Server

# Run the mail server
./build/sirrchatd run

# Or use the start.sh script for automated configuration
./start.sh

First Steps

Create a User Account

# Create user credentials
sirrchatd creds create user@example.com

# Generate password hash (if using password authentication)
sirrchatd hash mypassword

Configure Your Email Client

Use any standard email client (Thunderbird, Outlook, Apple Mail, etc.) with these settings:

Incoming Mail (IMAP):

• Server: your-domain.com
• Port: 993
• Security: SSL/TLS
• Username: user@example.com
• Password: your-password

Outgoing Mail (SMTP):

• Server: your-domain.com
• Port: 587
• Security: STARTTLS
• Username: user@example.com
• Password: your-password

Send Your First Email

Once configured, you can send and receive emails through your SirrChat server!

Next Steps

• Deployment Guide - Production deployment best practices
• Configuration - Detailed configuration options
• Authentication - Set up blockchain authentication

Troubleshooting

Common Issues

Port already in use:

# Check which process is using the port
sudo lsof -i :25
sudo lsof -i :587

# Stop the conflicting service
sudo systemctl stop postfix  # Example for Postfix

TLS Certificate Issues:

# Check DNS configuration
sirrchatd dns check

# Verify DNS records
sirrchatd dns export

Service won't start:

# Check service status
sudo systemctl status sirrchatd

# View detailed logs
sudo journalctl -u sirrchatd -n 50

Getting Help

• Check the FAQ
• View detailed documentation
• Report issues on GitHub

---

Congratulations! You now have a working SirrChat server. 🎉