diff --git a/README.md b/README.md new file mode 100644 index 0000000..7872bc3 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# RV50x Manager + +Web-based management tool for Sierra Wireless AirLink RV50x cellular modems. +Runs as a Docker stack alongside NocoDB and PostgreSQL. + +## Features + +- Download and upload configuration templates to modems via browser automation (Playwright) +- XML template builder — populate templates from NocoDB device data or Excel spreadsheets +- SSH terminal and AT command interface for direct modem access +- Job queue with persistent history (SQLite) +- AT command presets — save and replay named command sequences + +## Quick Start + +See [README-docker.md](README-docker.md) for full deployment instructions including: +- Docker setup and stack configuration +- `.env` file reference +- NocoDB setup and ID retrieval +- Updating, migrating, and troubleshooting + +## Stack + +| Container | Purpose | Port | +|-----------|---------|------| +| `rv50x-manager` | FastAPI web app + Playwright | Configurable | +| `rv50x-nocodb` | NocoDB UI and API | 8090 | +| `rv50x-postgres` | PostgreSQL for NocoDB | Internal only | + +## Configuration + +Copy `.env.example` to `.env` and fill in your NocoDB URL, token, base/table/view IDs, +and PostgreSQL password before starting the stack. + +```bash +cp .env.example .env +nano .env +docker compose up -d +```