diff options
Diffstat (limited to 'docs/user')
| -rw-r--r-- | docs/user/install.rst | 46 | ||||
| -rw-r--r-- | docs/user/intro.rst | 2 | ||||
| -rw-r--r-- | docs/user/running.rst | 20 |
3 files changed, 43 insertions, 25 deletions
diff --git a/docs/user/install.rst b/docs/user/install.rst index 1f0fd831..0467ba8b 100644 --- a/docs/user/install.rst +++ b/docs/user/install.rst @@ -6,42 +6,56 @@ Installation This part of the documentation covers the installation of the LEAP Client. We assume that you want to get it properly installed before being able to use it. -Debian package --------------- - -.. warning:: - - No updated debian package yet. +.. note:: -Once we have a release candidate, probably the easiest way of having the LEAP Client installed will be to install a .deb package under debian or ubuntu systems. + The recommended way of installing in the near future will be the standalone bundles, but those are not quite ready yet. Methods described in this page assume you are familiar with python code, and you can find your way through the process of dependencies install. You can refer to the sections :ref:`setting up a working environment <environment>` or :ref:`fetching latest code for testing <fetchinglatest>`. Distribute & Pip ---------------- -.. warning:: - - This does not work yet, since we have not released an initial version yet to the cheese shop. +.. warning:: The package in the cheese shop is from the stable, `0.2.0` release, which is now outdated. You are encouraged to install the development version instead. -Installing LEAP Client will be as simple as using `pip <http://www.pip-installer.org/>`_ once we have a release candidate:: +Installing LEAP Client is as simple as using `pip <http://www.pip-installer.org/>`_ for the already released versions :: $ pip install leap-client -Get the code ------------- +Debian package +-------------- .. warning:: - This... won't work either, as-is. This should be the third optional way to install stable releases from master branch. Right now that does not work because there is *nothing* updated in the master branch. Leaving this here since this is what we will be doing, but if you really intend to have a working tree, refer to the sections :ref:`setting up a working environment <environment>` or :ref:`fetching latest code for testing <fetchinglatest>`. + The debian package in the leap repositories is from the stable, `0.2.0` release, which is now outdated. You are encouraged to install the development version instead, + +First, you need to bootstrap your apt-key:: + + # gpg --recv-key 0x1E34A1828E207901 0x485B12FA218E81EB + # gpg --list-sigs 0x1E34A1828E207901 + # gpg --list-sigs 0x485B12FA218E81EB + # gpg -a --export 0x1E34A1828E207901 | sudo apt-key add - + +Add the archive to your sources.list:: + + # echo "deb http://deb.leap.se/debian unstable main" >> /etc/apt/sources.list + # apt-get update + # apt-get install leap-keyring + +And then you can happily install leap-client:: + + apt-get install leap-client + +Show me the code! +----------------- You can get the code from LEAP public git repository :: - git clone git://leap.se/leap_client + $ git clone git://leap.se/leap_client Or from the github mirror :: - git clone git://github.com/leapcode/leap_client.git + $ git clone git://github.com/leapcode/leap_client.git Once you have grabbed a copy of the sources, you can install it into your site-packages easily :: $ pyton setup.py install + diff --git a/docs/user/intro.rst b/docs/user/intro.rst index abb6d487..9461d5f2 100644 --- a/docs/user/intro.rst +++ b/docs/user/intro.rst @@ -6,7 +6,7 @@ Introduction The LEAP Client --------------- .. if yoy change this, change it also in the index.rst -The **LEAP Client** is a :ref:`GPL3 Licensed <gpl3>` multiplatform client, written in python using PyQt4, that supports the features offered by :ref:`the LEAP Platform <leapplatform>`. Currently is being tested on Linux, support for OSX and Windows will come soon. +The **LEAP Client** is a :ref:`GPL3 Licensed <gpl3>` multiplatform client, written in python using PySide, that supports the features offered by :ref:`the LEAP Platform <leapplatform>`. Currently is being tested on Linux, support for OSX and Windows will come soon. Features ^^^^^^^^ diff --git a/docs/user/running.rst b/docs/user/running.rst index 35ec1f6d..43f3e87c 100644 --- a/docs/user/running.rst +++ b/docs/user/running.rst @@ -3,14 +3,19 @@ Running ================== -This document dovers how to launch the LEAP Client. +This document covers how to launch the LEAP Client. Launching the client -------------------- -After a successful installation, there should be a launcher called leap-client somewhere in your path:: +After a successful installation, there should be a launcher called `leap-client` somewhere in your path:: % leap-client +The first time you launch it, it should launch the first run wizard that will guide you through the setup 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* .. _debugmode: @@ -24,14 +29,13 @@ If you ask for it, you can also have all that debug info in a beautiful file rea $ leap-client --debug --logfile /tmp/leap.log -.. warning:: - the following is broken since it will clutter your stdout with all the commands sent to the management interface. +.. warning +.. the following is broken since it will clutter your stdout with all the commands sent to the management interface. See bug #1232 -If you want to increment the level of verbosity passed to openvpn, you can do:: - - - $ leap-client --openvpn-verbosity 4 +.. not working... +.. If you want to increment the level of verbosity passed to openvpn, you can do:: +.. $ leap-client --openvpn-verbosity 4 Options ------------ |