@agora-build/dialf 0.1.45 → 0.1.47

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.
Files changed (2) hide show
  1. package/README.md +17 -3
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -36,13 +36,27 @@ walkthrough and the [phone-app reference](https://github.com/Agora-Build/DialF/b
36
36
 
37
37
  ## Run the daemon as a service
38
38
 
39
- `npm install` only installs the CLI. To run `dialfd` in the background:
39
+ `npm install` only installs the CLI. To run `dialfd` in the background, pick a scope — the
40
+ install scope decides whether the daemon is private to you or shared by everyone on the machine:
40
41
 
41
42
  ```sh
42
- sudo dialf service install # boot service (launchd/systemd)
43
- dialf service install --user # or per-user (login), no sudo
43
+ # Isolated (your own private daemon):
44
+ dialf service install --user
45
+ # per-user socket: /run/user/$UID/dialfd.sock (Linux) or /tmp/dialfd-$UID.sock (macOS).
46
+ # CLI and daemon auto-agree on the socket.
47
+
48
+ # Shared (one daemon all login users can drive):
49
+ sudo dialf service install
50
+ # creates the `dialf` group and binds a machine-wide socket
51
+ # (/run/dialf/dialfd.sock on Linux, /var/run/dialfd.sock on macOS), group `dialf`, mode 0660.
52
+ sudo usermod -aG dialf <user> # grant a user access — Linux
53
+ sudo dseditgroup -o edit -a <user> -t user dialf # macOS
54
+ # the user logs out/in, then `dialf devices` reaches the shared daemon.
44
55
  ```
45
56
 
57
+ The control socket lets its holder dial, hang up, send SMS, and run jobs, so keep the `dialf`
58
+ group to trusted users. Manage the service with `dialf service status|stop|start|uninstall [--user]`.
59
+
46
60
  ## Usage
47
61
 
48
62
  ```sh
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@agora-build/dialf",
3
- "version": "0.1.45",
3
+ "version": "0.1.47",
4
4
  "description": "DialF — autonomous phone pick/call daemon (dialfd) + CLI",
5
5
  "bin": {
6
6
  "dialf": "bin/dialf.js"