diff options
Diffstat (limited to 'pages/docs/client')
| -rw-r--r-- | pages/docs/client/bundle-testing.md | 19 | ||||
| -rw-r--r-- | pages/docs/client/en.md | 28 | ||||
| -rw-r--r-- | pages/docs/client/known-issues.md | 124 |
3 files changed, 92 insertions, 79 deletions
diff --git a/pages/docs/client/bundle-testing.md b/pages/docs/client/bundle-testing.md index e5f0217..aa61889 100644 --- a/pages/docs/client/bundle-testing.md +++ b/pages/docs/client/bundle-testing.md @@ -14,6 +14,25 @@ For each system that you are going to test, you should do: The OS should be installed with the default settings and no extra packages. However, you can choose your language, username, timezone, etc +Testing +------- + +* Setup Instructions: https://bitmask.net/help + +* Fresh install (stable): https://dl.bitmask.net/client/linux/stable/ + +* Fresh install (release candidate): https://dl.bitmask.net/client/linux/release-candidate/ + +* Upgrading from bundle: if you are running bundle version 0.7 or new then + Bitmask should update automatically. + +* Upgrading from package: if you have added deb.bitmask.net to your + sources.list, then Bitmask should update automatically (make sure it is not + commented out). + +Note: If you have a bundle version older than 0.7, please reinstall Bitmask. + +Some notes on how to test: https://github.com/leapcode/bitmask_client/blob/develop/docs/testing-rcs.README Test process ------------ diff --git a/pages/docs/client/en.md b/pages/docs/client/en.md index b03c387..89d9110 100644 --- a/pages/docs/client/en.md +++ b/pages/docs/client/en.md @@ -2,23 +2,17 @@ @title = 'Bitmask' @summary = "The Internet Encryption Toolkit: Encrypted Internet Proxy and Encrypted Mail" -**Bitmask** is the multiplatform desktop client for the services offered by -[[the LEAP Platform => platform]]. For more information, see [[bitmask.net => -https://bitmask.net]]. +**Bitmask** is the multiplatform desktop client for the services offered [[the +LEAP Platform => platform]]. It is written in +[Python](https://www.python.org/) using [PySide](https://wiki.qt.io/PySide) and +licensed under the +[GPL3](https://github.com/leapcode/bitmask_client/blob/develop/LICENSE). +Currently we distribute pre-compiled bundles for Linux, with OS X and Windows +bundles following soon. -It is written in python using [PySide](http://qt-project.org/wiki/PySide) and -licensed under the GPL3. Currently we distribute pre-compiled bundles for Linux -and OSX, with Windows bundles following soon. - -We include below some sections of the user guide and the development -documentation so you can get started. - - -User Guide ----------- - -For installation docs see the [Bitmask website](https://bitmask.net/en/install) +For more info and a users guide goto [[bitmask.net => https://bitmask.net]]. +Testers and Hackers see below. Testers Guide ------------- @@ -51,7 +45,7 @@ We currently support: ### Using the debian package -* Ubuntu 14.04 (Trusty Tahr) * Ubuntu 15.04 (Vivid Vervet) -* Debian 7.0 (Wheezy) +* Ubuntu 15.10 (Wily Werewolf) * Debian 8.0 (Jessie) +* Debian unstable (Sid) diff --git a/pages/docs/client/known-issues.md b/pages/docs/client/known-issues.md index b5f6edc..3e86b97 100644 --- a/pages/docs/client/known-issues.md +++ b/pages/docs/client/known-issues.md @@ -6,97 +6,97 @@ Here you can find documentation about known issues and potential work-arounds in the current Bitmask release. -No polkit agent available -------------------------- -To run Bitmask and the services correctly you need to have a running polkit -agent. If you don't have one you will get an error and won't be able to start -Bitmask. +Connection Errors +----------------- -The currently recognized polkit agents are: +You may get the error: “Unable to connect: Problem with provider”. This can +result from a problem with your network not the the provider. We are tracking +this issue here https://leap.se/code/issues/4023 and plan to have more specific +error notifications in the future. -| process name | Who uses it? | -|---------------------------------------|-----------------------------------| -| `polkit-gnome-authentication-agent-1` | Gnome | -| `polkit-kde-authentication-agent-1` | KDE | -| `polkit-mate-authentication-agent-1` | Mate | -| `lxpolkit` or `lxsession` | LXDE | -| `xfce-polkit` | XFCE | -| `gnome-shell` | Gnome shell | -| `fingerprint-polkit-agent` | the `fingerprint-gui` package | +Mail issues +----------- -If you have a different polkit agent running that it's not in that list, -please report a bug so we can include in our checks. +* If you have received a large amount of mails (testing with more than 400), +Thunderbird may not respond. This problem wont happen if you already had the +client open and Thunderbird loading mails at the same time. -You can get the list of running processes that match polkit with the following -command: `ps aux | grep -i polkit`. -Here is an example on my KDE desktop: +* Opening the same account from more than one computer at the same time might +possibly break your account. - ➜ ps aux | grep polkit - root 1392 0.0 0.0 298972 6120 ? Sl Sep22 0:02 /usr/lib/policykit-1/polkitd --no-debug - user 1702 0.0 0.0 12972 920 pts/16 S+ 16:42 0:00 grep polkit - user 3259 0.0 0.4 559764 38464 ? Sl Sep22 0:05 /usr/lib/kde4/libexec/polkit-kde-authentication-agent-1 +* You may get an error on Thunderbird about not being able to reach the IMAP +server. This happens during long syncs. +* If you have a big amount of emails and email traffic the syncs are +sometimes very slow. We are working on this. -Note that `polkitd` is not a valid agent, is just the daemon, you still need an -agent running. -Other Issues ------------- +Key generation too slow? +------------------------ -- 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 +When you create a new mail account, the key generation may take a while. It can +take up to 5mins, but be aware, on virtual machines it sometimes takes a very +long time. As long as a 40min!. The below tricks can reduce the time for +testers using virtual machines. -Mail issues -=========== +If you are just testing mail accounts and **are not worried about security** +you can use some tricks to generate the extra entropy needed to speed up the +process. -Note that email is not stable yet so this list may not be accurate. +1. Manually generate entropy by moving the mouse, type stuff, browse the internet and local files, etc. -- If you have received a big amount of mails (tested with more than 400), you - may experience that Thunderbird won't respond. +1. Use haveged -That problem does not happen if you have the client open and Thunderbird -loading mails while are reaching your inbox. + Install the haveged package, most likely is available through your distro's + package manager. + See: http://www.issihosts.com/haveged/ -- Opening the same account from more than one box at the same time will - possibly break your account. +1. Generate IO (may not work on SSDs) -- You may get an error on Thunderbird about not being able to reach the IMAP - server. This happens during long syncs. + find / -type f -print0 2>&1 | xargs -0 cat &> /dev/null -- If you have a big amount of emails and email traffic the syncs may be very - slow and your account will be most of the time syncing. +If you want more information you can take a look at: +https://leap.se/code/issues/4656 -Key generation too slow? ------------------------- +"No polkit agent available" Error +--------------------------------- -When you create a new mail account, the key generation may take a while. While -it is normal that takes approx. 5mins, on virtual machines sometimes takes a -very long time. As long as a 40min!. -Using one of this tricks/hacks that time can be reduced to <5min. +(For people using minimal distros/desktops like awesome/i3) -If you are just testing mail accounts and **do not worry about security** you can -use some tricks to generate the extra entropy needed to speed up the process. +To run Bitmask and the services correctly you need to have a running polkit +agent. If you don’t have one you will get an error and won’t be able to start +Bitmask. -1. Manually generate entropy +The currently recognized polkit agents are: - Move the mouse, type stuff, browse the internet and local files, etc. +| process name | Who uses it? | +|---------------------------------------|-----------------------------------| +| `polkit-gnome-authentication-agent-1` | Gnome | +| `polkit-kde-authentication-agent-1` | KDE | +| `polkit-mate-authentication-agent-1` | Mate | +| `lxpolkit` or `lxsession` | LXDE | +| `xfce-polkit` | XFCE | +| `gnome-shell` | Gnome shell | +| `fingerprint-polkit-agent` | the `fingerprint-gui` package | -1. Use haveged - Install the haveged package, most likely is available through your distro's - package manager. +If you have a different polkit agent running that it's not in that list, +please report a bug so we can include in our checks. - See: http://www.issihosts.com/haveged/ +You can get the list of running processes that match polkit with the following +command: `ps aux | grep -i polkit`. +Here is an example on my KDE desktop: -1. Generate IO (may not work on SSDs) + ➜ ps aux | grep polkit + root 1392 0.0 0.0 298972 6120 ? Sl Sep22 0:02 /usr/lib/policykit-1/polkitd --no-debug + user 1702 0.0 0.0 12972 920 pts/16 S+ 16:42 0:00 grep polkit + user 3259 0.0 0.4 559764 38464 ? Sl Sep22 0:05 /usr/lib/kde4/libexec/polkit-kde-authentication-agent-1 - find / -type f -print0 2>&1 | xargs -0 cat &> /dev/null -If you want more information you can take a look at: -https://leap.se/code/issues/4656 +Note that `polkitd` is not a valid agent, is just the daemon, you still need an +agent running. |