diff options
Diffstat (limited to 'docs/client')
| -rw-r--r-- | docs/client/bundle-testing.md | 101 | ||||
| -rw-r--r-- | docs/client/en.md | 20 | ||||
| -rw-r--r-- | docs/client/known-issues.md | 30 | ||||
| -rw-r--r-- | docs/client/user-install.md | 28 |
4 files changed, 162 insertions, 17 deletions
diff --git a/docs/client/bundle-testing.md b/docs/client/bundle-testing.md new file mode 100644 index 0000000..69e01b9 --- /dev/null +++ b/docs/client/bundle-testing.md @@ -0,0 +1,101 @@ +@nav_title = "Bundle QA" +@title = "Guidelines for bundle QA" + +Recommended setup +----------------- + +VirtualBox (or similar) with virtual machines installed for supported OSs + +For each system that you are going to test, you should do: + +- Install the VM +- Restart the VM and check that the process is finished. +- Turn it off and make a snapshot named 'fresh install' or similar. + +The OS should be installed with the default settings and no extra packages. However, you can choose your language, username, timezone, etc + + +Test process +------------ + +- roll back the virtual machine to its *fresh install* state, to make sure that you're testing against a reproducible environment. +- download the bundle, verify signature (if apply), extract and run the app +- test the application (see next section) + + +Tests to do +----------- + +- **check if the version number is the same as the current bundle version** + - 'Help->About Bitmask' + - `./bitmask --version` +- **correct installation of files to 'better protect privacy'** + - `/etc/leap/resolv-update` + - `/usr/share/polkit-1/actions/net.openvpn.gui.leap.policy` + + You should check that they get copied when the user says 'yes' and they don't get copied if the user says 'no'. +- **installation of tun/tap in Windows and MAC** + TODO: explain more here + +- **account creation** + + Recommended username template: test_bundleversion_os_arch, that way you avoid conflicts between test iterations. + e.g.: 'test_036_debian7_64', 'test_036_win7_32', etc + + If you need to create extra users in order to test a bug or whatever, you can use 'test_036_ubuntu1204_32a', 'test_036_ubuntu1204_32b', etc + + In case of being a lot of users testing a version you may want to use your username instead of test, e.g.: 'johndoe_036_ubuntu1204_32'. +- **eip connection** + + You can check if the vpn is working entering to the site: http://wtfismyip.com + + or using the console: + `shell> wget -qO- wtfismyip.com/json` +- **Soledad key generation** +- **Thunderbird configuration manually and using add-on** +- **Send and receive mail** + + You need to test communication between inside and outside users, e.g.: someuser@bitmask.net and otheruser@gmail.com + + A good thing to do is to subscribe to a mailing list that have a lot of activity. + +- **Check if the account data is correctly synced.** + + After the account creation, have everything working and the app closed: + - remove the configuration files created by the app (`~/.config/leap` in linux) + - log in with your recently created credentials and check that everything is working and your mails are there too. + + +Problems report +--------------- + +You should to create an issue with the followinw information: + +- OS, version, architecture, desktop environment (if relevant). +- bitmask.log file located in the root folder of the uncompressed bundle +- steps to reproduce + +If you find a problem, try to reproduce and take note of the steps needed to get the same error. + +Also, in some cases, a failure appears but if you run again is not there anymore (e.g.: some initialization issue), please report that too. + +For more details look at [Reporting bugs](client/testers-howto) section. + + +Utils +----- + +Download, extract and run helper script for linux: + + shell> ./download-extract-run-bitmask.sh + +Script contents: + + #!/bin/bash + HOST="https://downloads.leap.se/client/linux/" + VERSION="0.3.7" + # FOLDER="Bitmask-linux32-${VERSION}" + FOLDER="Bitmask-linux64-${VERSION}" + FILE="${FOLDER}.tar.bz2" + + wget ${HOST}${FILE} && tar xjf ${FILE} && cd ${FOLDER} && ./bitmask diff --git a/docs/client/en.md b/docs/client/en.md index 3bfe3f1..0436ec2 100644 --- a/docs/client/en.md +++ b/docs/client/en.md @@ -19,7 +19,7 @@ User Guide ---------- * [Installing Bitmask](client/user-install) * [Running Bitmask](client/user-running) - + Tester Guide ------------ @@ -27,7 +27,7 @@ This part of the documentation details how to fetch the last development version and how to report bugs. * [Howto for testers](client/testers-howto) - + Hackers Guide ------------- @@ -35,9 +35,23 @@ If you want to contribute to the project, we wrote this for you. * [Setting up a development environment](client/dev-environment) - + <!-- * [Running latest code](client/bleeding-edge) * [Getting started with development](client/dev-guide) * [Configuration](client/configuration) * [Client API](client/client-api) --> + + +Supported OSs +------------- + +Currently supported OSs (32 and 64 bits) are: + +* Debian 7 (32bits lxde and 64 bits gnome3) +* Ubuntu 12.04 (LTS, unity) +* Ubuntu 13.10 (latest, unity) +* Mac OSX >= 10.8 +* Windows 7 (32 bits only) +* Windows 8 (planned) + diff --git a/docs/client/known-issues.md b/docs/client/known-issues.md new file mode 100644 index 0000000..04b8070 --- /dev/null +++ b/docs/client/known-issues.md @@ -0,0 +1,30 @@ +@title = 'Bitmask known issues' +@nav_title = 'Known issues' +@summary = 'Known issues in Bitmask.' +@toc = true + +Here you can find documentation about known issues and potential work-arounds in the current Leap Platform release. + +0.5 +=== + +In this release the following issues are known, work-arounds are noted when available. + +General Issues +-------------- + +- If you have received a big ammount of mails (tested with more than 400), you may experience that Thunderbird won't respond. + +That problem does not happen if you have the client open and Thunderbird loading mails while are reaching your inbox. + +- You may get the error: "Unable to connect: Problem with provider" in situations when the problem is the network instead of the provider. (see: https://leap.se/code/issues/4023) + +- Opening the same account from more than one box at the same time will possibly break your account. + +- Managing a huge ammount of mails (e.g.: moving mails to a folder) will block the UI (see https://leap.se/code/issues/4837) + +Special Environments +-------------------- + +- You may experience problems related to an Unavailable polkit agent in gnome3. (see https://leap.se/code/issues/4144) + diff --git a/docs/client/user-install.md b/docs/client/user-install.md index 77e9b1a..e29d63e 100644 --- a/docs/client/user-install.md +++ b/docs/client/user-install.md @@ -47,15 +47,8 @@ For the signature verification you can use : Asuming that you downloaded the linux 64 bits bundle. -Debian package --------------- - -> **warning** -> -> The debian package that you can currently find in the leap -> repositories is from the stable, 0.2.0 release, which is now outdated. -> You are encouraged to install the development version or the -> standalone bundles while we upload the newest packages. +Debian / Ubuntu packages +------------------------ First, you need to bootstrap your apt-key: @@ -64,9 +57,11 @@ First, you need to bootstrap your apt-key: # gpg --list-sigs 0x485B12FA218E81EB # gpg -a --export 0x1E34A1828E207901 | sudo apt-key add - -Add the archive to your sources.list: +Add the archive to your sources.list, replace <suite> below with your Debian or +Ubuntu suite, which you can find by typing 'lsb_release -c' in a terminal. +Currently the following are available: sid, jessie, trusty, saucy, raring, quantal - # echo "deb http://deb.leap.se/debian unstable main" >> /etc/apt/sources.list + # echo "deb http://deb.leap.se/debian <suite> main" >> /etc/apt/sources.list # apt-get update # apt-get install leap-keyring @@ -105,10 +100,15 @@ Or from the github mirror : $ git clone https://github.com/leapcode/bitmask_client.git Once you have grabbed a copy of the sources, and installed all the base -dependencies, you can install it into your site-packages easily : +dependencies, the recommended way to proceed is to install things in a virtualenv. + + $ virtualenv bitmask && source bitmask/bin/activate + $ make # compile the resources + $ python2 setup.py install + +Or you can install it into your global site-packages easily : $ make # compile the resources $ sudo python2 setup.py install -Although, like always, it is a better idea to install things in a -virtualenv. +WARNING: installing a package in the global site-packages can be harmful because the dependency installation can overwrite some of the existing packages. |