skydevapp/mikrotik-um-balance repository overview

⁠MikroTik User Manager Balance & Dashboard (RouterOS v7)

A secure, zero-overhead Microservice container designed for MikroTik RouterOS v7. It queries live User Manager data, quota balance, remaining uptime, and expiry dates via RouterOS v7 REST API (HTTP Basic Auth on port 87) without using deprecated binary API sockets (port 8728).

⁠Key Features

• Auto IP-Based Resolution (/api/me): Detects active Hotspot clients automatically without exposing usernames in the browser URL.
• Strict Least Privilege: Requires only policy=read,rest-api,api,sensitive on RouterOS.
• Zero Legacy Sockets: Communicates exclusively via HTTP REST API.
• Hotspot Ready: Ships with a standalone client library (um-api.js) for embedding into status.html via simple data-um HTML attributes.
• Embedded Dashboard: Clean UI at /dashboard for real-time bandwidth & session monitoring.

⁠Supported Architectures

• linux/amd64 (x86, CHR, PC Servers)
• linux/arm64 (RB5009, CCR2004, etc.)

⁠Environment Variables

• FLASK_HOST: Default 0.0.0.0
• FLASK_PORT: Default 5000
• ROUTER_HOST: IP of MikroTik gateway (e.g., 172.18.0.1)
• ROUTER_PORT: MikroTik REST API / www port (Default 87)
• ROUTER_USER: API username (e.g., um_api_user)
• ROUTER_PASS: API user password
• CACHE_TTL: Cache time in seconds (Default 15)

⁠Quick Run on RouterOS v7

/container add remote-image="skydevapp/mikrotik-um-balance:latest" interface=veth-um envlist=flask_envs root-dir=disk1/um-data
/container start [find tag~"mikrotik-um-balance"]