@zixt/host 0.0.7 → 0.0.9
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 +44 -5
- package/dist/index.js +8210 -2403
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -6,8 +6,9 @@ coordinates the work.
|
|
|
6
6
|
|
|
7
7
|
## Run it
|
|
8
8
|
|
|
9
|
-
Pair a Machine in Zixt (Machines → Pair a machine) to get
|
|
10
|
-
code
|
|
9
|
+
Pair a Machine in Zixt (Machines → Pair a machine) to get its private pairing
|
|
10
|
+
code. Zixt shows that code once; it remains valid until you replace it or
|
|
11
|
+
revoke the Machine. Then start the Host with it:
|
|
11
12
|
|
|
12
13
|
```bash
|
|
13
14
|
ZIXT_HOST_TOKEN='zxh_...' npx @zixt/host@latest
|
|
@@ -24,22 +25,60 @@ ZIXT_HOST_TOKEN='zxh_...' zixt-host
|
|
|
24
25
|
Keep it running on an always-on machine: Tasks cannot start while the Host is
|
|
25
26
|
asleep, signed out, or offline.
|
|
26
27
|
|
|
28
|
+
### Start automatically
|
|
29
|
+
|
|
30
|
+
Use the command for your operating system on Zixt's Machines page. It ends with
|
|
31
|
+
`--install-service`, for example:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
ZIXT_HOST_TOKEN='zxh_...' npx @zixt/host@latest --install-service
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
This starts Zixt immediately and installs the native, per-user automatic-start
|
|
38
|
+
mechanism:
|
|
39
|
+
|
|
40
|
+
- Linux: a systemd user service starts after reboot, including before sign-in
|
|
41
|
+
when user lingering is available. If lingering cannot be enabled, setup
|
|
42
|
+
stops and prints the one administrator command needed before retrying.
|
|
43
|
+
- macOS: a LaunchAgent starts Zixt after this account signs in.
|
|
44
|
+
- Windows: a least-privilege Scheduled Task starts Zixt after this account
|
|
45
|
+
signs in.
|
|
46
|
+
|
|
47
|
+
Zixt deliberately uses the same computer account that owns the runner login;
|
|
48
|
+
it never runs Tasks as root, Administrator, or LocalSystem. The Linux pairing
|
|
49
|
+
code lives in `~/.config/zixt/host.env` (or the configured `XDG_CONFIG_HOME`)
|
|
50
|
+
and the macOS code lives in the account's mode-`0600` Zixt configuration.
|
|
51
|
+
Windows protects the stored code with that account's DPAPI key and restricts
|
|
52
|
+
the startup files to that account and SYSTEM.
|
|
53
|
+
|
|
54
|
+
The copied setup command itself contains the current long-lived pairing code,
|
|
55
|
+
so your shell may retain it in terminal history. Treat that history as a copy
|
|
56
|
+
of the credential. Replacing the Machine's setup code or revoking the Machine
|
|
57
|
+
invalidates it.
|
|
58
|
+
|
|
59
|
+
File permissions keep other accounts out, but they are not a sandbox from
|
|
60
|
+
software already running as your account. Use a dedicated computer account for
|
|
61
|
+
an unattended Machine. On macOS and Windows, signing out stops that account's
|
|
62
|
+
background processes; unfinished work resumes after the next sign-in.
|
|
63
|
+
|
|
27
64
|
## Options
|
|
28
65
|
|
|
29
66
|
| Environment variable | Meaning |
|
|
30
67
|
| ---------------------- | ------------------------------------------------------------- |
|
|
31
|
-
| `ZIXT_HOST_TOKEN` | The
|
|
68
|
+
| `ZIXT_HOST_TOKEN` | The private code shown once on the Machines page. Required. |
|
|
32
69
|
| `ZIXT_CLOUD_URL` | The Zixt gateway to connect to. Defaults to the cloud. |
|
|
33
70
|
| `ZIXT_HOST_UPDATE` | `off` pins this Machine to the version it is running. |
|
|
34
71
|
| `ZIXT_HOST_UPDATE_URL` | A registry mirror to check for releases instead of npmjs.org. |
|
|
35
72
|
|
|
36
73
|
## Staying current
|
|
37
74
|
|
|
38
|
-
|
|
75
|
+
While it is running, the Host keeps itself up to date. It checks for a newer published release,
|
|
39
76
|
and when it finds one it stops the work it is doing the same way Ctrl+C would
|
|
40
77
|
— every run is unwound, and Zixt re-dispatches that work with its session
|
|
41
78
|
resumed — then relaunches on the new version. Nothing to schedule and nothing
|
|
42
|
-
to restart by hand.
|
|
79
|
+
to restart by hand. Every automatic-start installation follows the updated
|
|
80
|
+
stable release, so a later reboot or sign-in does not revert Zixt to the
|
|
81
|
+
version first installed.
|
|
43
82
|
|
|
44
83
|
Set `ZIXT_HOST_UPDATE=off` to stay on the version you started.
|
|
45
84
|
|