smart-home-engine 1.0.3 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -14,50 +14,12 @@ Your home, your rules - written in plain JavaScript.
|
|
|
14
14
|
- Supports **InfluxDB**, **Elasticsearch** and **Redis** — convenience methods for time series, full text indexing, shared states across multiple she instances
|
|
15
15
|
- **Web UI** — script editor, package manager, MQTT browser, Matter device manager, sheDB frontend, log viewer
|
|
16
16
|
|
|
17
|
-
## Quick start
|
|
18
|
-
|
|
19
|
-
By default she webserver listens on port 8080
|
|
20
|
-
|
|
21
|
-
### Run manually
|
|
22
|
-
|
|
23
|
-
```bash
|
|
24
|
-
npm install -g smart-home-engine
|
|
25
|
-
she
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
All state is kept in `~/.she`
|
|
29
|
-
|
|
30
|
-
### Install as a systemd service
|
|
31
|
-
|
|
32
|
-
```bash
|
|
33
|
-
sudo npm install -g smart-home-engine
|
|
34
|
-
sudo she --install
|
|
35
|
-
sudo systemctl start smart-home-engine
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
`she --install` creates a dedicated `she` system user and installs + enables the systemd unit. All state is kept in `/var/lib/she/`.
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
### Run with Docker
|
|
42
|
-
|
|
43
|
-
```bash
|
|
44
|
-
docker build -t she .
|
|
45
|
-
docker run -d \
|
|
46
|
-
-p 8080:8080 \
|
|
47
|
-
-v she-data:/var/lib/she \
|
|
48
|
-
she
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
All state is kept in the `she-data` volume at `/var/lib/she`.
|
|
52
|
-
|
|
53
17
|
## Docs
|
|
54
18
|
|
|
55
19
|
| | |
|
|
56
20
|
|---|---|
|
|
57
21
|
| [Getting started](doc/getting-started.md) | Install, write your first script, configure |
|
|
58
|
-
| [CLI reference](doc/cli.md) | All flags and environment variables |
|
|
59
22
|
| [Sandbox API](doc/sandbox-api.md) | Everything available inside a script |
|
|
60
|
-
| [HTTP API](doc/http-api.md) | REST endpoints and WebSocket |
|
|
61
23
|
| [sheDB](doc/db/README.md) | Embedded document store — script API, views, examples |
|
|
62
24
|
| [Examples](doc/examples.md) | Real-world script patterns |
|
|
63
25
|
|