mirror of
https://github.com/agessaman/meshcore-bot.git
synced 2026-09-16 21:02:35 +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.
23 lines
747 B
Markdown
23 lines
747 B
Markdown
# Installation
|
|
|
|
Choose how to run the bot:
|
|
|
|
| Method | Best for |
|
|
|--------|----------|
|
|
| **[Docker](docker.md)** | Containers, consistent environments, easy updates |
|
|
| **[Service (systemd)](service-installation.md)** | Linux servers, run at boot, no containers |
|
|
| **Debian package** | `make deb` in the repo — see [README](https://github.com/agessaman/meshcore-bot/blob/main/README.md) |
|
|
|
|
## Requirements
|
|
|
|
- **Python 3.10+**
|
|
- MeshCore-compatible device (USB, BLE, or TCP)
|
|
|
|
## Development setup
|
|
|
|
See [Getting started](getting-started.md) for a quick development setup (run from the repo with `python meshcore_bot.py`).
|
|
|
|
## Upgrading
|
|
|
|
If you are upgrading from an older release, read the [Upgrade guide](upgrade.md) before restarting the bot.
|