From 5c0eb246d468454de9e84dca0d08c813459a5a6d Mon Sep 17 00:00:00 2001 From: kali Date: Wed, 19 Dec 2012 07:45:02 +0900 Subject: documentation update! reSTructured (no pun intended) the sphinx docs, and trimmed README --- docs/user/gpl.png | Bin 0 -> 3471 bytes docs/user/install.rst | 47 +++++++++++++++++++++++ docs/user/intro.rst | 101 ++++++++++++++++++++++++++++++++++++++++++++++++++ docs/user/running.rst | 40 ++++++++++++++++++++ 4 files changed, 188 insertions(+) create mode 100644 docs/user/gpl.png create mode 100644 docs/user/install.rst create mode 100644 docs/user/intro.rst create mode 100644 docs/user/running.rst (limited to 'docs/user') diff --git a/docs/user/gpl.png b/docs/user/gpl.png new file mode 100644 index 00000000..3e9136e6 Binary files /dev/null and b/docs/user/gpl.png differ diff --git a/docs/user/install.rst b/docs/user/install.rst new file mode 100644 index 00000000..22f88b12 --- /dev/null +++ b/docs/user/install.rst @@ -0,0 +1,47 @@ +.. _install: + +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. + +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. + + +Distribute & Pip +---------------- + +.. warning:: + + This does not work yet, since we have not released an initial version yet to the cheese shop. + +Installing LEAP Client will be as simple as using `pip `_ once we have a release candidate:: + + $ pip install leap-client + +Get the code +------------ + +.. 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 ` or :ref:`fetching latest code `. + +You can get the code from LEAP public git repository :: + + git clone git://leap.se/leap_client + +Or from the github mirror :: + + 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 new file mode 100644 index 00000000..fe983b63 --- /dev/null +++ b/docs/user/intro.rst @@ -0,0 +1,101 @@ +.. _introduction: + +Introduction +============ + +The LEAP Client +--------------- +.. if yoy change this, change it also in the index.rst +The **LEAP Client** is a :ref:`GPL3 Licensed ` multiplatform client, written in python using PyQt4, that supports the features offered by :ref:`the LEAP Platform `. Currently is being tested on Linux, support for OSX and Windows will come soon. + +Features +^^^^^^^^ + +The LEAP Client allows to easily secure communications. + +- Provider selection +- User registration +- Encrypted Internet Proxy support (autoconfigured service using openvpn). + +Coming soon +^^^^^^^^^^^^ + +- Encrypted email + +.. _leapplatform: + +The LEAP Platform +^^^^^^^^^^^^^^^^^ +The LEAP Provider Platform is the server-side part of LEAP that is run by service providers. It consists of a set of complementary packages and recipes to automate the maintenance of LEAP services in a hardened GNU/Linux environment. Our goal is to make it painless for service providers and ISPs to deploy a secure communications platform. + +Read `more about the LEAP Platform `_ or `check out the code `_. + + +.. _philosophy: + +Philosophy +---------- + +The Right to Whisper +^^^^^^^^^^^^^^^^^^^^ +LEAP fights for *the right to whisper*. + +Like free speech, the right to whisper is an necessary precondition for **a free society**. Without it, civil society and political freedom become impossible. As the importance of digital communication for civic participation increases, so does the importance of the ability to digitally whisper. + +Unfortunately, advances in surveillance technology are rapidly eroding the ability to whisper. This is a worldwide problem, not simply an issue for people in repressive contexts. Acceptance of poor security in the West creates a global standard of insecure practice, even among civil society actors who urgently need the ability to communicate safely. + +The stakes could not be higher. Activists are dying because their communication technologies betray their identity, location, and conversations. When activists attempt to secure their communications, they face confusing software, a dearth of secure providers, and a greater risk of being flagged as potential troublemakers. In other words, problems of usability, availability, and adoption. + +Our vision +^^^^^^^^^^ +The LEAP vision is to attack these problems of usability, availability, and adoption head on. + +To address **usability**: + we are creating a complete system where the user-facing client software is + tightly coupled with the cloud-base components of the system. All our software + will be auto-configuring, prevent users from practicing insecure behavior, and + primarily limit the configuration options to those moments when the user is placing i + their trust in another entity. + +To address **availability**: + LEAP will work closely with service providers to adopt our open source, automatedl + platform for running high-availability communication services. By lowering the + barriers of entry to become a reliable provider, we can increase the supply and + decrease the cost of secure communications. + +To address **adoption**: + the LEAP platform layers higher security on top of existing protocols to allow + users a gradual transition path and backward compatibility. Our goal is to create + services that are attractive in terms of features, usability, and price for users in + both democratic and repressive contexts. + +All contributions should have these three points in mind. + +.. _`gpl3`: + +GPLv3 License +------------ + +.. image:: gpl.* + +The LEAP Client is released under the terms of the `GNU GPL version 3`_ or later. + +:: + + The LEAP Client is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + The LEAP Client is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with the LEAP Client. If not, see http://www.gnu.org/licenses/. + +.. _`GNU GPL version 3`: http://www.gnu.org/licenses/gpl.txt + +.. ??? include whole version? + .. include:: ../COPYING diff --git a/docs/user/running.rst b/docs/user/running.rst new file mode 100644 index 00000000..35ec1f6d --- /dev/null +++ b/docs/user/running.rst @@ -0,0 +1,40 @@ +.. _running: + +Running +================== + +This document dovers 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:: + + % leap-client + + +.. _debugmode: + +Debug mode +---------- +If you are happy having lots of output in your terminal, you will like to know that you can run the client in debug mode:: + + $ leap-client --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:: + + $ 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. + See bug #1232 + +If you want to increment the level of verbosity passed to openvpn, you can do:: + + + $ leap-client --openvpn-verbosity 4 + +Options +------------ +To see all the available command line options:: + + $ leap-client --help -- cgit v1.2.3 From 06bccc52c84a93407ab4699a2749b24f55fe3061 Mon Sep 17 00:00:00 2001 From: kali Date: Thu, 20 Dec 2012 08:19:55 +0900 Subject: working transifex workflow Closes #666 --- docs/user/install.rst | 2 +- docs/user/intro.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/user') diff --git a/docs/user/install.rst b/docs/user/install.rst index 22f88b12..1f0fd831 100644 --- a/docs/user/install.rst +++ b/docs/user/install.rst @@ -32,7 +32,7 @@ Get the code .. 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 ` or :ref:`fetching latest code `. + 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 ` or :ref:`fetching latest code for testing `. You can get the code from LEAP public git repository :: diff --git a/docs/user/intro.rst b/docs/user/intro.rst index fe983b63..abb6d487 100644 --- a/docs/user/intro.rst +++ b/docs/user/intro.rst @@ -74,7 +74,7 @@ All contributions should have these three points in mind. .. _`gpl3`: GPLv3 License ------------- +-------------- .. image:: gpl.* -- cgit v1.2.3