Getting Started

This guide will help you get started with SirrChat. Choose your path based on your needs.

Choose Your Path

🚀 I Want to Use the App

If you just want to start using Sirr for private messaging:

1. Download Sirr

   • iOS App Store
   • Google Play Store

2. Create Your Account

   • Launch the app
   • Create or import a wallet
   • Your wallet address becomes your account

3. Start Messaging

   • Add contacts by their wallet address
   • Send encrypted messages
   • Transfer crypto directly in chat

Full User Guide →

🖥️ I Want to Run My Own Server

If you want to deploy your own SirrChat server:

1. Quick Installation

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

2. Configure Your Domain

   • Set up DNS records
   • Choose a DNS provider for automatic TLS

3. Create User Accounts

   • Add users to your server
   • Configure authentication (password or blockchain)

Full Installation Guide →

👨‍💻 I Want to Develop

If you're a developer wanting to extend or integrate:

1. Build from Source

   git clone https://github.com/mail-chat-chain/mailchatd.git
   cd sirrchatd
   make build

2. Explore the Architecture

   • Understand the module system
   • Learn about available interfaces
   • Read the API documentation

3. Create Custom Modules

   • Write custom authentication modules
   • Extend storage backends
   • Add custom message processing

Architecture Guide →

Quick Start: User Journey

Step 1: Download Sirr

Choose your platform:

• iOS: App Store Link
• Android: Google Play Link
• Desktop: Coming soon

Step 2: Set Up Your Account

When you first launch Sirr:

1. Create a New Wallet

   • The app generates a BNBChain wallet
   • Your wallet address becomes your unique ID
   • Save your recovery phrase - this is crucial!

2. Or Import Existing Wallet

   • Use your existing BNBChain wallet
   • Import using private key or recovery phrase

3. Set Up Profile

   • Choose a display name
   • Add a profile picture (optional)
   • Your privacy is protected - no personal info required

Step 3: Add Contacts

Add people to chat with:

1. By Wallet Address

   • Ask for their wallet address
   • Add them as a contact

2. By Scanning QR Code

   • Scan their Sirr QR code
   • Instant contact addition

3. From Your Wallet

   • Import contacts from your crypto wallet

Step 4: Start Chatting

Send your first message:

1. Select a Contact

   • Tap on any contact to open chat

2. Type Your Message

   • Your message is automatically encrypted
   • Only the recipient can decrypt it

3. Send Crypto (Optional)

   • Tap the wallet icon
   • Send BNB or tokens directly in chat

Quick Start: Server Deployment

One-Click Deployment

The fastest way to get a SirrChat server running:

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

This script will:

• ✅ Detect your system architecture
• ✅ Download the correct binary
• ✅ Set up configuration directory
• ✅ Configure DNS and TLS certificates
• ✅ Create systemd service
• ✅ Start the mail server

Manual Deployment

For more control over the installation:

# 1. Download binary
wget https://download.sirrchat.org/sirrchatd-linux-amd64-latest
mv sirrchatd-linux-amd64-latest /usr/local/bin/sirrchatd
chmod +x /usr/local/bin/sirrchatd

# 2. Create configuration directory
export SIRRCHAT_HOME=$HOME/.sirrchatd
mkdir -p $SIRRCHAT_HOME

# 3. Initialize configuration
sirrchatd config init

# 4. Edit configuration
nano $SIRRCHAT_HOME/sirrchatd.conf

# 5. Start the server
sirrchatd run

Detailed Installation Guide →

Common Tasks

For Users

Sending Encrypted Messages

1. Open a chat with any contact
2. Type your message
3. Messages are automatically encrypted with OpenPGP
4. Only the recipient can read them

Sending Crypto

1. Tap the wallet icon in chat
2. Enter amount and select token
3. Confirm transaction
4. Instant transfer to recipient

Creating Red Envelopes

1. In a group chat, tap the red envelope icon
2. Choose amount and number of envelopes
3. Send to the group
4. Members tap to claim

For Server Administrators

Adding Users

# Create user with password
sirrchatd creds create user@yourdomain.com

# Create user with blockchain auth
sirrchatd creds create-blockchain \
  --email user@yourdomain.com \
  --address 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb

Managing Mailboxes

# List all mailboxes
sirrchatd imap-mboxes list user@yourdomain.com

# Create mailbox
sirrchatd imap-mboxes create user@yourdomain.com "Work"

# Delete mailbox
sirrchatd imap-mboxes delete user@yourdomain.com "Trash"

Checking Server Status

# View service status
sudo systemctl status sirrchatd

# View logs
sudo journalctl -u sirrchatd -f

# Check open ports
netstat -tlnp | grep sirrchatd

Next Steps

For Users

• Learn About Features - Explore all capabilities
• Wallet Guide - Master the built-in wallet
• FAQ - Common questions answered

For Administrators

• Configuration Guide - Detailed configuration
• Deployment Guide - Production deployment
• Security Best Practices

For Developers

• Module System - Understand modules
• API Reference - Full API documentation
• Blockchain Integration - Blockchain auth details

Getting Help

If you need assistance:

• 📖 Documentation: Browse this site
• 💬 Community: Join our chat
• 🐛 Issues: GitHub Issues
• 🐦 Twitter: Follow for updates

---

Welcome to SirrChat! We're excited to have you join our community of privacy-conscious users. 🎉