smart-home-engine 1.0.0 → 1.0.3
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
|
@@ -16,7 +16,9 @@ Your home, your rules - written in plain JavaScript.
|
|
|
16
16
|
|
|
17
17
|
## Quick start
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
By default she webserver listens on port 8080
|
|
20
|
+
|
|
21
|
+
### Run manually
|
|
20
22
|
|
|
21
23
|
```bash
|
|
22
24
|
npm install -g smart-home-engine
|
|
@@ -25,7 +27,7 @@ she
|
|
|
25
27
|
|
|
26
28
|
All state is kept in `~/.she`
|
|
27
29
|
|
|
28
|
-
|
|
30
|
+
### Install as a systemd service
|
|
29
31
|
|
|
30
32
|
```bash
|
|
31
33
|
sudo npm install -g smart-home-engine
|
|
@@ -35,28 +37,18 @@ sudo systemctl start smart-home-engine
|
|
|
35
37
|
|
|
36
38
|
`she --install` creates a dedicated `she` system user and installs + enables the systemd unit. All state is kept in `/var/lib/she/`.
|
|
37
39
|
|
|
38
|
-
> **Tip:** use `journalctl -u smart-home-engine -o cat -f` to follow logs with colours intact.
|
|
39
|
-
|
|
40
|
-
Then open **http://localhost:8080** and start creating scripts
|
|
41
40
|
|
|
42
|
-
|
|
41
|
+
### Run with Docker
|
|
43
42
|
|
|
44
43
|
```bash
|
|
45
44
|
docker build -t she .
|
|
46
45
|
docker run -d \
|
|
47
46
|
-p 8080:8080 \
|
|
48
47
|
-v she-data:/var/lib/she \
|
|
49
|
-
she
|
|
50
|
-
--url mqtt://192.168.1.10
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
All state (scripts, config, DB) is kept in the `she-data` volume at `/var/lib/she`. Pass `--url` with your MQTT broker address, or drop a `config.json` into the volume's `config/` subdirectory instead:
|
|
54
|
-
|
|
55
|
-
```json
|
|
56
|
-
{ "url": "mqtt://192.168.1.10", "latitude": 48.7, "longitude": 9.1 }
|
|
48
|
+
she
|
|
57
49
|
```
|
|
58
50
|
|
|
59
|
-
|
|
51
|
+
All state is kept in the `she-data` volume at `/var/lib/she`.
|
|
60
52
|
|
|
61
53
|
## Docs
|
|
62
54
|
|