diff options
| -rw-r--r-- | amber/menu.txt | 1 | ||||
| -rw-r--r-- | pages/docs/client/en.md | 29 | ||||
| -rw-r--r-- | pages/docs/client/known-issues.md | 24 | ||||
| -rw-r--r-- | pages/docs/client/user-install.md | 10 | ||||
| -rw-r--r-- | pages/docs/client/user-running.md | 42 |
5 files changed, 35 insertions, 71 deletions
diff --git a/amber/menu.txt b/amber/menu.txt index 83e0ff8..ebd2e42 100644 --- a/amber/menu.txt +++ b/amber/menu.txt @@ -64,7 +64,6 @@ docs under-the-hood client user-install - user-running testers-howto bundle-testing dev-environment diff --git a/pages/docs/client/en.md b/pages/docs/client/en.md index ff7c826..3341f62 100644 --- a/pages/docs/client/en.md +++ b/pages/docs/client/en.md @@ -2,22 +2,29 @@ @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 by +[[the LEAP Platform => platform]]. For more information, see [[bitmask.net => +https://bitmask.net]]. -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. +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. -We include below some sections of the user guide and the development documentation so you can get started. User Guide ---------- -* [[Installing Bitmask => user-install]] -* [[Running Bitmask => user-running]] +For installation docs see the [Bitmask website](https://bitmask.net/en/install) + Tester Guide ------------ -This part of the documentation details how to fetch the last development version and how to report bugs. +This part of the documentation details how to fetch the last development +version and how to report bugs. * [[HOWTO for testers => testers-howto]] @@ -29,13 +36,6 @@ If you want to contribute to the project, we wrote this for you. * [[Setting up a development environment => 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 ------------- @@ -43,10 +43,7 @@ We currently support: ### Through the bundle -* Debian 7 -* Ubuntu 12.04 (LTS) * Ubuntu 14.04 (LTS) -* Ubuntu 14.10 (latest) * Mac OSX >= 10.8 (coming very soon) * Note: It *should* work in other Debian based distros diff --git a/pages/docs/client/known-issues.md b/pages/docs/client/known-issues.md index 398ead3..b5f6edc 100644 --- a/pages/docs/client/known-issues.md +++ b/pages/docs/client/known-issues.md @@ -4,7 +4,7 @@ @toc = true Here you can find documentation about known issues and potential work-arounds -in the current Leap Platform release. +in the current Bitmask release. No polkit agent available ------------------------- @@ -20,12 +20,13 @@ The currently recognized polkit agents are: | `polkit-gnome-authentication-agent-1` | Gnome | | `polkit-kde-authentication-agent-1` | KDE | | `polkit-mate-authentication-agent-1` | Mate | -| `lxpolkit` | LXDE | +| `lxpolkit` or `lxsession` | LXDE | +| `xfce-polkit` | XFCE | | `gnome-shell` | Gnome shell | | `fingerprint-polkit-agent` | the `fingerprint-gui` package | -If you have a different polkit agent running that it's not in theat list, +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. You can get the list of running processes that match polkit with the following @@ -38,6 +39,10 @@ Here is an example on my KDE desktop: user 3259 0.0 0.4 559764 38464 ? Sl Sep22 0:05 /usr/lib/kde4/libexec/polkit-kde-authentication-agent-1 +Note that `polkitd` is not a valid agent, is just the daemon, you still need an +agent running. + + Other Issues ------------ @@ -46,11 +51,11 @@ Other Issues See: https://leap.se/code/issues/4023 Mail issues ------------ +=========== Note that email is not stable yet so this list may not be accurate. -- If you have received a big ammount of mails (tested with more than 400), you +- If you have received a big amount 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 @@ -60,12 +65,15 @@ loading mails while are reaching your inbox. - 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) +- 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 may be very + slow and your account will be most of the time syncing. Key generation too slow? -======================== +------------------------ 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 diff --git a/pages/docs/client/user-install.md b/pages/docs/client/user-install.md index 830c4ca..e00e53d 100644 --- a/pages/docs/client/user-install.md +++ b/pages/docs/client/user-install.md @@ -1,7 +1,9 @@ @nav_title = 'Installing' @title = 'Installing Bitmask' -For download links and installation instructions go to [[dl.bitmask.net => https://dl.bitmask.net/]]. +For download links and installation instructions go to [[bitmask.net website => +https://bitmask.net/en/install]]. + Distribute & Pip ---------------- @@ -28,7 +30,8 @@ After extensive testing and being fixed all blocking issues we release the **stable** bundle, what is meant for public consumption. This is the bundle that is linked for download from the [[bitmask.net => https://bitmask.net]] website. -You can find all the bundles at [[dl.bitmask.net/client => https://dl.bitmask.net/client/]]. +You can find all the bundles at [[bitmask.net => +https://bitmask.net/en/install/linux#install-stand-alone-bundle]]. Automatic upgrades ------------------ @@ -66,7 +69,7 @@ The repository url looks like: - **wheezy**, **jessy** and **sid** are the debian versions. More details on how to configure the repositories in your system in -https://dl.bitmask.net/linux/ +https://bitmask.net/en/install/linux#install-as-packages Show me the code! ----------------- @@ -81,4 +84,3 @@ Or from the github mirror : $ git clone https://github.com/leapcode/bitmask_client.git For more information go to the [[Hacking => client/dev-environment]] section :) - diff --git a/pages/docs/client/user-running.md b/pages/docs/client/user-running.md deleted file mode 100644 index 2fda469..0000000 --- a/pages/docs/client/user-running.md +++ /dev/null @@ -1,42 +0,0 @@ -@nav_title = 'Running' -@title = 'Running Bitmask' - -This document covers how to launch Bitmask. Also know as, where the -magic happens. - -Launching Bitmask ------------------ - -After a successful installation, there should be a launcher called -bitmask somewhere in your path: - - % bitmask - -The first time you launch it, it should launch the first run wizard that -will guide you through the mostly automatic configuration of the LEAP -Services. - -> **note** -> -> You will need to enter a valid test provider running the LEAP -> Platform. You can use the LEAP test service, *<https://bitmask.net>* - -Debug mode ----------- - -If you are happy having lots of output in your terminal, you will like -to know that you can run bitmask in debug mode: - - $ bitmask --debug - -If you ask for it, you can also have all that debug info in a beautiful -file ready to be attached to your bug reports: - - $ bitmask --debug --logfile /tmp/leap.log - -I want all the options! ------------------------ - -To see all the available command line options: - - $ bitmask --help |