# Product OS : VPN

Product OS : VPN provides a fully functioning automation tool for VPN connectivity.  When using with Product OS : Proxy, it allows a Rust program to tunnel traffic through a VPN, especially in a dockerised environment.

### What is Product OS?

Product OS is a collection of packages that provide different tools and features that can work together to build products more easily for the Rust ecosystem.

## Installation

Use the Rust crate package manager [cargo](https://www.rust-lang.org/tools/install) to install Product OS : VPN.

```bash
cargo add product-os-vpn
```

or add Product OS : VPN to your cargo.toml ```[packages]``` section.

```rust
product-os-vpn = { version = "0.0.2", features = [], default-features = true, optional = false }
```

## Features

Product OS VPN supports a number of features leveraging existing Rust libraries including:

- Framework for multiple VPN providers over multiple VPN protocols
- Base build using OpenVPN and support for NordVPN
- Set of middleware for proxy support using Product OS : Proxy for Rust tunnelling

```rust
// Feature samples TODO
```

## Usage

```rust
// Examples TODO
```

## Contributing

Contributions are not currently available but will be available on a public repository soon.

## License

[GNU AGPLv3](https://choosealicense.com/licenses/agpl-3.0/)