This crate and the API behind it are unstable in a number of ways:
- The API of this crate may be broken at any time.
- This crate may expose experimental interfaces and services which are completely unsupported. There is no indication of which interfaces these are. Both the Rust APIs and the backing APIs and implementations may change at any time with no notice.
No support is provided for this code or the API directly. However, if you are experiencing issues with your Obscura VPN service please contact support@obscura.net.
At this time we are unable to accept external contributions. This is something that we plan to resolve soon. However until we finish the paperwork we are unable to look at any patches and will close all PRs without looking at them.
To enter a setup environment run:
nix developTo run single commands in the environment run:
nix develop -c just lintWarning: This is not an officially supported service.
To create a UDP relay tunnel and write the matching WireGuard configuration to wg0.conf.
cargo run --example api_cli -- --account-no $OBS_ACCOUNT_ID create-static-tunnel --wg-conf > wg0.confThe resulting configuration file should be compatible with any WireGuard client.
wg-quick up ./wg0.confIdle static tunnels are not removed automatically by clients if no tunnel slots are left. You may use this command to delete all tunnels if you run out of tunnel slots:
cargo run --example api_cli -- --account-no $OBS_ACCOUNT_ID delete-all-tunnels- The API or your internet stopped working unexpectedly? You probably deleted the tunnel while your WireGuard client was connected.
- Can't connect to a newly created tunnel? You are probably connected to another tunnel already.
In any case, the solution is almost always:
wg-quick down ./wg0.confcargo run --example gen_idNote that this generates a user id with the checksum (20 characters).