Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Proxy Support for API Servers #237

Closed
wants to merge 6 commits into from
Closed

Proxy Support for API Servers #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
965e36a
Adds instructions for installing, uninstalling, updating using Guix
ryanprior May 28, 2020
494ccd9
Migrated from Docopt to ArgParse (#204)
Jul 4, 2020
239c930
Add proxy support for fetching metadata from API Servers
iiriix Sep 22, 2020
8bcf000
Add configuration support for proxy
iiriix Sep 22, 2020
3a41b9a
Add usage guide for the proxy
iiriix Sep 22, 2020
88b91df
Fix flake8 linting
iiriix Sep 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ For more detailed information on installing, updating and uninstalling, please v

For the following Linux distribution(s), install the official `protonvpn-cli` package:

#### Guix

```sh
guix install protonvpn-cli
```

#### Fedora

```sh
Expand Down Expand Up @@ -68,6 +74,7 @@ Depending on your distribution, run the appropriate following command to install
|Ubuntu/Linux Mint/Debian and derivatives | `sudo apt install -y openvpn dialog python3-pip python3-setuptools`|
|OpenSUSE/SLES | `sudo zypper in -y openvpn dialog python3-pip python3-setuptools` |
|Arch Linux/Manjaro | `sudo pacman -S openvpn dialog python-pip python-setuptools` |
|Guix | `guix environment protonvpn-cli` |

#### Installing ProtonVPN-CLI

Expand Down
21 changes: 20 additions & 1 deletion USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ This document provides an extensive guide on how to install and use ProtonVPN-CL
- [Table of Contents](#table-of-contents)
- [Installation & Updating](#installation--updating)
- [Installing from distribution repositories](#installing-from-distribution-repositories)
- [Guix](#guix)
- [Fedora](#fedora)
- [CentOS & RHEL](#centos--rhel)
- [Installing from PyPI](#installing-from-pypi)
Expand All @@ -31,6 +32,7 @@ This document provides an extensive guide on how to install and use ProtonVPN-CL
- [IPv6 Leak Protection](#ipv6-leak-protection)
- [Kill Switch](#kill-switch)
- [Split Tunneling](#split-tunneling)
- [Proxy Support for API Servers](#proxy-support-for-api-servers)
- [Enhancements](#enhancements)
- [Disable sudo password query](#disable-sudo-password-query)
- [Configure alias for quicker access](#configure-alias-for-quicker-access)
Expand All @@ -43,6 +45,12 @@ This document provides an extensive guide on how to install and use ProtonVPN-CL

For the following Linux distribution(s), install the official `protonvpn-cli` package:

#### Guix

```sh
guix install protonvpn-cli
```

#### Fedora

```sh
Expand Down Expand Up @@ -85,6 +93,7 @@ Depending on your distribution, run the appropriate following command to install
|Ubuntu/Linux Mint/Debian and derivatives | `sudo apt install -y openvpn dialog python3-pip python3-setuptools`|
|OpenSUSE/SLES | `sudo zypper in -y openvpn dialog python3-pip python3-setuptools` |
|Arch Linux/Manjaro | `sudo pacman -S openvpn dialog python-pip python-setuptools` |
|Guix | `guix environment protonvpn-cli` |

#### Installing ProtonVPN-CLI

Expand Down Expand Up @@ -162,7 +171,7 @@ Now you should be able to use the protonvpn command from anywhere in the system

1. Purge configuration

`sudo protonvpn configure` -> `7` -> `y`
`sudo protonvpn configure` -> `8` -> `y`

2. Delete the ProtonVPN-CLI folder

Expand Down Expand Up @@ -411,6 +420,16 @@ If you want to have a big list of IPs or ranges that you want to exclude, it is

Then call `protonvpn refresh` to update the OpenVPN template with your excluded IP addresses.

### Proxy Support for API Servers

When the API servers are not reachable due to any reason, for example, if the they are blocked, filtered, or behind a firewall, you can enable and configure proxy in order to reach API servers.

*Note: This is only used to get the necessary metadata from ProtonVPN API servers. This is not used to establish the VPN connection through the proxy.*

To enable proxy for this purpose, run `protonvpn configure` command, and then select `7 Proxy for Metadata Servers` option. Then choose `1 Enable Metadata Proxy`.

To configure proxy IP and Port, run `protonvpn configure` command, and then select `7 Proxy for Metadata Servers`. Then choose `2 Configure Metadata Proxy Address`. Enter IP and then Port of the proxy that should be used.

## Enhancements

A list of optional enhancements that make using ProtonVPN-CLI easier.
Expand Down