Documentation Index

Welcome to the IRC.atl.chat documentation! This directory contains comprehensive guides for setting up, configuring, and managing your IRC server infrastructure.

🚀 Getting Started

• API.md - JSON-RPC API reference and WebSocket support for IRC server management
• CONFIG.md - Configuration system overview, environment variables, and template management
• DOCKER.md - Docker containerization setup, volumes, networking, and deployment
• MAKE.md - Makefile commands reference for build automation and service management
• TROUBLESHOOTING.md - Common issues, solutions, and debugging guides

🏗️ Core Components

• UNREALIRCD.md - UnrealIRCd server configuration, modules, and management
• ATHEME.md - Atheme IRC services setup (NickServ, ChanServ, OperServ)
• MODULES.md - UnrealIRCd module system, third-party extensions, and customization
• USERMODES.md - IRC user mode reference and configuration options
• WEBPANEL.md - Web-based administration interface setup and usage

🔒 Security & Operations

• SSL.md - Let's Encrypt automation, certificate management, and TLS configuration
• SECRET_MANAGEMENT.md - Password management, API tokens, and security best practices
• BACKUP_RECOVERY.md - Data protection, backup strategies, and disaster recovery procedures setup

🛠️ Development & Testing

• DEVELOPMENT.md - Local development setup, contribution guidelines, and workflow
• TESTING.md - Comprehensive test suite framework and testing strategies
• CI_CD.md - GitHub Actions workflows, automation, and deployment pipelines

🔧 Utilities & Scripts

• SCRIPTS.md - Management scripts, utilities, and automation tools

📋 Project Management

• TODO.md - Project roadmap, planned features, and development priorities

📁 Examples

The examples/ directory contains configuration templates and examples:

• examples/atheme/ - Atheme services configuration examples
  • atheme.conf.example - Main Atheme configuration template
  • atheme.motd.example - Message of the day template
• examples/unrealircd/ - UnrealIRCd configuration examples
  • unrealircd.conf - Main server configuration
  • aliases/ - Service alias configurations
  • examples/ - Multi-language configuration examples
  • help/ - Help system configurations
  • modules.*.conf - Module configuration files
  • tls/ - TLS/SSL certificate examples

Quick Navigation

For New Users

Start with: CONFIG.md → DOCKER.md → TROUBLESHOOTING.md

For Administrators

Focus on: UNREALIRCD.md → ATHEME.md → MONITORING.md

For Developers

Check out: DEVELOPMENT.md → TESTING.md → API.md

For Security

Review: SSL.md → SECRET_MANAGEMENT.md → BACKUP_RECOVERY.md

Contributing to Documentation

When adding or updating documentation:

1. Follow the existing structure and naming conventions
2. Include clear examples and code snippets
3. Update this README.md when adding new documentation files
4. Test all commands and configurations before documenting them
5. Use descriptive headings and maintain consistent formatting

Need Help?

• Check TROUBLESHOOTING.md for common issues
• Review the main project README.md for quick start instructions
• Open an issue on GitHub for specific problems or feature requests