Skip to content

Commit 3173097

Browse files
docs: replace non-working cargo install instructions (#2)
`cargo install zentinel-agent-js` fails: the crate is not published on crates.io. Documents `cargo install --git`, which does work, plus the prebuilt release binaries. Also points the bundle docs link at docs.zentinelproxy.io; the zentinelproxy.io/docs/ URL 404s.
1 parent 98acaf2 commit 3173097

1 file changed

Lines changed: 21 additions & 2 deletions

File tree

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,31 @@ zentinel bundle install js
2323
zentinel bundle install
2424
```
2525

26-
The bundle command downloads the correct binary for your platform and places it in the standard location. See the [bundle documentation](https://zentinelproxy.io/docs/deployment/bundle/) for details.
26+
The bundle command downloads the correct binary for your platform and places it in the standard location. See the [bundle documentation](https://docs.zentinelproxy.io/deployment/bundle/) for details.
2727

2828
### Using Cargo
2929

30+
`zentinel-agent-js` is not published on crates.io, so `cargo install zentinel-agent-js` does not
31+
work. Install straight from the repository instead:
32+
33+
```bash
34+
cargo install --git https://github.com/zentinelproxy/zentinel-agent-js
35+
```
36+
37+
This builds and installs the `zentinel-js-agent` binary.
38+
39+
### Prebuilt Binaries
40+
41+
Each [release](https://github.com/zentinelproxy/zentinel-agent-js/releases) ships binaries
42+
for `linux-x86_64`, `linux-aarch64`, and `darwin-aarch64`:
43+
3044
```bash
31-
cargo install zentinel-agent-js
45+
VERSION=0.3.0
46+
PLATFORM=linux-x86_64 # or linux-aarch64, darwin-aarch64
47+
curl -fsSL -o zentinel-js-agent.tar.gz \
48+
"https://github.com/zentinelproxy/zentinel-agent-js/releases/download/v${VERSION}/zentinel-js-agent-${VERSION}-${PLATFORM}.tar.gz"
49+
tar -xzf zentinel-js-agent.tar.gz
50+
sudo install -m 0755 zentinel-js-agent /usr/local/bin/
3251
```
3352

3453
### From Source

0 commit comments

Comments
 (0)