Skip to content

Installation Guide

This guide will help you install SirrChat mail server on different platforms.

System Requirements

Minimum Requirements

  • CPU: 1 core
  • RAM: 512MB
  • Storage: 10GB available space
  • OS: Linux (Ubuntu 20.04+, Debian 11+, CentOS 8+)
  • CPU: 2 cores or more
  • RAM: 2GB or more
  • Storage: 50GB SSD
  • Network: Fixed IP address and domain name

Quick Installation

One-Click Install Script

For Ubuntu/Debian systems:

bash
curl -sSL https://raw.githubusercontent.com/mail-chat-chain/mailchatd/main/start.sh | bash

This script will automatically:

  • Install all dependencies
  • Download the latest version of SirrChat
  • Configure system service
  • Set up TLS certificates

Manual Installation

1. Download Binary

Download the latest version from GitHub Releases:

bash
wget https://github.com/mail-chat-chain/mailchatd/releases/latest/download/sirrchatd-linux-amd64.tar.gz
tar -xzf sirrchatd-linux-amd64.tar.gz
sudo mv sirrchatd /usr/local/bin/
sudo chmod +x /usr/local/bin/sirrchatd

2. Create System User

bash
sudo useradd -r -s /bin/false -d /var/lib/sirrchatd sirrchat
sudo mkdir -p /var/lib/sirrchatd
sudo chown sirrchat:sirrchat /var/lib/sirrchatd

3. Create Configuration File

bash
sudo mkdir -p /etc/sirrchatd
sudo sirrchatd config init > /etc/sirrchatd/config.toml

Edit configuration file:

bash
sudo nano /etc/sirrchatd/config.toml

4. Configure Systemd Service

Create service file /etc/systemd/system/sirrchatd.service:

ini
[Unit]
Description=SirrChat Mail Server
After=network-online.target
Wants=network-online.target

[Service]
Type=simple
User=sirrchat
Group=sirrchat
ExecStart=/usr/local/bin/sirrchatd run --config /etc/sirrchatd/config.toml
Restart=always
RestartSec=10
StandardOutput=journal
StandardError=journal

[Install]
WantedBy=multi-user.target

Enable and start service:

bash
sudo systemctl daemon-reload
sudo systemctl enable sirrchatd
sudo systemctl start sirrchatd

Docker Installation

Using Docker Compose

Create docker-compose.yml:

yaml
version: '3.8'

services:
  sirrchat:
    image: sirrchat/sirrchatd:latest
    ports:
      - "25:25"
      - "587:587"
      - "143:143"
      - "993:993"
    volumes:
      - ./config.toml:/etc/sirrchatd/config.toml
      - maildata:/var/lib/sirrchatd
    environment:
      - SIRRCHAT_SERVER_HOSTNAME=mail.example.com
    restart: unless-stopped

  postgres:
    image: postgres:15-alpine
    environment:
      - POSTGRES_DB=sirrchat
      - POSTGRES_USER=sirrchat
      - POSTGRES_PASSWORD=your-password
    volumes:
      - pgdata:/var/lib/postgresql/data
    restart: unless-stopped

volumes:
  maildata:
  pgdata:

Start services:

bash
docker-compose up -d

Building from Source

Prerequisites

  • Go 1.21 or higher
  • Git

Build Steps

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

# Build
go build -o sirrchatd ./cmd/sirrchatd

# Install
sudo mv sirrchatd /usr/local/bin/
sudo chmod +x /usr/local/bin/sirrchatd

Database Setup

PostgreSQL

bash
# Install PostgreSQL
sudo apt install postgresql postgresql-contrib

# Create database and user
sudo -u postgres psql <<EOF
CREATE DATABASE sirrchat;
CREATE USER sirrchat WITH ENCRYPTED PASSWORD 'your-password';
GRANT ALL PRIVILEGES ON DATABASE sirrchat TO sirrchat;
EOF

MySQL

bash
# Install MySQL
sudo apt install mysql-server

# Create database and user
sudo mysql <<EOF
CREATE DATABASE sirrchat;
CREATE USER 'sirrchat'@'localhost' IDENTIFIED BY 'your-password';
GRANT ALL PRIVILEGES ON sirrchat.* TO 'sirrchat'@'localhost';
FLUSH PRIVILEGES;
EOF

SQLite

SQLite requires no additional installation, SirrChat will automatically create the database file.

DNS Configuration

Configure DNS records for your mail server:

A Record

mail.example.com. IN A 203.0.113.1

MX Record

example.com. IN MX 10 mail.example.com.

SPF Record

example.com. IN TXT "v=spf1 mx ~all"

DKIM Record

Generate DKIM key and add TXT record:

bash
sirrchatd dkim generate --domain example.com

DMARC Record

_dmarc.example.com. IN TXT "v=DMARC1; p=quarantine; rua=mailto:[email protected]"

Firewall Configuration

Open necessary ports:

bash
# UFW
sudo ufw allow 25/tcp
sudo ufw allow 587/tcp
sudo ufw allow 143/tcp
sudo ufw allow 993/tcp

# firewalld
sudo firewall-cmd --permanent --add-service=smtp
sudo firewall-cmd --permanent --add-service=smtp-submission
sudo firewall-cmd --permanent --add-service=imap
sudo firewall-cmd --permanent --add-service=imaps
sudo firewall-cmd --reload

Verify Installation

Check Service Status

bash
sudo systemctl status sirrchatd

Test SMTP Connection

bash
telnet mail.example.com 25

Test IMAP Connection

bash
telnet mail.example.com 143

View Logs

bash
sudo journalctl -u sirrchatd -f

Troubleshooting

Service Won't Start

  1. Check configuration file syntax:

    bash
    sirrchatd config verify
  2. Check log output:

    bash
    sudo journalctl -u sirrchatd -n 50

Port Already in Use

Check port usage:

bash
sudo netstat -tulpn | grep -E ':(25|587|143|993)'

Database Connection Failed

Verify database connection:

bash
sirrchatd db ping

Next Steps

Released under the GPL 3.0 License.