Rustmail Documentation
Welcome to the Rustmail documentation. This guide covers installation, configuration, usage, and development of the Rustmail Discord modmail bot.
Getting Started
New to Rustmail? Start here:
- Installation - Download and system requirements
- Configuration - Set up your
config.toml - First Steps - Launch the bot and verify setup
User Guides
Learn how to use Rustmail effectively:
| Guide | Description |
|---|---|
| Commands | Complete reference for all slash and text commands |
| Server Modes | Single-server vs dual-server architecture |
| Tickets | Managing support tickets and conversations |
| Web Panel | Using the administration interface |
Reference
Technical documentation for advanced users:
| Document | Description |
|---|---|
| Configuration Options | All config.toml settings explained |
| REST API | HTTP endpoints for integrations |
| Database Schema | SQLite table structures |
Deployment
Production deployment guides:
| Guide | Description |
|---|---|
| Docker | Container-based deployment |
| Production | Best practices for production environments |
Development
For contributors and developers:
| Document | Description |
|---|---|
| Architecture | Project structure and design |
| Building | Compile from source |
| Contributing | Contribution guidelines |