<\!DOCTYPE html> First-Time Setup
Back to Documentation

First-Time Setup

After installing Mail-Rulez, this guide walks you through the initial configuration to secure your installation and prepare for email automation.

Initial Login

  1. Access the Web Interface
    • Open your browser to http://localhost:5001
    • You'll see the Mail-Rulez login screen

Screenshot: Initial login screen

  1. Login with Default Credentials
    • Username: admin
    • Password: changeme
    • Click "Login"

Securing Your Installation

Change Admin Password (Required)

Immediately after first login, you'll be prompted to change the admin password.

  1. Navigate to Security Settings
    • The system will redirect you to password change
    • Or go to Settings → Security

Screenshot: Password change dialog

  1. Set a Strong Password

    • Enter current password: changeme
    • Enter new password (requirements):
      • Minimum 8 characters
      • Mix of letters, numbers, and symbols
      • Not a common word or pattern
    • Confirm new password
    • Click "Update Password"

  2. Password Updated

    • You'll be logged out automatically
    • Log back in with your new password

Security Best Practices

  • Use a Password Manager: Generate and store a strong password
  • Regular Updates: Change password every 90 days
  • Unique Password: Don't reuse passwords from other services
  • Secure Access: Use HTTPS in production (see Deployment Guide)

System Configuration

After securing your account, configure basic system settings.

1. General Settings

Navigate to Settings → General:

Screenshot: Settings overview page

  • System Name: Customize the application name (default: "Mail-Rulez")
  • Time Zone: Set your local timezone for accurate scheduling
  • Language: Currently English only (more coming soon)

2. Data Directory Structure

Mail-Rulez creates the following directory structure:

/app/data/
├── accounts/          # Account configurations
├── lists/            # Whitelist, blacklist, vendor lists
├── logs/             # Application logs
├── config/           # System configuration
└── backups/          # Automated backups

3. Initial System Check

The dashboard shows system status:

  • System Health: Should show "Healthy"
  • Database: Connected and initialized
  • Scheduler: Ready (not started yet)
  • Available Space: Ensure adequate disk space

Understanding the Interface

Main Navigation

  • Dashboard: System overview and quick stats
  • Accounts: Email account management
  • Rules: Email processing rules
  • Lists: Whitelist/blacklist management
  • Retention: Email lifecycle policies
  • Logs: System and processing logs
  • Settings: System configuration

Dashboard Overview

The dashboard provides:

  • Account Status: Shows configured accounts
  • Processing Stats: Emails processed today/week/month
  • Active Rules: Number of active processing rules
  • System Health: Real-time system status

Screenshot: Dashboard with initial state

Backup Configuration

Enable Automatic Backups

  1. Go to Settings → Backup
  2. Configure backup settings:
    • Enable Backups: Toggle on
    • Backup Schedule: Daily at 2 AM (recommended)
    • Retention: Keep last 7 backups
    • Include Logs: Optional (increases backup size)

Manual Backup

Create an initial backup:

# For Docker
docker exec mail-rulez python -m backup create

# For manual installation
python -m backup create

Environment-Specific Setup

Development Environment

If setting up for development:

  • Enable debug logging: Settings → Logging → Set to DEBUG
  • Disable automatic processing initially
  • Use test email accounts

Production Environment

For production deployments:

  • Keep logging at INFO level
  • Enable HTTPS (see Deployment Guide)
  • Configure proper backup retention
  • Set up monitoring alerts

Verify Setup

System Health Check

  1. Go to Settings → System
  2. Click "Run Health Check"
  3. All items should show green checkmarks:
    • ✓ Database Connection
    • ✓ File System Access
    • ✓ Configuration Valid
    • ✓ Scheduler Ready

Test Email Connectivity

Before adding accounts, ensure your network allows IMAP:

# Test common IMAP servers
# Gmail
nc -zv imap.gmail.com 993

# Outlook
nc -zv outlook.office365.com 993

# Should show "Connection successful"

Next Steps

Your Mail-Rulez installation is now secure and configured! Continue with:

  1. Account Configuration - Add your email accounts
  2. Processing Modes - Understand startup vs maintenance modes
  3. Complete Workflow Guide - Full setup to automation guide

Quick Reference

Important Paths

  • Web Interface: http://localhost:5001
  • Configuration: /app/data/config/
  • Logs: /app/data/logs/
  • Backups: /app/data/backups/

Default Settings

  • Port: 5001
  • Processing Interval: 15 minutes (maintenance mode)
  • Log Retention: 30 days
  • Session Timeout: 30 minutes

Getting Help

  • Built-in Help: Click the "?" icon in any section
  • Logs: Check /app/data/logs/mail-rulez.log for issues
  • Community: GitHub Discussions