README.md 3.89 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
## Install 

# snap

```
sudo snap install riseup-vpn --classic
```

You can track beta channel, where we push versions to test:

```
sudo snap install riseup-vpn --classic --beta
```

Kali Kaneko's avatar
Kali Kaneko committed
15
16
17
18
19
<iframe
src="https://snapcraft.io/riseup-vpn/embedded?button=white&channels=true"
frameborder="0" width="100%" height="380px" style="border: 1px solid #CCC;
border-radius: 2px;"></iframe>

20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# arch

[There's a package in AUR](https://aur.archlinux.org/packages/riseup-vpn-git) that tracks main branch, so expect some instabilities (early birds catch the bugs they say, and we're thankful for that)

```
yaourt -Sy riseup-vpn-git
```

# deb

We haven't updated deb.leap.se repo yet 😞 (see #466), but if you *really* desire a debian
package you can build your own for the time being:

```
debuild -us -uc
sudo dpkg -i ../riseup-vpn*.deb
```

Kali Kaneko's avatar
Kali Kaneko committed
38
39
If you're using ubuntu, you can use [kali's ppa](https://launchpad.net/~kalikaneko/+archive/ubuntu/ppa).

40
## Build
41

Kali Kaneko's avatar
Kali Kaneko committed
42
Clone this repo, install dependencies and build the application. Dependencies
43
assume debian packages, or homebrew for osx. For Windows OS see corresponding section below. For other systems try
Kali Kaneko's avatar
Kali Kaneko committed
44
manually, or send us a patch.
Kali Kaneko's avatar
Kali Kaneko committed
45

46
```
47
  git clone git@0xacab.org:leap/bitmask-vpn.git && cd bitmask-vpn
Kali Kaneko's avatar
Kali Kaneko committed
48
  sudo make depends  # do not use sudo in osx 
Kali Kaneko's avatar
Kali Kaneko committed
49
  make build
50
```
51

52
You need at least go 1.11. 
53

54
If you have Ubuntu Bionic/18.04, the package in the repositories is too old. To resolve this, you can do `make install_go`. Do not do this if you have a later version.
Kali Kaneko's avatar
Kali Kaneko committed
55

56
For other situations, have a look at https://github.com/golang/go/wiki#working-with-go
57

58
## Test
Kali Kaneko's avatar
Kali Kaneko committed
59

Kali Kaneko's avatar
Kali Kaneko committed
60
61
You can run some tests too.

Kali Kaneko's avatar
Kali Kaneko committed
62
63
64
65
66
```
  sudo apt install qml-module-qttest
  make test
  make test_ui
```
Kali Kaneko's avatar
Kali Kaneko committed
67

68
69
70
71
72
73
74
75
76
77
78
## Windows
As for now app can be build on Win OS using `Cygwin` terminal.

#### Precondition
You need to have installed and added to your user PATH (mentioned version tested in Win10):
1) Go (>= go1.15.4)
2) QT (>= Qt5.12.9)
3) QtIFW (>= QtIFW-4.0.0)
4) Cygwin64 (>= 2.905 64 bit)
5) Using Cygwin `Package Select` window install `python3` and `make` packages. 

79
**Note:** for \#5 you don't need to add packages to PATH they will available in `cygwin` after installation.
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

#### Get Source
```
    git clone git@0xacab.org:leap/bitmask-vpn.git && cd bitmask-vpn
```

#### Build
Build script uses a symbolic link in one of the stages. Unfortunately Cygwin can't create native symlink from local non   
admin user due to windows security restriction. To avoid this issue we need to call next target from cygwin terminal as   
Administrator. This need to be done only once. 
```bash
    make relink_vendor
```

After `relink_vendor` use this to build the app:
```bash
    make build
```
After successful build application will be available at: `build/qt/release/riseup-vpn.exe`

#### Test

To run tests:

```bash
    make test
    make test_ui
```
Kali Kaneko's avatar
Kali Kaneko committed
108

Kali Kaneko's avatar
Kali Kaneko committed
109
110
Translations
------------
111

Kali Kaneko's avatar
Kali Kaneko committed
112
We use [transifex](https://www.transifex.com/otf/bitmask/RiseupVPN/) to coordinate translations. Any help is welcome!
113
114


Kali Kaneko's avatar
Kali Kaneko committed
115
116
Bugs? Crashes? UI feedback? Any other suggestions or complains?
---------------------------------------------------------------
117

118
When you are willing to [report an issue](https://0xacab.org/leap/bitmask-vpn/-/issues) please
Kali Kaneko's avatar
Kali Kaneko committed
119
120
use the search tool first. if you cannot find your issue, please make sure to
include the following information:
Kali Kaneko's avatar
Kali Kaneko committed
121

Kali Kaneko's avatar
Kali Kaneko committed
122
123
124
125
* the platform you're using and the installation method.
* the version of the program. You can check the version on the "about" menu.
* what you expected to see.
* what you got instead.
126
* the logs of the program. The location of the logs depends on the OS:
Kali Kaneko's avatar
Kali Kaneko committed
127
  * gnu/linux: `/home/<your user>/.config/leap/systray.log`
128
129
  * OSX: `/Users/<your user>/Library/Preferences/leap/systray.log`, `/Applications/RiseupVPN.app/Contents/helper/helper.log` & `/Applications/RiseupVPN.app/Contents/helper/openvpn.log`
  * windows: `C:\Users\<your user>\AppData\Local\leap\systray.log`, `C:\Program Files\RiseupVPN\helper.log` & `C:\Program Files\RiseupVPN\openvp.log`