diff options
author | kali kaneko (leap communications) <kali@leap.se> | 2020-09-30 14:37:50 +0200 |
---|---|---|
committer | Ruben Pollan <meskio@sindominio.net> | 2020-10-13 19:08:28 +0200 |
commit | 6a1c90a260c44cb27ba14a70cc5dd23189822832 (patch) | |
tree | d7634e0c105b5a8686ac2f47ba5fb57ed4725601 /branding/README.rst | |
parent | d641b7a63e2b2dab56c7da3bb3b6e6bcd3daefd4 (diff) |
[feat] make vendor_init to create independent repo
this starts a stub for refactoring the authentication process, leading
to keep an external repo.
Diffstat (limited to 'branding/README.rst')
-rw-r--r-- | branding/README.rst | 30 |
1 files changed, 22 insertions, 8 deletions
diff --git a/branding/README.rst b/branding/README.rst index 7f2f16a..108ba5e 100644 --- a/branding/README.rst +++ b/branding/README.rst @@ -1,4 +1,4 @@ -Branding for BitmaskVPN +BitmaskVPN Branding Procedure ================================================================================ This folder contains everything that is needed to generate a customized built of @@ -8,9 +8,21 @@ the Desktop BitmaskVPN app for a given provider. Configure -------------------------------------------------------------------------------- -* Copy or edit the file at 'branding/config/vendor.conf'. Add all the needed variables. -* Copy your provider CA certificate to the same folder: 'branding/config/<provider>-ca.crt' -* Make sure that the folder 'branding/assets/<provider>' exists. Copy there all the needed assets. +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 -------------------------------------------------------------------------------- @@ -29,14 +41,16 @@ before the build. If you want to skip this check, pass `SKIP_CACHECK=yes` Run:: - PROVIDER=example make vendor + export VENDOR_PATH=../leapvpn-myprovider-pkg + make vendor + make prepare Then you can build the binary:: - ./build.sh - + make build -* The following does not work yet! in progress ------------------ +* FIXME: the following does not work yet --------------------- + REFACTORING in progress ------------------------------------ Then you can build all the packages:: |