summaryrefslogtreecommitdiff
path: root/branding/README.rst
blob: 108ba5ec56f12fc9cb8c544ce04dba71d0d61980 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
BitmaskVPN Branding Procedure
================================================================================

This folder contains everything that is needed to generate a customized built of
the Desktop BitmaskVPN app for a given provider.


Configure
--------------------------------------------------------------------------------

To start a new vendoring project, initialize a new repo for your provider:

  export VENDOR_PATH=../leapvpn-myprovider-pkg
  make vendor_init

Follow the directions in the output of the above command. Basically you need to
configure your provider CA certificate, and some graphical assets:

  * Copy your provider CA certificate to the same folder: 'config/<provider>-ca.crt'
  * Check the list of assets at 'assets/FILES.Readme'.

You can validate your configuration:

  export VENDOR_PATH=../leapvpn-myprovider-pkg
  make vendor_check

Checkout
--------------------------------------------------------------------------------

 git clone https://0xacab.org/leap/bitmask-vpn
 cd bitmask-vpn
 git pull --tags


Package
--------------------------------------------------------------------------------

NOTE: Some of the following scripts need network access, since they will check
whether the configuration published by your provider matches what is configured
before the build. If you want to skip this check, pass `SKIP_CACHECK=yes`

Run::

 export VENDOR_PATH=../leapvpn-myprovider-pkg
 make vendor
 make prepare

Then you can build the binary::

 make build

* FIXME: the following does not work yet ---------------------
  REFACTORING in progress ------------------------------------

Then you can build all the packages::

 make packages

Alternatively, you can build only for an specific os::

 make package_win
 make package_osx
 make package_snap
 make package_deb