Add README.md
This commit is contained in:
12
README.md
Normal file
12
README.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# Health-API
|
||||||
|
FastAPI system monitoring and remote control service for the smol-pie.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- **GET `/status`**: Public endpoint for CPU, Temperature, Memory, and Network stats.
|
||||||
|
- **POST `/led/blink`**: Protected endpoint (`x-token` header required) to trigger the LED flash.
|
||||||
|
- **GET `/health`**: Simple health check.
|
||||||
|
|
||||||
|
## Deployment
|
||||||
|
Runs inside a Docker container.
|
||||||
|
1. `docker compose up -d`
|
||||||
|
2. Ensure a local `.env` file exists with `LUNA_API_TOKEN`.
|
||||||
Reference in New Issue
Block a user