From dfefa92d31b36f4478acb07e14e3a239016e32af Mon Sep 17 00:00:00 2001 From: Micah Anderson Date: Mon, 11 Aug 2014 11:08:22 -0400 Subject: fix minor spelling error --- docs/platform/development.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platform/development.md b/docs/platform/development.md index 57c296d..f6c47a6 100644 --- a/docs/platform/development.md +++ b/docs/platform/development.md @@ -212,7 +212,7 @@ Please consult the known issues for vagrant, see the [Known Issues](known-issues Other useful plugins ==================== -. The vagranr-cachier (plugin http://fgrehm.viewdocs.io/vagrant-cachier/) lets you cache .deb packages on your hosts so they are not downloaded by multiple machines over and over again, after resetting to a previous state. +. The vagrant-cachier (plugin http://fgrehm.viewdocs.io/vagrant-cachier/) lets you cache .deb packages on your hosts so they are not downloaded by multiple machines over and over again, after resetting to a previous state. Troubleshooting Vagrant ======================= -- cgit v1.2.3 From 8567eb735b07cc7d3f119e0396f45211744d5dd6 Mon Sep 17 00:00:00 2001 From: Johan Nilsson Date: Fri, 15 Aug 2014 09:39:36 +0200 Subject: The screencasts disappeared. shelr.tv is down. --- docs/platform/quick-start.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/platform/quick-start.md b/docs/platform/quick-start.md index 9bebe3e..474d25c 100644 --- a/docs/platform/quick-start.md +++ b/docs/platform/quick-start.md @@ -5,7 +5,6 @@ Quick Start =========== This tutorial walks you through the initial process of creating and deploying a minimal service provider running the [LEAP platform](platform). This Quick Start guide will guide you through building a three node OpenVPN provider. -If you are curious how this will look like without trying it out yourself, you can watch our [recorded screencasts](http://shelr.tv/users/524415e69660807910000021). Our goal ------------------ -- cgit v1.2.3 From b5c949c93c63206342ff8efadf3879b9d5f978ba Mon Sep 17 00:00:00 2001 From: Ivan Alejandro Date: Fri, 15 Aug 2014 16:11:45 -0300 Subject: Move automagic method to top. Add the new commands for the bootstrap_develop script, Add an explanation to install the `bitmask-root` file, Split in automatic/manual sections and move automatic to the top. --- docs/client/dev-environment.md | 75 ++++++++++++++++++++++++++---------------- 1 file changed, 46 insertions(+), 29 deletions(-) diff --git a/docs/client/dev-environment.md b/docs/client/dev-environment.md index 7ef8245..4db0fb3 100644 --- a/docs/client/dev-environment.md +++ b/docs/client/dev-environment.md @@ -1,14 +1,43 @@ @nav_title = 'Hacking' @title = 'Setting up a development environment' -Setting up a development environment -==================================== +Quick start +=========== -This document covers how to get an environment ready to contribute code -to Bitmask. +This document will guide you to get an environment ready to contribute code to +Bitmask. -Cloning the repo ----------------- +Using an automagic script +========================= + +You can use a helper script that will get you started with bitmask and all the +related repos. + +1. download automagic script +2. run it :) + +Commands so you can copy/paste: + + $ mkdir bitmask && cd bitmask + $ wget https://raw.githubusercontent.com/leapcode/bitmask_client/develop/pkg/scripts/bootstrap_develop.sh + $ chmod +x bootstrap_develop.sh + $ ./bootstrap_develop.sh help # check out the options :) + $ ./bootstrap_develop.sh deps # requires sudo + $ ./bootstrap_develop.sh init ro + $ ./bootstrap_develop.sh helpers # requires sudo + $ ./bootstrap_develop.sh run + +This script allows you to get started, update and run the bitmask app with all +its repositories. + +Note: the `deps` option is meant to be used in a Debian based Linux distro. + + +Doing the work manually +======================= + +Clone the repo +-------------- > **note** > @@ -18,8 +47,8 @@ Cloning the repo git clone https://leap.se/git/bitmask_client git checkout develop -Dependencies ------------- +Install Dependencies +-------------------- Bitmask depends on these libraries: @@ -147,6 +176,15 @@ copy this file by hand: $ sudo cp pkg/linux/polkit/se.leap.bitmask.policy /usr/share/polkit-1/actions/ +Installing the bitmask EIP helper +--------------------------------- + +In linux, we have a `openvpn` and `firewall` helper that is needed to run EIP. +You need to manually copy it from `bitmask_client/pkg/linux/bitmask-root`. +Use the following command to do so: + + $ sudo cp bitmask_client/pkg/linux/bitmask-root /usr/sbin/ + Running! -------- @@ -156,24 +194,3 @@ If everything went well, you should be able to run your client by invoking output, try the debug mode: (bitmask)$ bitmask --debug - - -Using automagic helper script ------------------------------ - -You can use a helper script that will get you started with bitmask and all the related repos. - -1. install system dependencies -2. download automagic script -3. run it :) - -Commands so you can copy/paste: - - $ mkdir bitmask && cd bitmask - $ wget https://raw.githubusercontent.com/leapcode/bitmask_client/develop/pkg/scripts/bootstrap_develop.sh - $ chmod +x bootstrap_develop.sh - $ ./bootstrap_develop.sh init # use help parameter for more information - -This script allows you to get started, update and run the bitmask app with all its repositories. - -Note: you need to copy the polkit file manually. -- cgit v1.2.3 From 2353a2785766e1d7b4b58f9f2880cc7d98691a1e Mon Sep 17 00:00:00 2001 From: Ivan Alejandro Date: Wed, 20 Aug 2014 16:40:53 -0300 Subject: Add --always-unzip option to avoid import errors. --- docs/client/dev-environment.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/client/dev-environment.md b/docs/client/dev-environment.md index 4db0fb3..b41e7af 100644 --- a/docs/client/dev-environment.md +++ b/docs/client/dev-environment.md @@ -146,12 +146,16 @@ site-packages to your working directory. In this way, your changes will always be in the installation path without need to install the package you are working on.:: - (bitmask)$ python2 setup.py develop + (bitmask)$ python2 setup.py develop --always-unzip After this step, your Bitmask launcher will be located at `~/Virtualenvs/bitmask/bin/bitmask`, and it will be in the path as long as you have sourced your virtualenv. +Note: the `--always-unzip` option prevents some dependencies to be installed in +a zip/egg, which causes some issues with libraries like 'scrypt' that needs to +access to the files directly from the filesystem. + Compile Qt resources -------------------- -- cgit v1.2.3