Quick Start
Get RouteMQ up and running in just a few minutes.
1. Initialize Your Project
After installation, initialize a new RouteMQ project:
python main.py --initThis creates the basic project structure and configuration files.
2. Configure Your Environment
Edit the .env file with your MQTT broker details:
# MQTT Configuration
MQTT_BROKER=localhost
MQTT_PORT=1883
MQTT_USERNAME=your_username # Optional
MQTT_PASSWORD=your_password # Optional
MQTT_CLIENT_ID=mqtt-framework-main # Optional
MQTT_GROUP_NAME=mqtt_framework_group # For shared subscriptions
# Database Configuration (Optional)
ENABLE_MYSQL=false
# Redis Configuration (Optional)
ENABLE_REDIS=false
# Logging Configuration
LOG_LEVEL=INFO
LOG_FORMAT=%(asctime)s - %(name)s - %(levelname)s - %(message)s3. Run the Application
Start RouteMQ:
uv run python main.py --runYour MQTT routing framework is now running and ready to handle messages!
4. Test Your Setup
You can test your setup by publishing a message to any of the example routes that are created during initialization.
What's Next?
Create Your First Route - Learn how to define custom routes
Configuration Guide - Detailed configuration options
Core Concepts - Understand the framework architecture
Last updated