Skip to content

Commit 113d376

Browse files
committed
clarify readme
1 parent d72120f commit 113d376

1 file changed

Lines changed: 4 additions & 31 deletions

File tree

README.md

Lines changed: 4 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Roborock Local Server
22

33
If this project helps, you can support it or next time you buy a Roborock device, come back here and use my affiliate links!
4+
45
[![Buy Me a Coffee][badge-bmac]][link-bmac]
56
[![PayPal][badge-paypal]][link-paypal]
67
[![Roborock 5 Off][badge-roborock-discount]][link-roborock-discount]
@@ -9,44 +10,16 @@ If this project helps, you can support it or next time you buy a Roborock device
910

1011
Roborock Local Server is a private Roborock HTTPS and MQTT stack you run on your own system.
1112

12-
It gives you:
13-
14-
- one Docker container
15-
- one admin UI
16-
- one `config.toml`
17-
- embedded Mosquitto or an external MQTT broker
18-
- automatic wildcard certificate renewal through Cloudflare DNS-01
19-
- cloud import for homes, rooms, devices, shared devices, scenes, and schedules
20-
2113
This service is meant to stay private. Point your own DNS at your server's LAN IP and do **NOT** expose it directly to the public internet. In its current state it does not handle internet exposure safely enough. For now, keep it on your LAN only. In the future, I plan to reuse Roborock's auth natively which should make everything secure enough.
2214

23-
## Runtime/Adapter Split
24-
25-
This repository now supports a core runtime mode and a standalone adapter mode:
26-
27-
- standalone adapter mode (default): includes `/admin` dashboard + admin APIs
28-
- core runtime mode: protocol runtime only, no `/admin` standalone dashboard routes
29-
- `/ui/api/health` and `/ui/api/vacuums` stay available in both modes for automation/adapter consumers
30-
31-
Run core runtime mode with:
32-
33-
```bash
34-
uv run roborock-local-server serve --config config.toml --core-only
35-
```
36-
37-
The Home Assistant add-on wrapper lives in the sibling repository:
38-
39-
- `../roborock_local_server_ha_addon`
40-
41-
It vendors this runtime package and starts it with `--core-only`.
15+
This project is in VERY EARLY BETA!!! Do not use this repository unless you are sure you know what you are doing and are rather technical.
4216

4317
## Requirements
4418

4519
- Docker with `docker compose`
4620
- `uv`
4721
- a Linux server or Linux VM on your LAN
4822
- a domain you control
49-
- private DNS for that domain or subdomain
5023
- a Cloudflare API token with DNS edit access for the zone
5124

5225
## Create the Cloudflare Token
@@ -66,11 +39,11 @@ For this project, keep the token limited to the single zone you are using. Do no
6639

6740
## How It Works
6841

69-
Pick one hostname, for example `roborock.example.com`.
42+
Pick one hostname under your domain, for example `roborock.example.com`.
7043

7144
- `stack_fqdn` is the hostname the app, vacuums, and admin UI will use.
7245
- `base_domain` is the zone used for the wildcard certificate, for example `example.com`.
73-
- Your private DNS should point `stack_fqdn` at your server's LAN IP.
46+
- Your network's DNS should point `stack_fqdn` at your server's LAN IP.
7447
- Cloudflare is only used for DNS-01 certificate issuance. It does not need to proxy traffic to your server.
7548

7649
The vacuum needs to be able to hit your server on ports 443/tcp and 8883/tcp.

0 commit comments

Comments
 (0)