Skip to content
This repository was archived by the owner on Nov 5, 2025. It is now read-only.

Commit d8b2498

Browse files
kaplunRafficer
authored andcommitted
Amend order of USAGE.md
* Reposition the Ubuntu example after the the initialization part, so that the example is presneted only after all the components have been introduced.
1 parent e0db126 commit d8b2498

File tree

1 file changed

+45
-45
lines changed

1 file changed

+45
-45
lines changed

USAGE.md

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ This document provides an extensive guide on how to install and use ProtonVPN-CL
1414
- [Installing ProtonVPN-CLI](#installing-protonvpn-cli)
1515
- [Updating ProtonVPN-CLI](#updating-protonvpn-cli)
1616
- [Uninstall](#uninstall)
17-
- [Example Installation on Ubuntu 18.04](#example-installation-on-ubuntu-1804)
1817
- [Installing in a virtual environment](#installing-in-a-virtual-environment)
1918
- [Install](#install)
2019
- [Update](#update)
2120
- [Uninstall](#uninstall-1)
2221
- [Initialization](#initialization)
22+
- [Example Installation on Ubuntu 18.04](#example-installation-on-ubuntu-1804)
2323
- [Commands](#commands)
2424
- [List of all Commands](#list-of-all-commands)
2525
- [Command Explanations](#command-explanations)
@@ -108,50 +108,6 @@ For PIP this would be
108108

109109
Bye Bye 😔
110110

111-
#### Example Installation on Ubuntu 18.04
112-
113-
1. Installing dependencies
114-
115-
To install ProtonVPN-CLI's dependencies, open a terminal and type `sudo apt install -y dialog openvpn python3-pip python3-setuptools` and confirm with Enter. Wait for the installation to finish
116-
117-
2. Installing ProtonVPN-CLI
118-
119-
To install ProtonVPN-CLI type `sudo pip3 install protonvpn-cli` in the terminal and confirm with Enter again. It should look something like this:
120-
121-
![ubuntu-pip-install](resources/images/usage-ubuntu-pip-install.png)
122-
123-
3. Initialize the ProtonVPN profile
124-
125-
Now you have access to the `protonvpn` command. Before using ProtonVPN-CLI you need to initialize your profile. To do this, type `sudo protonvpn init`
126-
127-
The client will ask you for your OpenVPN username and password. You can find them at https://account.protonvpn.com/account
128-
129-
![openvpn-pass](resources/images/usage-openvpn-pass.png)
130-
131-
Follow the prompts and enter your OpenVPN credentials:
132-
133-
![ubuntu-pass-entry](resources/images/usage-ubuntu-pass-entry.png)
134-
135-
Next, you need to select your plan. If you are currently enjoying the 7-day free trial of ProtonVPN Plus, select `3) Plus`.
136-
137-
![ubuntu-plan](resources/images/usage-ubuntu-plan.png)
138-
139-
*IMPORTANT: After your trial expires, you will need to reconfigure your plan to 1) Free. To set this up, enter `sudo protonvpn configure`. Then select `2) ProtonVPN Plan`. Finally, select `1) Free`.*
140-
141-
Now, you need to choose which default transmission protocol you want to use. UDP is typically the faster option, while TCP is a more reliable protocol that's better suited for unstable connections and in restricted networks. The default selection is UDP.
142-
143-
![ubuntu-proto](resources/images/usage-ubuntu-proto.png)
144-
145-
Finally, confirm your input with `y`
146-
147-
![ubuntu-confirm](resources/images/usage-ubuntu-confirm.png)
148-
149-
4. Connect to ProtonVPN
150-
151-
You are now ready to connect to ProtonVPN. For example, you can let ProtonVPN-CLI find the fastest server for you. Just type `sudo protonvpn connect -f` and a connection will be established.
152-
153-
![ubuntu-connected](resources/images/usage-ubuntu-connected.png)
154-
155111
### Installing in a virtual environment
156112

157113
If you're having trouble with the normal installation or don't want to install ProtonVPN-CLI as root, follow this guide to install it in a Python virtual environment.
@@ -220,6 +176,50 @@ Now you should be able to use the protonvpn command from anywhere in the system
220176

221177
Before you can use ProtonVPN-CLI, you need to initialize it. Run `sudo protonvpn init` and follow the prompts on the screen.
222178

179+
## Example Installation on Ubuntu 18.04
180+
181+
1. Installing dependencies
182+
183+
To install ProtonVPN-CLI's dependencies, open a terminal and type `sudo apt install -y dialog openvpn python3-pip python3-setuptools` and confirm with Enter. Wait for the installation to finish
184+
185+
2. Installing ProtonVPN-CLI
186+
187+
To install ProtonVPN-CLI type `sudo pip3 install protonvpn-cli` in the terminal and confirm with Enter again. It should look something like this:
188+
189+
![ubuntu-pip-install](resources/images/usage-ubuntu-pip-install.png)
190+
191+
3. Initialize the ProtonVPN profile
192+
193+
Now you have access to the `protonvpn` command. Before using ProtonVPN-CLI you need to initialize your profile. To do this, type `sudo protonvpn init`
194+
195+
The client will ask you for your OpenVPN username and password. You can find them at https://account.protonvpn.com/account
196+
197+
![openvpn-pass](resources/images/usage-openvpn-pass.png)
198+
199+
Follow the prompts and enter your OpenVPN credentials:
200+
201+
![ubuntu-pass-entry](resources/images/usage-ubuntu-pass-entry.png)
202+
203+
Next, you need to select your plan. If you are currently enjoying the 7-day free trial of ProtonVPN Plus, select `3) Plus`.
204+
205+
![ubuntu-plan](resources/images/usage-ubuntu-plan.png)
206+
207+
*IMPORTANT: After your trial expires, you will need to reconfigure your plan to 1) Free. To set this up, enter `sudo protonvpn configure`. Then select `2) ProtonVPN Plan`. Finally, select `1) Free`.*
208+
209+
Now, you need to choose which default transmission protocol you want to use. UDP is typically the faster option, while TCP is a more reliable protocol that's better suited for unstable connections and in restricted networks. The default selection is UDP.
210+
211+
![ubuntu-proto](resources/images/usage-ubuntu-proto.png)
212+
213+
Finally, confirm your input with `y`
214+
215+
![ubuntu-confirm](resources/images/usage-ubuntu-confirm.png)
216+
217+
4. Connect to ProtonVPN
218+
219+
You are now ready to connect to ProtonVPN. For example, you can let ProtonVPN-CLI find the fastest server for you. Just type `sudo protonvpn connect -f` and a connection will be established.
220+
221+
![ubuntu-connected](resources/images/usage-ubuntu-connected.png)
222+
223223
## Commands
224224

225225
### List of all Commands

0 commit comments

Comments
 (0)