From dca30766421cc692726c61fe2d502ae263e6121b Mon Sep 17 00:00:00 2001 From: kali Date: Thu, 11 Oct 2012 09:03:51 +0900 Subject: added NEWS.rst and removed notes from README.rst --- CHANGES.txt | 1 - NEWS.rst | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 16 +++++++------- 3 files changed, 76 insertions(+), 10 deletions(-) delete mode 100644 CHANGES.txt create mode 100644 NEWS.rst diff --git a/CHANGES.txt b/CHANGES.txt deleted file mode 100644 index e92537c0..00000000 --- a/CHANGES.txt +++ /dev/null @@ -1 +0,0 @@ --- 0.1.0 initial release diff --git a/NEWS.rst b/NEWS.rst new file mode 100644 index 00000000..00350cbb --- /dev/null +++ b/NEWS.rst @@ -0,0 +1,69 @@ +================================== +User-facing changes in Leap Client +================================== + +Release 0.2.0 (2012-10-XX) +-------------------------- + +This release is a functionally working version in Debian Squeeze and Ubuntu 12.04. +It is able to connect to a preconfigured leap provider and autoconfigures a EIP connection. + +Python Support +'''''''''''''' +This release supports Python2.6 and Python2.7 + +New Features +'''''''''''' +- Branded build: the final package includes branding info needed to connect to a default provider. +- First run wizard: allows to register an user with the selected provider. It also downloads all + the config files needed to connect to the eip service on this provider. +- Network checks: we do some basic network testing and warn user in case we cannot find a + suitable network interface, or if the virtual interface dissapears after a successful eip connection. +- Debug mode and logfiles: the leap-client script allows to be invoked with the --debug flag. + It also accepts a --logfile option that is useful for documenting bug reports. + +Dependencies +'''''''''''' +See the ``README.rst`` for a step-to-step install guide. + +The following libraries are needed: + +- PyQt4 +- libgnutls +- openvpn + +for building the package dependencies, you will need also: + +- python-setuptools +- python-dev +- libgnutls-dev + +Leap-Client depends on the following python packages: + +- requests +- ping +- psutil +- netifaces +- jsonschema +- srp +- pycrypto +- keyring +- python-gnutls==1.1.9 + +We are freezing the python-gnutls library dependency for this release due to a bug in ubuntu, see: +https://bugs.launchpad.net/ubuntu/+source/python-gnutls/+bug/1027129 + + +Configuration files +''''''''''''''''''' + +Config files are created under ``~/.config/leap`` +Currently user should be able to completely remove this folder and have it auto-generated in the first run. + +- Current eip service config is stored in ``eip.json`` +- Under ``.config/leap/providers``, there is a per-provider folder that contains: + - ``provider.json``, with all options for connecting to this provider. + - ``eip-service.json``, with eip-specific configuration options, + - ``keys/ca``, for a copy of the ca certificates used in the tls connections to provider. + - ``keys/client``, for a local copy of leap user certificates used in the eip connection. +- ``leap.conf`` for general application configurations (gui windows geometry, ...). diff --git a/README.rst b/README.rst index 50fa886d..d1f91c4b 100644 --- a/README.rst +++ b/README.rst @@ -30,25 +30,23 @@ Debian systems Under a debian-based system, you can run:: - apt-get install openvpn python-qt4 python-keyring python-crypto + # apt-get install openvpn python-qt4 python-keyring python-crypto For testing: python-nose python-mock python-coverage -For building the package you will need also:: +For _building_ the package you will need to install also:: pyqt4-dev-tools libgnutls-dev python-setuptools python-all-dev -# **note**: Some libs like setuptools are needed as build-deps only. -# TODO we probably should separate what's needed as a global lib dependency, and what's a dependency that still can be retrieved using pip. Install python dependencies with pip ------------------------------------- Use pip (preferrable inside a virtualenv) to install all the required python packages:: - apt-get install python-pip python-dev libgnutls-dev - pip install -r pkg/requirements.pip + # apt-get install python-pip python-dev libgnutls-dev + % pip install -r pkg/requirements.pip Install leap-client @@ -160,7 +158,7 @@ Tox --- For running testsuite against all the supported python versions (currently 2.6 and 2.7), run:: - tox -v + % tox -v Compiling resource/ui files @@ -168,7 +166,7 @@ Compiling resource/ui files You should refresh resource/ui files every time you change an image or a resource/ui (.ui / .qc). From the root folder:: - make ui - make resources + % make ui + % make resources As there are some tests to guard against unwanted resource updates, you will have to update the resource hash in those failing tests. -- cgit v1.2.3