mirror of
https://github.com/agessaman/meshcore-bot.git
synced 2026-06-03 22:31:18 +00:00
agessaman
7b15d43dbd
- Enhanced the command reference with detailed descriptions for `cmd`, `version`, `weather`, and `path` commands, including usage examples and configuration options. - Added new `RandomLine` command documentation for configurable triggers. - Updated configuration documentation to reflect the deprecation of the global `[Aliases]` section, encouraging per-command alias definitions. - Clarified the `[Rate_Limits]` and `[Webhook]` sections in the configuration guide. - Improved the web viewer documentation, emphasizing security practices and configuration options.
2.2 KiB
2.2 KiB
meshcore-bot Documentation
Documentation for the MeshCore bot: setup, configuration, commands, and services.
New to the project? Start with Getting Started.
Project overview
- README – Getting started, installation, quick start
- Command Reference – Full command reference
- Docker deployment – Docker deployment
- Service installation – Systemd service setup
- Web Viewer – Authenticated dashboard with live streams
Operations
| Document | Description |
|---|---|
| Upgrade guide | Migrating from v0.7, v0.8, or earlier to v0.9 |
| Data retention | Database cleanup schedules and defaults |
| FAQ | Common installation and upgrade questions |
Configuration
| Document | Description |
|---|---|
| Configuration | config.ini structure and command options |
| Path Command | Path command presets and tuning |
| Config validation | Validate config.ini before starting the bot |
Guides
| Document | Description |
|---|---|
| Repeater Commands | Repeater management DM commands |
| Feed Management | RSS/REST feeds and posting to channels |
| Web Viewer | Web dashboard, real-time streams, and API |
Service Plugins
| Document | Description |
|---|---|
| Service Plugins overview | Enable and configure background services |
| Discord Bridge | One-way bridge to Discord |
| Telegram Bridge | One-way bridge to Telegram |
| Earthquake Service | Scheduled earthquake alerts from USGS |
| Packet Capture | Packet capture and MQTT |
| Map Uploader | Uploading to map.meshcore.dev |
| Weather Service | Scheduled weather and alerts |
| Repeater Prefix Collision Service | Detect repeater prefix collisions |