highwall777/miwifi-webui-api repository overview

⁠miwifi-webui-api

Backend service for miwifi-webui, a self-hosted Xiaomi / Redmi router administration, telemetry and AI-assisted investigation platform.

⁠Responsibilities

The API service handles:

• Xiaomi / Redmi router authentication
• MiWiFi API capability probing
• Router status and telemetry collection
• Device inventory and presence history
• Per-device traffic observations
• PostgreSQL persistence
• Application authentication
• Audit events
• Router credential encryption
• Read-only AI investigation
• AI evidence and investigation sessions

⁠Recommended deployment

Use this image together with:

• highwall777/miwifi-webui-web
• highwall777/miwifi-webui-api
• PostgreSQL

The complete Docker Compose configuration is maintained in the GitHub repository:

GitHub: DockCat/miwifi-webui

git clone https://github.com/DockCat/miwifi-webui.git
cd miwifi-webui

docker compose up -d

⁠Required configuration

The backend requires PostgreSQL and an application master key.

Important environment variables include:

DATABASE_URL=postgres://...
APP_MASTER_KEY=...
API_PORT=3001
API_HOST=0.0.0.0

Optional AI investigation configuration:

AI_PROVIDER_MODE=external
AI_PROVIDER_BASE_URL=https://api.openai.com/v1
AI_PROVIDER_MODEL=your-model
AI_PROVIDER_API_KEY=your-api-key

AI_PROVIDER_MODE may also be configured for a local OpenAI-compatible provider.

AI integration is optional.

⁠Privacy-first AI investigation

The AI investigation layer is read-only.

It can inspect normalized router and telemetry data, but it cannot:

• reboot the router
• change Wi-Fi settings
• block devices through AI tools
• modify router configuration

When an external AI provider is used, device identifiers such as MAC addresses, IP addresses and device names are pseudonymized locally before provider egress.

⁠Security model

The browser never receives router passwords or MiWiFi stok session tokens.

Router credentials are handled by the backend and encrypted at rest.

⁠Health check

The API exposes:

GET /api/health

Default internal container port:

3001

⁠Docker image

docker pull highwall777/miwifi-webui-api:latest

For normal installations, use the project's Docker Compose configuration instead of running this image independently.

⁠Source code

Open source project:

https://github.com/DockCat/miwifi-webui

Please report router compatibility problems and bugs through GitHub Issues.

⁠Related image

Web frontend:

highwall777/miwifi-webui-web

⁠License

See the project repository for license information.