summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkwadronaut <kwadronaut@leap.se>2019-07-04 23:43:09 +0200
committerkwadronaut <kwadronaut@leap.se>2019-07-05 00:06:28 +0200
commit6f21582d5e809b8f44c0165104ed21f1b535121c (patch)
tree0c53834115687529bf95c02091af790ad8a78896
parentd1fc7e348a40d8c1a4f76b5772540601037020e9 (diff)
[Bug] cleanup Readme
Fixes #63, correct broken link.
-rw-r--r--CHANGELOG.rst2
-rw-r--r--README.rst12
2 files changed, 7 insertions, 7 deletions
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index 1b32a54..a6197a5 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -17,7 +17,7 @@ Changelog for Bitmask Lite/RiseupVPN
- Allow tls 1.0 as a workaround for buster/sid
- Rename the systray reconnection on fail-close
-0.18.12
+0.18.12
-------
...
diff --git a/README.rst b/README.rst
index 75be6a7..035d1eb 100644
--- a/README.rst
+++ b/README.rst
@@ -3,10 +3,10 @@ RiseupVPN
Anonymous VPN. Easy, fast, secure.
-This repo has everything needed to build BitmaskLite/RiseupVPN on different
+This repo has everything needed to build Bitmask VPN/RiseupVPN on different
platforms (windows, mac and linux).
-RiseupVPN is a branded build of Bitmask Lite. Bitmask Lite is a minimal rewrite
+RiseupVPN is a branded build of Bitmask VPN. Bitmask VPN is a minimal rewrite
of the Bitmask VPN Client, written in golang, that for now lacks client
authentication, and is preconfigured to use a single provider. As of this
moment, it is built for a single provider (riseup.net), but it should be easy
@@ -125,18 +125,18 @@ You can also cross-compile openvpn::
Hacking
---------------
-If you want to contribute to BitmaskLite/RiseupVPN, you can get in contact with us in the ``#leap`` channel at freenode.
+If you want to contribute to Bitmask VPN/RiseupVPN, you can get in contact with us in the ``#leap`` channel at freenode.
You might also want to have a look at some related pieces that are used to build these packages.
* `bitmask-vpn`_: this is the golang implementation of RiseupVPN. It is
basically a wrapper around openvpn, with knowledge of what configuration
files are expected to exist in a LEAP provider. The only user interface is a minimalistic systray that uses libappindicator.
-* `the bitmask helper`_: it lives in this repo. It implements a long-lived helper that runs with administrative privileges, used in OSX and Windows for launching openvpn and the firewall. In OSX it is run as a LaunchDaemon, and in Windows we use nssm to run this helper. It communicates with BitmaskLite via a local http service.
+* `the bitmask helper`_: it lives in bitmask-vpn for Windows and osX. It implements a long-lived helper that runs with administrative privileges, used in OSX and Windows for launching openvpn and the firewall. In OSX it is run as a LaunchDaemon, and in Windows we use nssm to run this helper. It communicates with Bitmask VPN via a local http service.
* `bitmask-root`_: for the snaps, in GNU/Linux we use a one-shot privileged helper that relies on policykit to elevate privileges without asking for password each time, instead of the long-lived helper that we use in osx and windows packages (although there is a linux implementation, and this long-lived helper might make sense in some cases, we want to explore that. For instance for OpenWRT packages).
- In case you are wondering what is the relationship of BitmaskLite and the regular Bitmask, it is planned that the bitmask client will at some point switch to use the same helpers. This repo probably will be turned into a generic packaging and helper tool to be used for both branded builds of BitmaskLite, and packaging of the frozen python payloads generated from bitmask-dev.
+ In case you are wondering what is the relationship of Bitmask VPN and the regular Bitmask, it is planned that the bitmask client will at some point switch to use the same helpers. This repo probably will be turned into a generic packaging and helper tool to be used for both branded builds of BitmaskLite, and packaging of the frozen python payloads generated from bitmask-dev.
.. _`bitmask-vpn`: https://0xacab.org/leap/bitmask-vpn
-.. _`the bitmask helper`: https://0xacab.org/leap/riseup_vpn/tree/master/helper
+.. _`the bitmask helper`: https://0xacab.org/leap/bitmask-vpn/tree/master/pkg/helper/
.. _`bitmask-root`: https://0xacab.org/leap/bitmask-dev/blob/master/src/leap/bitmask/vpn/helpers/linux/bitmask-root