From b9eed0c824651a67dca3ea68c646c6361f40f288 Mon Sep 17 00:00:00 2001 From: Ivan Alejandro Date: Wed, 7 Aug 2013 18:24:37 -0300 Subject: Replace leap client texts with Bitmask. --- pkg/osx/install/install-leapc.sh | 4 ++-- src/leap/app.py | 6 +++--- src/leap/gui/mainwindow.py | 24 +++++++++++++++--------- src/leap/gui/ui/mainwindow.ui | 4 ++-- src/leap/gui/ui/wizard.ui | 6 +++--- src/leap/platform_init/initializers.py | 6 +++--- src/leap/services/eip/vpnlaunchers.py | 4 ++-- src/leap/services/tx.py | 2 +- src/leap/util/leap_argparse.py | 6 +++--- 9 files changed, 34 insertions(+), 28 deletions(-) diff --git a/pkg/osx/install/install-leapc.sh b/pkg/osx/install/install-leapc.sh index ec3c2834..e47abb7c 100755 --- a/pkg/osx/install/install-leapc.sh +++ b/pkg/osx/install/install-leapc.sh @@ -1,6 +1,6 @@ #!/bin/bash -# LEAP CLient Installer Script. +# Bitmask Installer Script. # # Copyright (C) 2013 LEAP Encryption Access Project # @@ -20,7 +20,7 @@ leapdir=/Applications/LEAP\ Client.app leaplibs=${leapdir}/Contents/MacOS tunstartup=/Library/StartupItems/tun/tun -echo "Installing LEAP Client in /Applications..." +echo "Installing Bitmask in /Applications..." cp -r "LEAP Client.app" /Applications echo "Copying openvpn binary..." diff --git a/src/leap/app.py b/src/leap/app.py index e7a8aa42..22340d4d 100644 --- a/src/leap/app.py +++ b/src/leap/app.py @@ -148,16 +148,16 @@ def main(): replace_stdout_stderr_with_logging(logger) if not we_are_the_one_and_only(): - # leap-client is already running + # Bitmask is already running logger.warning("Tried to launch more than one instance " - "of leap-client. Raising the existing " + "of Bitmask. Raising the existing " "one instead.") sys.exit(1) check_requirements() logger.info('~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~') - logger.info('LEAP client version %s', VERSION) + logger.info('Bitmask version %s', VERSION) logger.info('~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~') logger.info('Starting app') diff --git a/src/leap/gui/mainwindow.py b/src/leap/gui/mainwindow.py index 5c7a3928..90492e45 100644 --- a/src/leap/gui/mainwindow.py +++ b/src/leap/gui/mainwindow.py @@ -83,7 +83,7 @@ class MainWindow(QtGui.QMainWindow): EIP_STATUS_INDEX = 1 # Keyring - KEYRING_KEY = "leap_client" + KEYRING_KEY = "bitmask" # SMTP PORT_KEY = "port" @@ -423,11 +423,11 @@ class MainWindow(QtGui.QMainWindow): Parses and displays the updates details """ - msg = self.tr("The LEAPClient app is ready to update, please" + msg = self.tr("The Bitmask app is ready to update, please" " restart the application.") # We assume that if there is nothing in the contents, then - # the LEAPClient bundle is what needs updating. + # the Bitmask bundle is what needs updating. if len(self._updates_content) > 0: files = self._updates_content.split(", ") files_str = "" @@ -655,17 +655,23 @@ class MainWindow(QtGui.QMainWindow): SLOT TRIGGERS: self.ui.action_about_leap.triggered - Display the About LEAP dialog + Display the About Bitmask dialog """ QtGui.QMessageBox.about( - self, self.tr("About LEAP - %s") % (VERSION,), - self.tr("version: %s
" + self, self.tr("About Bitmask - %s") % (VERSION,), + self.tr("Version: %s
" + "
" + "Bitmask is the Desktop client application for " + "the LEAP platform, supporting encrypted internet " + "proxy, secure email, and secure chat (coming soon).
" + "
" "LEAP is a non-profit dedicated to giving " "all internet users access to secure " "communication. Our focus is on adapting " "encryption technology to make it easy to use " - "and widely available. " - "More about LEAP" + "and widely available.
" + "
" + "
More about LEAP" "") % (VERSION,)) def changeEvent(self, e): @@ -1145,7 +1151,7 @@ class MainWindow(QtGui.QMainWindow): self._status_panel.set_global_status( self.tr("Another openvpn instance is already running, and " "could not be stopped because it was not launched by " - "LEAP. Please stop it and try again."), + "Bitmask. Please stop it and try again."), error=True) self._set_eipstatus_off() except VPNLauncherException as e: diff --git a/src/leap/gui/ui/mainwindow.ui b/src/leap/gui/ui/mainwindow.ui index 67d78736..c3523823 100644 --- a/src/leap/gui/ui/mainwindow.ui +++ b/src/leap/gui/ui/mainwindow.ui @@ -11,7 +11,7 @@ - LEAP + Bitmask @@ -288,7 +288,7 @@ - About &LEAP + About &Bitmask diff --git a/src/leap/gui/ui/wizard.ui b/src/leap/gui/ui/wizard.ui index d8acd69a..d7355d5d 100644 --- a/src/leap/gui/ui/wizard.ui +++ b/src/leap/gui/ui/wizard.ui @@ -11,7 +11,7 @@ - LEAP First run + Bitmask first run @@ -31,7 +31,7 @@ Welcome - This is the LEAP Client first run wizard + This is the Bitmask first run wizard 0 @@ -733,7 +733,7 @@ Congratulations! - You have successfully configured the LEAP Client. + You have successfully configured Bitmask. 6 diff --git a/src/leap/platform_init/initializers.py b/src/leap/platform_init/initializers.py index cc5f6e87..46488250 100644 --- a/src/leap/platform_init/initializers.py +++ b/src/leap/platform_init/initializers.py @@ -84,7 +84,7 @@ def get_missing_updown_dialog(): :rtype: QtGui.QMessageBox instance """ WE_NEED_POWERS = ("To better protect your privacy, " - "LEAP needs administrative privileges " + "Bitmask needs administrative privileges " "to install helper files. " "Do you want to proceed?") msg = QtGui.QMessageBox() @@ -180,7 +180,7 @@ def WindowsInitializer(): if not _windows_has_tap_device(): msg = QtGui.QMessageBox() msg.setWindowTitle(msg.tr("TAP Driver")) - msg.setText(msg.tr("LEAPClient needs to install the necessary drivers " + msg.setText(msg.tr("Bitmask needs to install the necessary drivers " "for Encrypted Internet to work. Would you like to " "proceed?")) msg.setInformativeText(msg.tr("Encrypted Internet uses VPN, which " @@ -306,7 +306,7 @@ def DarwinInitializer(): if not _darwin_has_tun_kext(): msg = QtGui.QMessageBox() msg.setWindowTitle(msg.tr("TUN Driver")) - msg.setText(msg.tr("LEAPClient needs to install the necessary drivers " + msg.setText(msg.tr("Bitmask needs to install the necessary drivers " "for Encrypted Internet to work. Would you like to " "proceed?")) msg.setInformativeText(msg.tr("Encrypted Internet uses VPN, which " diff --git a/src/leap/services/eip/vpnlaunchers.py b/src/leap/services/eip/vpnlaunchers.py index cbbd4de2..17950a25 100644 --- a/src/leap/services/eip/vpnlaunchers.py +++ b/src/leap/services/eip/vpnlaunchers.py @@ -520,9 +520,9 @@ class DarwinVPNLauncher(VPNLauncher): COCOASUDO = "cocoasudo" # XXX need the good old magic translate for these strings # (look for magic in 0.2.0 release) - SUDO_MSG = ("LEAP needs administrative privileges to run " + SUDO_MSG = ("Bitmask needs administrative privileges to run " "Encrypted Internet.") - INSTALL_MSG = ("\"LEAP needs administrative privileges to install " + INSTALL_MSG = ("\"Bitmask needs administrative privileges to install " "missing scripts and fix permissions.\"") INSTALL_PATH = os.path.realpath(os.getcwd() + "/../../") diff --git a/src/leap/services/tx.py b/src/leap/services/tx.py index ef08fcc6..7da1cb01 100644 --- a/src/leap/services/tx.py +++ b/src/leap/services/tx.py @@ -40,7 +40,7 @@ def leap_services(): register them. """ logger.debug('starting leap services') - application = Application("LEAP Client Local Services") + application = Application("Bitmask Local Services") #lc = LoopingCall(task) #lc.start(5) return application diff --git a/src/leap/util/leap_argparse.py b/src/leap/util/leap_argparse.py index bdf80401..f60c4e10 100644 --- a/src/leap/util/leap_argparse.py +++ b/src/leap/util/leap_argparse.py @@ -27,9 +27,9 @@ def build_parser(): """ epilog = "Copyright 2012 The LEAP Encryption Access Project" parser = argparse.ArgumentParser(description=""" -Launches the LEAP Client""", epilog=epilog) +Launches Bitmask""", epilog=epilog) parser.add_argument('-d', '--debug', action="store_true", - help=("Launches client in debug mode, writing debug" + help=("Launches Bitmask in debug mode, writing debug" "info to stdout")) # TODO: when we are ready to disable the --danger flag remove 'True or ' if True or not IS_RELEASE_VERSION: @@ -45,7 +45,7 @@ Launches the LEAP Client""", epilog=epilog) action="store", dest="openvpn_verb", help='verbosity level for openvpn logs [1-6]') parser.add_argument('-s', '--standalone', action="store_true", - help='Makes the client use standalone' + help='Makes Bitmask use standalone' 'directories for configuration and binary' 'searching') -- cgit v1.2.3 From 8ad62f8d8880db9d416f8a60ec5e1e7f69136418 Mon Sep 17 00:00:00 2001 From: Ivan Alejandro Date: Wed, 7 Aug 2013 18:54:04 -0300 Subject: Update README and packaging names. --- README.rst | 36 ++++++++++++++++++------------------ setup.py | 10 +++++----- 2 files changed, 23 insertions(+), 23 deletions(-) diff --git a/README.rst b/README.rst index 7b4924ab..d5d6c946 100644 --- a/README.rst +++ b/README.rst @@ -3,13 +3,13 @@ The LEAP Encryption Access Project Client *your internet encryption toolkit* -.. image:: https://pypip.in/v/leap-client/badge.png - :target: https://crate.io/packages/leap.client +.. image:: https://pypip.in/v/bitmask/badge.png + :target: https://crate.io/packages/bitmask Dependencies ------------------ -LEAP Client depends on these libraries: +Bitmask depends on these libraries: * ``python 2.6`` or ``2.7`` * ``qt4 libraries`` @@ -21,14 +21,14 @@ Python packages are listed in ``pkg/requirements.pip`` and ``pkg/test-requiremen Debian ^^^^^^ -With a Debian based system, to be able to run leap-client you need to run the following command:: +With a Debian based system, to be able to run Bitmask you need to run the following command:: $ sudo apt-get install openvpn python-pyside pyside-tools python-setuptools python-all-dev python-pip python-dev python-openssl Installing ----------- -After getting the source and installing all the dependencies, proceed to install ``leap-client`` package:: +After getting the source and installing all the dependencies, proceed to install ``bitmask`` package:: $ make $ sudo LEAP_VENV_SKIP_PYSIDE=1 python setup.py install @@ -36,13 +36,13 @@ After getting the source and installing all the dependencies, proceed to install Running ------- -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 ``bitmask`` somewhere in your path:: - $ leap-client + $ bitmask -If you are testing a new provider and do not have a CA certificate chain tied to your SSL certificate, you should execute leap-client in the following way:: +If you are testing a new provider and do not have a CA certificate chain tied to your SSL certificate, you should execute Bitmask in the following way:: - $ leap-client --danger + $ bitmask --danger But **DO NOT use it on a regular bases**. @@ -53,9 +53,9 @@ But **DO NOT use it on a regular bases**. Hacking ======= -The LEAP client git repository is available at:: +The Bitmask git repository is available at:: - git://leap.se/leap_client + git://leap.se/bitmask Some steps need to be run when setting a development environment for the first time. @@ -66,19 +66,19 @@ Enable a **virtualenv** to isolate your libraries. (Current *.gitignore* knows a Make sure you are in the development branch:: - (leap_client)$ git checkout develop + (bitmask)$ git checkout develop Symlink your global pyside libraries:: - (leap_client)$ pkg/postmkvenv.sh + (bitmask)$ pkg/postmkvenv.sh And make your working tree available to your pythonpath:: - (leap_client)$ python setup.py develop + (bitmask)$ python setup.py develop -Run the client:: +Run Bitmask:: - (leap_client)$ python src/leap/app.py -d + (bitmask)$ python src/leap/app.py -d If you are testing a new provider that doesn't have the proper certificates yet, you can use --danger flag, but **DO NOT use it on a regular bases**. @@ -101,8 +101,8 @@ which the first time should automagically install all the needed dependencies in License ======= -.. image:: https://raw.github.com/leapcode/leap_client/develop/docs/user/gpl.png +.. image:: https://raw.github.com/leapcode/bitmask/develop/docs/user/gpl.png -The LEAP Client is released under the terms of the `GNU GPL version 3`_ or later. +Bitmask is released under the terms of the `GNU GPL version 3`_ or later. .. _`GNU GPL version 3`: http://www.gnu.org/licenses/gpl.txt diff --git a/setup.py b/setup.py index 4b39189c..4c37c56d 100755 --- a/setup.py +++ b/setup.py @@ -19,7 +19,7 @@ import versioneer versioneer.versionfile_source = 'src/leap/_version.py' versioneer.versionfile_build = 'leap/_version.py' versioneer.tag_prefix = '' # tags are like 1.2.0 -versioneer.parentdir_prefix = 'leap_client-' +versioneer.parentdir_prefix = 'bitmask-' from setuptools import Command @@ -52,7 +52,7 @@ trove_classifiers = [ parsed_reqs = utils.parse_requirements() cmdclass = versioneer.get_cmdclass() -leap_launcher = 'leap-client=leap.app:main' +leap_launcher = 'bitmask=leap.app:main' from setuptools.command.develop import develop as _develop @@ -109,7 +109,7 @@ cmdclass["sdist"] = cmd_sdist setup( - name="leap-client", + name="bitmask", package_dir={"": "src"}, version=versioneer.get_version(), cmdclass=cmdclass, @@ -131,7 +131,7 @@ setup( test_suite='nose.collector', tests_require=utils.parse_requirements( reqfiles=['pkg/requirements-testing.pip']), - keywords='LEAP, client, qt, encryption, proxy, openvpn, imap, smtp', + keywords='Bitmask, LEAP, client, qt, encryption, proxy, openvpn, imap, smtp', author='The LEAP Encryption Access Project', author_email='info@leap.se', url='https://leap.se', @@ -146,7 +146,7 @@ setup( # looks like debhelper is honoring it... data_files=[ # ("share/man/man1", - # ["docs/man/leap-client.1"]), + # ["docs/man/bitmask.1"]), ("share/polkit-1/actions", ["pkg/linux/polkit/net.openvpn.gui.leap.policy"]), ], -- cgit v1.2.3 From 9cfc75767ae440bef83e5cd7a5e34c1b3ba7a215 Mon Sep 17 00:00:00 2001 From: Ivan Alejandro Date: Thu, 8 Aug 2013 11:11:05 -0300 Subject: pep8 fixes --- setup.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/setup.py b/setup.py index 4c37c56d..4b36ad72 100755 --- a/setup.py +++ b/setup.py @@ -70,6 +70,7 @@ def copy_reqs(path, withsrc=False): with open(reqsfile, "w") as f: f.write('\n'.join(parsed_reqs)) + class cmd_develop(_develop): def run(self): # versioneer: @@ -131,7 +132,8 @@ setup( test_suite='nose.collector', tests_require=utils.parse_requirements( reqfiles=['pkg/requirements-testing.pip']), - keywords='Bitmask, LEAP, client, qt, encryption, proxy, openvpn, imap, smtp', + keywords=('Bitmask, LEAP, client, qt, encryption, ' + 'proxy, openvpn, imap, smtp'), author='The LEAP Encryption Access Project', author_email='info@leap.se', url='https://leap.se', @@ -145,10 +147,10 @@ setup( # not being used? -- setuptools does not like it. # looks like debhelper is honoring it... data_files=[ - # ("share/man/man1", - # ["docs/man/bitmask.1"]), + # ("share/man/man1", + # ["docs/man/bitmask.1"]), ("share/polkit-1/actions", - ["pkg/linux/polkit/net.openvpn.gui.leap.policy"]), + ["pkg/linux/polkit/net.openvpn.gui.leap.policy"]), ], zip_safe=False, platforms="all", -- cgit v1.2.3 From 948f4a768666ef5894c8daaa8260d2ddb82c38de Mon Sep 17 00:00:00 2001 From: Ivan Alejandro Date: Thu, 8 Aug 2013 11:41:12 -0300 Subject: Update docs/, leap-client to bitmask. --- docs/config/files.rst | 2 +- docs/dev/environment.rst | 14 +++---- docs/dev/internals.rst | 2 +- docs/dev/internationalization.rst | 10 ++--- docs/man/bitmask.1.rst | 86 +++++++++++++++++++++++++++++++++++++++ docs/man/leap-client.1.rst | 86 --------------------------------------- docs/testers/howto.rst | 28 ++++++------- docs/user/install.rst | 14 +++---- docs/user/intro.rst | 16 ++++---- docs/user/running.rst | 20 ++++----- 10 files changed, 139 insertions(+), 139 deletions(-) create mode 100644 docs/man/bitmask.1.rst delete mode 100644 docs/man/leap-client.1.rst diff --git a/docs/config/files.rst b/docs/config/files.rst index 0f4abead..70d3bff8 100644 --- a/docs/config/files.rst +++ b/docs/config/files.rst @@ -3,7 +3,7 @@ Configuration Files =================== -This document covers the different configuration files used by the LEAP Client. +This document covers the different configuration files used by Bitmask. leap.conf --------- diff --git a/docs/dev/environment.rst b/docs/dev/environment.rst index 010ccc83..7ce536f9 100644 --- a/docs/dev/environment.rst +++ b/docs/dev/environment.rst @@ -3,7 +3,7 @@ Setting up a development environment ==================================== -This document covers how to get an enviroment ready to contribute code to the LEAP Client. +This document covers how to get an enviroment ready to contribute code to Bitmask. Cloning the repo ---------------- @@ -13,12 +13,12 @@ Cloning the repo :: - git clone git://leap.se/leap_client + git clone git://leap.se/bitmask git checkout develop Base Dependencies ------------------ -Leap client depends on these libraries: +Bitmask depends on these libraries: * `python 2.6 or 2.7` * `qt4` libraries (see also :ref:`Troubleshooting PySide install ` about how to install inside your virtualenv) @@ -100,10 +100,10 @@ You can install python dependencies with ``pip``. If you do it inside your worki Copy script files ----------------- -The openvpn invocation expects some files to be in place. If you have not installed `leap-client` from a debian package, you must copy these files manually by now:: +The openvpn invocation expects some files to be in place. If you have not installed `bitmask` from a debian package, you must copy these files manually by now:: $ sudo mkdir -p /etc/leap - $ sudo cp pkg/linux/resolv-update /etc/leap + $ sudo cp pkg/linux/resolv-update /etc/leap .. _policykit: @@ -111,9 +111,9 @@ Running openvpn without root privileges --------------------------------------- In linux, we are using ``policykit`` to be able to run openvpn without root privileges, and a policy file is needed to be installed for that to be possible. -The setup script tries to install the policy file when installing the client system-wide, so if you have installed the client in your global site-packages at least once it should have copied this file for you. +The setup script tries to install the policy file when installing bitmask system-wide, so if you have installed bitmask in your global site-packages at least once it should have copied this file for you. -If you *only* are running the client from inside a virtualenv, you will need to copy this file by hand:: +If you *only* are running bitmask from inside a virtualenv, you will need to copy this file by hand:: $ sudo cp pkg/linux/polkit/net.openvpn.gui.leap.policy /usr/share/polkit-1/actions/ diff --git a/docs/dev/internals.rst b/docs/dev/internals.rst index 8bb19211..e43868f3 100644 --- a/docs/dev/internals.rst +++ b/docs/dev/internals.rst @@ -3,7 +3,7 @@ Internals ========= -This section covers briefly the internal organization of the LEAP Client source tree. +This section covers briefly the internal organization of Bitmask source tree. .. note:: diff --git a/docs/dev/internationalization.rst b/docs/dev/internationalization.rst index 8c584fdd..38db8d75 100644 --- a/docs/dev/internationalization.rst +++ b/docs/dev/internationalization.rst @@ -3,11 +3,11 @@ Internationalization ==================== -This part of the documentation covers the localization and translation of LEAP Client. +This part of the documentation covers the localization and translation of Bitmask. Because we want to *bring fire to the people*, in as many countries and languages as possible. -Translating the LEAP Client PySide Application --------------------------------------------- +Translating Bitmask PySide Application +-------------------------------------- .. raw:: html @@ -61,7 +61,7 @@ You need ``pyside-lupdate`` and ``lrelease`` for these steps. To get it, in debi If you do not already have it, install the ``transifex-client`` from the cheese shop:: - pip install transifex-client + pip install transifex-client You can learn more about the transifex-client `here `_. @@ -89,7 +89,7 @@ Note that there is a configuration option in ``.tx/config`` for setting the mini **6.** Generate .qm files from the updated .ts files:: - $ make translations + $ make translations and yes, it's the same command than in step 2. One less thing to remember :) diff --git a/docs/man/bitmask.1.rst b/docs/man/bitmask.1.rst new file mode 100644 index 00000000..12c87a5d --- /dev/null +++ b/docs/man/bitmask.1.rst @@ -0,0 +1,86 @@ +======= +bitmask +======= + +------------------------------------------------------------------------ +graphical client to control LEAP, the encrypted internet access toolkit. +------------------------------------------------------------------------ + +:Author: LEAP Encryption Access Project https://leap.se +:Date: 2013-01-30 +:Copyright: GPLv3+ +:Version: 0.2 +:Manual section: 1 +:Manual group: General Commands Manual + +SYNOPSIS +======== + +bitmask [-h] [-d] [-l [LOG FILE]] [--openvpn-verbosity [OPENVPN_VERB]] + +DESCRIPTION +=========== + +*bitmask* is a graphical client to control LEAP, the encrypted internet access toolkit. + +When launched, it places an icon in the system tray from where the LEAP services can be controlled. + + +OPTIONS +======= + +general options +--------------- + +**-h, --help** Print a help message and exit. + +**-d, --debug** Launches client in debug mode, writing debug info to stdout. + +**---logfile=** Writes log to file. + +openvpn options +--------------- + +**--openvpn-verbosity** [0-5] Verbosity level for openvpn logs. + + +WARNING +======= + +This software is still in early alfa testing. So don't trust your life to it! + +At the current time, Bitmask is not compatible with ``openresolv``, but it works with ``resolvconf``. + +FILES +===== + +/etc/leap/resolv-update +----------------------- +Post up/down script passed to openvpn. It writes /etc/resolv.conf to avoid dns leaks, and restores the original resolv.conf on exit. + +/etc/leap/resolv-head +--------------------- +/etc/leap/resolv-tail +--------------------- + +Custom entries that will appear in the written resolv.conf + +/usr/share/polkit-1/actions/net.openvpn.gui.leap.policy +------------------------------------------------------- + +PolicyKit policy file, used for granting access to openvpn without the need of entering a password each time. + +~/.config/leap/ +--------------- + +Main config folder + +~/.config/leap/leap.conf +------------------------ + +GUI options + +BUGS +==== + +Please report any bugs to https://leap.se/code diff --git a/docs/man/leap-client.1.rst b/docs/man/leap-client.1.rst deleted file mode 100644 index 1ef5b3cc..00000000 --- a/docs/man/leap-client.1.rst +++ /dev/null @@ -1,86 +0,0 @@ -=========== -leap-client -=========== - ------------------------------------------------------------------------- -graphical client to control LEAP, the encrypted internet access toolkit. ------------------------------------------------------------------------- - -:Author: LEAP Encryption Access Project https://leap.se -:Date: 2013-01-30 -:Copyright: GPLv3+ -:Version: 0.2 -:Manual section: 1 -:Manual group: General Commands Manual - -SYNOPSIS -======== - -leap-client [-h] [-d] [-l [LOG FILE]] [--openvpn-verbosity [OPENVPN_VERB]] - -DESCRIPTION -=========== - -*leap-client* is a graphical client to control LEAP, the encrypted internet access toolkit. - -When launched, it places an icon in the system tray from where the LEAP services can be controlled. - - -OPTIONS -======= - -general options ---------------- - -**-h, --help** Print a help message and exit. - -**-d, --debug** Launches client in debug mode, writing debug info to stdout. - -**---logfile=** Writes log to file. - -openvpn options ---------------- - -**--openvpn-verbosity** [0-5] Verbosity level for openvpn logs. - - -WARNING -======= - -This software is still in early alfa testing. So don't trust your life to it! - -At the current time, the LEAP Client is not compatible with ``openresolv``, but it works with ``resolvconf``. - -FILES -===== - -/etc/leap/resolv-update ------------------------ -Post up/down script passed to openvpn. It writes /etc/resolv.conf to avoid dns leaks, and restores the original resolv.conf on exit. - -/etc/leap/resolv-head ---------------------- -/etc/leap/resolv-tail ---------------------- - -Custom entries that will appear in the written resolv.conf - -/usr/share/polkit-1/actions/net.openvpn.gui.leap.policy -------------------------------------------------------- - -PolicyKit policy file, used for granting access to openvpn without the need of entering a password each time. - -~/.config/leap/ ---------------- - -Main config folder - -~/.config/leap/leap.conf ------------------------- - -GUI options - -BUGS -==== - -Please report any bugs to https://leap.se/code diff --git a/docs/testers/howto.rst b/docs/testers/howto.rst index a3f8da09..520d9dd0 100644 --- a/docs/testers/howto.rst +++ b/docs/testers/howto.rst @@ -34,19 +34,19 @@ Bootstrap script This will fetch the *develop* branch. If you want to test another branch, just change it in the line starting with *pip install...*. Alternatively, bug kali so she add an option branch to a decent script. .. note:: - This script could make use of the after_install hook. Read http://pypi.python.org/pypi/virtualenv/ + This script could make use of the after_install hook. Read http://pypi.python.org/pypi/virtualenv/ Download and source the following script in the parent folder where you want your testing build to be downloaded. For instance, to `/tmp/`: .. code-block:: bash cd /tmp - wget https://raw.github.com/leapcode/leap_client/develop/pkg/scripts/leap_client_bootstrap.sh + wget https://raw.github.com/leapcode/bitmask/develop/pkg/scripts/leap_client_bootstrap.sh source leap_client_bootstrap.sh -Tada! If everything went well, you should be able to run the client by typing:: +Tada! If everything went well, you should be able to run bitmask by typing:: - bin/leap-client + bin/bitmask Noticed that your prompt changed? That was *virtualenv*. Keep reading... @@ -54,7 +54,7 @@ Activating the virtualenv ^^^^^^^^^^^^^^^^^^^^^^^^^ The above bootstrap script has fetched latest code inside a virtualenv, which is an isolated, *virtual* python local environment that avoids messing with your global paths. You will notice you are *inside* a virtualenv because you will see a modified prompt reminding it to you (*leap-client-testbuild* in this case). -Thus, if you forget to *activate your virtualenv*, the client will not run from the local path, and it will be looking for something else in your global path. So, **you have to remember to activate your virtualenv** each time that you open a new shell and want to execute the code you are testing. You can do this by typing:: +Thus, if you forget to *activate your virtualenv*, bitmask will not run from the local path, and it will be looking for something else in your global path. So, **you have to remember to activate your virtualenv** each time that you open a new shell and want to execute the code you are testing. You can do this by typing:: $ source bin/activate @@ -65,11 +65,11 @@ Refer to :ref:`Working with virtualenv ` to learn more about virtual Copying config files ^^^^^^^^^^^^^^^^^^^^ -If you have never installed the ``leap-client`` globally, **you need to copy some files to its proper path before running it for the first time** (you only need to do this once). This, unless the virtualenv-based operations, will need root permissions. See :ref:`copy script files ` and :ref:`running openvpn without root privileges ` sections for more info on this. In short:: +If you have never installed ``bitmask`` globally, **you need to copy some files to its proper path before running it for the first time** (you only need to do this once). This, unless the virtualenv-based operations, will need root permissions. See :ref:`copy script files ` and :ref:`running openvpn without root privileges ` sections for more info on this. In short:: $ sudo cp pkg/linux/polkit/net.openvpn.gui.leap.policy /usr/share/polkit-1/actions/ $ sudo mkdir -p /etc/leap - $ sudo cp pkg/linux/resolv-update /etc/leap + $ sudo cp pkg/linux/resolv-update /etc/leap Local config files ^^^^^^^^^^^^^^^^^^^ @@ -83,8 +83,8 @@ Pulling latest changes You should be able to cd into the downloaded repo and pull latest changes:: - (leap-client-testbuild)$ cd src/leap-client - (leap-client-testbuild)$ git pull origin develop + (bitmask-testbuild)$ cd src/bitmask + (bitmask-testbuild)$ git pull origin develop However, as a tester you are encouraged to run the whole bootstrap process from time to time to help us catching install and versioniing bugs too. @@ -97,11 +97,11 @@ Testing the status of translations We need translators! You can go to `transifex `_, get an account and start contributing. -If you want to check the current status of the client localization in a language other than the one set in your machine, you can do it with a simple trick (under linux). For instance, do:: +If you want to check the current status of bitmask localization in a language other than the one set in your machine, you can do it with a simple trick (under linux). For instance, do:: - $ lang=es_ES leap-client + $ lang=es_ES bitmask -for running LEAP Client with the spanish locales. +for running Bitmask with the spanish locales. Reporting bugs -------------- @@ -110,6 +110,6 @@ Reporting bugs There is a great text on the art of bug reporting, that can be found `online `_. -.. TODO add a line with ref. to running the client in debug mode... +.. TODO add a line with ref. to running Bitmask in debug mode... -We use the `LEAP Client Bug Tracker `_, although you can also use `Github issues `_. +We use the `Bitmask Bug Tracker `_, although you can also use `Github issues `_. diff --git a/docs/user/install.rst b/docs/user/install.rst index 0467ba8b..da1d914c 100644 --- a/docs/user/install.rst +++ b/docs/user/install.rst @@ -3,7 +3,7 @@ Installation ============ -This part of the documentation covers the installation of the LEAP Client. +This part of the documentation covers the installation of Bitmask. We assume that you want to get it properly installed before being able to use it. .. note:: @@ -16,9 +16,9 @@ Distribute & Pip .. 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 is as simple as using `pip `_ for the already released versions :: +Installing Bitmask is as simple as using `pip `_ for the already released versions :: - $ pip install leap-client + $ pip install bitmask Debian package -------------- @@ -40,20 +40,20 @@ Add the archive to your sources.list:: # apt-get update # apt-get install leap-keyring -And then you can happily install leap-client:: +And then you can happily install bitmask:: - apt-get install leap-client + apt-get install bitmask 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/bitmask Or from the github mirror :: - $ git clone git://github.com/leapcode/leap_client.git + $ git clone git://github.com/leapcode/bitmask.git Once you have grabbed a copy of the sources, you can install it into your site-packages easily :: diff --git a/docs/user/intro.rst b/docs/user/intro.rst index 9461d5f2..22ad9356 100644 --- a/docs/user/intro.rst +++ b/docs/user/intro.rst @@ -3,15 +3,15 @@ Introduction ============ -The LEAP Client ---------------- +Bitmask +------- .. 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 PySide, that supports the features offered by :ref:`the LEAP Platform `. Currently is being tested on Linux, support for OSX and Windows will come soon. +**Bitmask** is a :ref:`GPL3 Licensed ` multiplatform client, written in python using PySide, 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. +Bitmask allows to easily secure communications. - Provider selection - User registration @@ -78,22 +78,22 @@ GPLv3 License .. image:: gpl.* -The LEAP Client is released under the terms of the `GNU GPL version 3`_ or later. +Bitmask 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 + Bitmask 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, + Bitmask 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/. + along with Bitmask. If not, see http://www.gnu.org/licenses/. .. _`GNU GPL version 3`: http://www.gnu.org/licenses/gpl.txt diff --git a/docs/user/running.rst b/docs/user/running.rst index 43f3e87c..da83e9ef 100644 --- a/docs/user/running.rst +++ b/docs/user/running.rst @@ -3,13 +3,13 @@ Running ================== -This document covers how to launch the LEAP Client. +This document covers how to launch Bitmask. -Launching the client --------------------- -After a successful installation, there should be a launcher called `leap-client` somewhere in your path:: +Launching Bitmask +----------------- +After a successful installation, there should be a launcher called `bitmask` somewhere in your path:: - % leap-client + % bitmask The first time you launch it, it should launch the first run wizard that will guide you through the setup of the LEAP Services. @@ -21,13 +21,13 @@ The first time you launch it, it should launch the first run wizard that will gu 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:: +If you are happy having lots of output in your terminal, you will like to know that you can run bitmask in debug mode:: - $ leap-client --debug + $ 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:: - $ leap-client --debug --logfile /tmp/leap.log + $ bitmask --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. @@ -35,10 +35,10 @@ If you ask for it, you can also have all that debug info in a beautiful file rea .. not working... .. If you want to increment the level of verbosity passed to openvpn, you can do:: -.. $ leap-client --openvpn-verbosity 4 +.. $ bitmask --openvpn-verbosity 4 Options ------------ To see all the available command line options:: - $ leap-client --help + $ bitmask --help -- cgit v1.2.3 From fbb4dd62e2e70fb467b2fe6fb05911c989fb34ee Mon Sep 17 00:00:00 2001 From: Ivan Alejandro Date: Thu, 8 Aug 2013 12:55:53 -0300 Subject: Update images, jumping guy -> rainbow mask. --- data/images/mask-icon.png | Bin 0 -> 16575 bytes data/images/mask-launcher.png | Bin 0 -> 37759 bytes data/resources/mainwindow.qrc | 2 ++ src/leap/gui/ui/loggerwindow.ui | 2 +- src/leap/gui/ui/mainwindow.ui | 4 ++-- src/leap/gui/ui/wizard.ui | 2 +- 6 files changed, 6 insertions(+), 4 deletions(-) create mode 100644 data/images/mask-icon.png create mode 100644 data/images/mask-launcher.png diff --git a/data/images/mask-icon.png b/data/images/mask-icon.png new file mode 100644 index 00000000..3504bae9 Binary files /dev/null and b/data/images/mask-icon.png differ diff --git a/data/images/mask-launcher.png b/data/images/mask-launcher.png new file mode 100644 index 00000000..cb27f8d3 Binary files /dev/null and b/data/images/mask-launcher.png differ diff --git a/data/resources/mainwindow.qrc b/data/resources/mainwindow.qrc index 655f2812..d1268186 100644 --- a/data/resources/mainwindow.qrc +++ b/data/resources/mainwindow.qrc @@ -1,5 +1,7 @@ + ../images/mask-launcher.png + ../images/mask-icon.png ../images/watermark.png ../images/leap-gray-big.png ../images/Blue-Arrow-Right-32.png diff --git a/src/leap/gui/ui/loggerwindow.ui b/src/leap/gui/ui/loggerwindow.ui index 28325cdf..b08428a9 100644 --- a/src/leap/gui/ui/loggerwindow.ui +++ b/src/leap/gui/ui/loggerwindow.ui @@ -15,7 +15,7 @@ - :/images/leap-color-big.png:/images/leap-color-big.png + :/images/mask-icon.png:/images/mask-icon.png diff --git a/src/leap/gui/ui/mainwindow.ui b/src/leap/gui/ui/mainwindow.ui index c3523823..ecd3cbe9 100644 --- a/src/leap/gui/ui/mainwindow.ui +++ b/src/leap/gui/ui/mainwindow.ui @@ -15,7 +15,7 @@ - :/images/leap-color-big.png:/images/leap-color-big.png + :/images/mask-icon.png:/images/mask-icon.png Qt::ImhHiddenText @@ -166,7 +166,7 @@ - :/images/leap-color-big.png + :/images/mask-launcher.png Qt::AlignCenter diff --git a/src/leap/gui/ui/wizard.ui b/src/leap/gui/ui/wizard.ui index d7355d5d..a8f66bbc 100644 --- a/src/leap/gui/ui/wizard.ui +++ b/src/leap/gui/ui/wizard.ui @@ -15,7 +15,7 @@ - :/images/leap-color-big.png:/images/leap-color-big.png + :/images/mask-icon.png:/images/mask-icon.png true -- cgit v1.2.3 From 1f03efa202e4b604b9fb50d0742dc756691e9803 Mon Sep 17 00:00:00 2001 From: Ivan Alejandro Date: Thu, 8 Aug 2013 14:50:51 -0300 Subject: Add changes file, feature 3313. --- changes/feature-3313_rebrand-the-client | 1 + 1 file changed, 1 insertion(+) create mode 100644 changes/feature-3313_rebrand-the-client diff --git a/changes/feature-3313_rebrand-the-client b/changes/feature-3313_rebrand-the-client new file mode 100644 index 00000000..4e10345e --- /dev/null +++ b/changes/feature-3313_rebrand-the-client @@ -0,0 +1 @@ + o Rebrand the client to be named Bitmask. Feature #3313. -- cgit v1.2.3