mirror of
https://github.com/MarekWo/mc-webui.git
synced 2026-03-28 17:42:45 +01:00
f8ef1ac297
Major documentation update with new data structure: Breaking Changes: - Data storage moved from host directories to ./data/ inside project - MC_CONFIG_DIR default changed: /root/.config/meshcore → ./data/meshcore - MC_ARCHIVE_DIR default changed: /mnt/archive/meshcore → ./data/archive - Requires migration for existing installations (see MIGRATION.md) Documentation: - Add MIGRATION.md - step-by-step guide for existing users - Add FRESH_INSTALL.md - complete installation guide for new users - Update README.md - new Configuration section with ./data/ structure - Update .env.example - placeholders instead of real values, new defaults - Update .claude/CLAUDE.md - updated environment variables documentation - Change serial device detection from 'ls -l' to 'ls' (cleaner output) Code Cleanup: - Remove deprecated MC_REFRESH_INTERVAL variable (unused since intelligent refresh) - Remove MC_REFRESH_INTERVAL from app/config.py - Remove refresh_interval from app/routes/views.py (5 functions) - Remove refresh_interval from app/routes/api.py - Remove refreshInterval from app/templates/index.html - Remove refreshInterval from app/templates/dm.html - Remove MC_REFRESH_INTERVAL from docker-compose.yml Configuration: - Update .gitignore - exclude data/ and docs/github-discussion-*.md - Serial port: use /dev/serial/by-id/[YOUR_DEVICE_ID] placeholder - Device name: use [YOUR_DEVICE_NAME] placeholder Benefits: - All project data in one location (easier backups) - Better portability (no host dependencies) - Cleaner codebase (removed unused variables) - Comprehensive documentation for migration and fresh install 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
67 lines
2.2 KiB
Plaintext
67 lines
2.2 KiB
Plaintext
# mc-webui Environment Configuration
|
|
# Copy this file to .env and adjust values for your setup
|
|
|
|
# ============================================
|
|
# MeshCore Device Configuration
|
|
# ============================================
|
|
|
|
# Serial port path (use /dev/serial/by-id for stable device names)
|
|
# Find your device: ls /dev/serial/by-id/
|
|
# Example: usb-Espressif_Systems_heltec_wifi_lora_32_v4__16_MB_FLASH__2_MB_PSRAM__90706984A000-if00
|
|
MC_SERIAL_PORT=/dev/serial/by-id/[YOUR_DEVICE_ID]
|
|
|
|
# Your MeshCore device name (used for .msgs file)
|
|
# Example: MarWoj, SP5XYZ, MyNode
|
|
MC_DEVICE_NAME=[YOUR_DEVICE_NAME]
|
|
|
|
# MeshCore configuration directory (where .msgs and settings files are stored)
|
|
# Default: ./data/meshcore (inside project directory)
|
|
# This directory is mounted as a Docker volume and shared between both containers
|
|
MC_CONFIG_DIR=./data/meshcore
|
|
|
|
# ============================================
|
|
# Application Settings
|
|
# ============================================
|
|
|
|
# Hours of inactivity before contacts can be cleaned up
|
|
MC_INACTIVE_HOURS=48
|
|
|
|
# Note: Auto-refresh is now intelligent and checks for new messages every 10 seconds
|
|
# No configuration needed - the system automatically updates UI only when new messages arrive
|
|
|
|
# ============================================
|
|
# Archive Configuration
|
|
# ============================================
|
|
|
|
# Directory for storing archived messages
|
|
# Default: ./data/archive (inside project directory)
|
|
# This directory is mounted as a Docker volume for mc-webui container
|
|
MC_ARCHIVE_DIR=./data/archive
|
|
|
|
# Enable automatic daily archiving at midnight
|
|
MC_ARCHIVE_ENABLED=true
|
|
|
|
# Number of days to show in live view (older messages available in archives)
|
|
MC_ARCHIVE_RETENTION_DAYS=7
|
|
|
|
# ============================================
|
|
# Flask Server Configuration
|
|
# ============================================
|
|
|
|
# Listen on all interfaces (0.0.0.0) or specific IP
|
|
FLASK_HOST=0.0.0.0
|
|
|
|
# Port to expose the web interface
|
|
FLASK_PORT=5000
|
|
|
|
# Debug mode (true/false) - use false in production
|
|
FLASK_DEBUG=false
|
|
|
|
# ============================================
|
|
# System Configuration
|
|
# ============================================
|
|
|
|
# Timezone for container logs (default: UTC)
|
|
# Examples: Europe/Warsaw, America/New_York, Asia/Tokyo
|
|
TZ=Europe/Warsaw
|