feat: complete wgcloak v1 transports
This commit is contained in:
1 parent
49ec9d8c33
commit
cedab4910e
47 files changed
+2849
-400
No files matched your search
@@ -19,10 +19,14 @@ cargo test --all-targets
|
||||
cargo build --release
|
||||
```
|
||||
|
||||
`cargo test --all-targets` also runs the `harness = false` Criterion target as
|
||||
its smoke check; use `cargo bench --bench protocol_transports` for measured
|
||||
benchmark results.
|
||||
|
||||
For a local host installation:
|
||||
|
||||
```bash
|
||||
sudo install -Dm755 target/release/wgcloak /usr/local/bin/wgcloak
|
||||
sudo install -Dm755 target/release/wgcloak /usr/bin/wgcloak
|
||||
sudo install -d -o root -g wgcloak -m0750 /etc/wgcloak/clients
|
||||
```
|
||||
|
||||
@@ -68,10 +72,16 @@ wgcloak client --config /etc/wgcloak/client.toml
|
||||
See [`docs/OPERATIONS.md`](docs/OPERATIONS.md) for control commands, systemd
|
||||
deployment, shutdown behavior, and troubleshooting pointers.
|
||||
|
||||
Fuzzing setup and parser invariants are documented in
|
||||
[`docs/FUZZING.md`](docs/FUZZING.md).
|
||||
|
||||
## systemd
|
||||
|
||||
The units in [`packaging/systemd/`](packaging/systemd/) assume a dedicated
|
||||
`wgcloak` user, `/usr/bin/wgcloak`, and configuration under `/etc/wgcloak/`.
|
||||
With the supplied units, use `/run/wgcloak-client/wgcloak.sock` for client
|
||||
commands and `/run/wgcloak-server/wgcloak.sock` for server commands, for
|
||||
example `wgcloak stats --socket /run/wgcloak-client/wgcloak.sock`.
|
||||
Review the paths and enabled listeners before installing. The server unit
|
||||
contains an optional, commented `CAP_NET_BIND_SERVICE` setting for ports below
|
||||
1024. Normal operation needs neither `CAP_NET_ADMIN` nor `CAP_SYS_ADMIN`.
|
||||
@@ -93,6 +103,8 @@ cluster servers, or provide multiple simultaneous local client tunnels.
|
||||
- [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md): runtime roles and ownership.
|
||||
- [`docs/PROTOCOL.md`](docs/PROTOCOL.md): wire protocol and transport behavior.
|
||||
- [`docs/OPERATIONS.md`](docs/OPERATIONS.md): setup, control, and systemd.
|
||||
- [`docs/BENCHMARKS.md`](docs/BENCHMARKS.md): deterministic benchmark commands,
|
||||
environment reporting, and datagram-size guidance.
|
||||
- [`docs/SECURITY.md`](docs/SECURITY.md): threat model and permissions.
|
||||
- [`docs/TROUBLESHOOTING.md`](docs/TROUBLESHOOTING.md): common failures.
|
||||
- [`docs/IMPLEMENTATION_CHECKLIST.md`](docs/IMPLEMENTATION_CHECKLIST.md):
|
||||
|
||||
Reference in new issue
Block a user