.. include:: /urls.rst

.. _l1_tunnel:

Librem Tunnel
=============


.. _l1_tunnel_activation:

Activate service
----------------

#. Visit your `Librem One profile`_.
#. Click the **Activate** button:

   .. image:: /_files/l1/account/addams0.png
      :scale: 60%
      :alt: Tunnel activation
      :class: no-scaled-link

#. The Librem Tunnel service is now activated.
   It must now be installed and enabled on the device on which to use it.


.. _l1_tunnel_credentials:

Retrieve credentials
--------------------


.. _l1_tunnel_credentials_username_password:

Username and password
~~~~~~~~~~~~~~~~~~~~~

Librem Tunnel uses a username and password that is different from Librem One credentials.
To obtain Tunnel credentials:

#. Navigate to your `Librem One login`_ page
#. In the same browser window, access your `Librem Tunnel account <librem_tunnel_account_>`_
#. The Librem Tunnel username is the ``tunnel_user`` string.
   The Librem Tunnel password is the ``tunnel_password`` string.


.. _l1_tunnel_credentials_ovpn:

.ovpn configuration file
~~~~~~~~~~~~~~~~~~~~~~~~

Numerous exit servers are available but only :download:`USA California </_files/l1/tunnel/Librem One US-California.ovpn>` is officially supported:

.. .ovpn collapsible section

.. raw:: html

   <details>
   <summary><a>Other available servers</a></summary>

* :download:`Albania </_files/l1/tunnel/Librem One Albania.ovpn>`
* :download:`Algeria </_files/l1/tunnel/Librem One Algeria.ovpn>`
* :download:`Andora </_files/l1/tunnel/Librem One Andora.ovpn>`
* :download:`Argentina </_files/l1/tunnel/Librem One Argentina.ovpn>`
* :download:`Armenia </_files/l1/tunnel/Librem One Armenia.ovpn>`
* :download:`Australia - Melbourne </_files/l1/tunnel/Librem One AU-Melbourne.ovpn>`
* :download:`Australia - Perth </_files/l1/tunnel/Librem One AU-Perth.ovpn>`
* :download:`Australia - Sydney </_files/l1/tunnel/Librem One AU-Sydney.ovpn>`
* :download:`Austria </_files/l1/tunnel/Librem One Austria.ovpn>`
* :download:`Bahamas </_files/l1/tunnel/Librem One Bahamas.ovpn>`
* :download:`Bangladesh </_files/l1/tunnel/Librem One Bangladesh.ovpn>`
* :download:`Belgium </_files/l1/tunnel/Librem One Belgium.ovpn>`
* :download:`Bosnia&Herzegovina </_files/l1/tunnel/Librem One Bosnia.ovpn>`
* :download:`Brazil </_files/l1/tunnel/Librem One Brazil.ovpn>`
* :download:`Bulgaria </_files/l1/tunnel/Librem One Bulgaria.ovpn>`
* :download:`Cambodia </_files/l1/tunnel/Librem One Cambodia.ovpn>`
* :download:`Canada - Montreal </_files/l1/tunnel/Librem One CA-Montreal.ovpn>`
* :download:`Canada - Ontario </_files/l1/tunnel/Librem One CA-Ontario.ovpn>`
* :download:`Canada - Toronto </_files/l1/tunnel/Librem One CA-Toronto.ovpn>`
* :download:`Canada - Vancouver </_files/l1/tunnel/Librem One CA-Vancouver.ovpn>`
* :download:`China </_files/l1/tunnel/Librem One China.ovpn>`
* :download:`Cyprus </_files/l1/tunnel/Librem One Cyprus.ovpn>`
* :download:`Czechia </_files/l1/tunnel/Librem One Czechia.ovpn>`
* :download:`Denmark </_files/l1/tunnel/Librem One Denmark.ovpn>`
* :download:`Egypt </_files/l1/tunnel/Librem One Egypt.ovpn>`
* :download:`Estonia </_files/l1/tunnel/Librem One Estonia.ovpn>`
* :download:`Finland </_files/l1/tunnel/Librem One Finland.ovpn>`
* :download:`France </_files/l1/tunnel/Librem One France.ovpn>`
* :download:`Georgia </_files/l1/tunnel/Librem One Georgia.ovpn>`
* :download:`Germany - Berlin </_files/l1/tunnel/Librem One DE-Berlin.ovpn>`
* :download:`Germany - Frankfurt </_files/l1/tunnel/Librem One DE-Frankfurt.ovpn>`
* :download:`Greece </_files/l1/tunnel/Librem One Greece.ovpn>`
* :download:`Greenland </_files/l1/tunnel/Librem One Greenland.ovpn>`
* :download:`Hong Kong </_files/l1/tunnel/Librem One Hong Kong.ovpn>`
* :download:`Hungary </_files/l1/tunnel/Librem One Hungary.ovpn>`
* :download:`Iceland </_files/l1/tunnel/Librem One Iceland.ovpn>`
* :download:`India </_files/l1/tunnel/Librem One India.ovpn>`
* :download:`Ireland </_files/l1/tunnel/Librem One Ireland.ovpn>`
* :download:`Isle of Man </_files/l1/tunnel/Librem One Isle of Man.ovpn>`
* :download:`Israel </_files/l1/tunnel/Librem One Israel.ovpn>`
* :download:`Italy </_files/l1/tunnel/Librem One Italy.ovpn>`
* :download:`Japan </_files/l1/tunnel/Librem One Japan.ovpn>`
* :download:`Kazakhstan </_files/l1/tunnel/Librem One Kazakhstan.ovpn>`
* :download:`Latvia </_files/l1/tunnel/Librem One Latvia.ovpn>`
* :download:`Liechtenstein </_files/l1/tunnel/Librem One Liechtenstein.ovpn>`
* :download:`Lithuania </_files/l1/tunnel/Librem One Lithuania.ovpn>`
* :download:`Luxembourg </_files/l1/tunnel/Librem One Luxembourg.ovpn>`
* :download:`Macao </_files/l1/tunnel/Librem One Macao.ovpn>`
* :download:`Malta </_files/l1/tunnel/Librem One Malta.ovpn>`
* :download:`Mexico </_files/l1/tunnel/Librem One Mexico.ovpn>`
* :download:`Moldova </_files/l1/tunnel/Librem One Moldova.ovpn>`
* :download:`Monaco </_files/l1/tunnel/Librem One Monaco.ovpn>`
* :download:`Mongolia </_files/l1/tunnel/Librem One Mongolia.ovpn>`
* :download:`Montenegro </_files/l1/tunnel/Librem One Montenegro.ovpn>`
* :download:`Morocco </_files/l1/tunnel/Librem One Morocco.ovpn>`
* :download:`Netherlands </_files/l1/tunnel/Librem One Netherlands.ovpn>`
* :download:`New Zealand </_files/l1/tunnel/Librem One New Zealand.ovpn>`
* :download:`Nigeria </_files/l1/tunnel/Librem One Nigeria.ovpn>`
* :download:`North Macedonia </_files/l1/tunnel/Librem One North Macedonia.ovpn>`
* :download:`Norway </_files/l1/tunnel/Librem One Norway.ovpn>`
* :download:`Panama </_files/l1/tunnel/Librem One Panama.ovpn>`
* :download:`Philippines </_files/l1/tunnel/Librem One Philippines.ovpn>`
* :download:`Poland </_files/l1/tunnel/Librem One Poland.ovpn>`
* :download:`Portugal </_files/l1/tunnel/Librem One Portugal.ovpn>`
* :download:`Qatar </_files/l1/tunnel/Librem One Qatar.ovpn>`
* :download:`Romania </_files/l1/tunnel/Librem One Romania.ovpn>`
* :download:`Saudi Arabia </_files/l1/tunnel/Librem One Saudi Arabia.ovpn>`
* :download:`Serbia </_files/l1/tunnel/Librem One Serbia.ovpn>`
* :download:`Singapore </_files/l1/tunnel/Librem One Singapore.ovpn>`
* :download:`Slovakia </_files/l1/tunnel/Librem One Slovakia.ovpn>`
* :download:`South Africa </_files/l1/tunnel/Librem One South Africa.ovpn>`
* :download:`Spain </_files/l1/tunnel/Librem One Spain.ovpn>`
* :download:`Sri Lanka </_files/l1/tunnel/Librem One Sri Lanka.ovpn>`
* :download:`Sweden </_files/l1/tunnel/Librem One Sweden.ovpn>`
* :download:`Switzerland </_files/l1/tunnel/Librem One Switzerland.ovpn>`
* :download:`Taiwan </_files/l1/tunnel/Librem One Taiwan.ovpn>`
* :download:`Turkey </_files/l1/tunnel/Librem One Turkey.ovpn>`
* :download:`Ukraine </_files/l1/tunnel/Librem One Ukraine.ovpn>`
* :download:`United Arab Emirates </_files/l1/tunnel/Librem One UAE.ovpn>`
* :download:`United Kingdom - London </_files/l1/tunnel/Librem One UK-London.ovpn>`
* :download:`United Kingdom - London 2 </_files/l1/tunnel/Librem One UK-London 2.ovpn>`
* :download:`United Kingdom - Manchester </_files/l1/tunnel/Librem One UK-Manchester.ovpn>`
* :download:`United Kingdom - Southampton </_files/l1/tunnel/Librem One UK-Southampton.ovpn>`
* :download:`USA - Atlanta </_files/l1/tunnel/Librem One US-Atlanta.ovpn>`
* :download:`USA - Chicago </_files/l1/tunnel/Librem One US-Chicago.ovpn>`
* :download:`USA - Denver </_files/l1/tunnel/Librem One US-Denver.ovpn>`
* :download:`USA - Florida </_files/l1/tunnel/Librem One US-Florida.ovpn>`
* :download:`USA - Houston </_files/l1/tunnel/Librem One US-Houston.ovpn>`
* :download:`USA - Las Vegas </_files/l1/tunnel/Librem One US-Las Vegas.ovpn>`
* :download:`USA - New Jersey </_files/l1/tunnel/Librem One US-New Jersey.ovpn>`
* :download:`USA - New York City </_files/l1/tunnel/Librem One US-New York City.ovpn>`
* :download:`USA - Seattle </_files/l1/tunnel/Librem One US-Seattle.ovpn>`
* :download:`USA - Silicon Valley </_files/l1/tunnel/Librem One US-Silicon Valley.ovpn>`
* :download:`USA - South West </_files/l1/tunnel/Librem One US-South West.ovpn>`
* :download:`USA - Washington DC </_files/l1/tunnel/Librem One US-Washington DC.ovpn>`
* :download:`USA - West </_files/l1/tunnel/Librem One US-West.ovpn>`
* :download:`Venezuela </_files/l1/tunnel/Librem One Venezuela.ovpn>`
* :download:`Vietnam </_files/l1/tunnel/Librem One Vietnam.ovpn>`

.. raw:: html

   </details>


.. _l1_tunnel_install:

Install
-------

.. Android collapsible section

.. raw:: html

   <details>
   <summary><a>Android</a></summary>

.. _l1_tunnel_install_android:

#. Download and install the `Librem Tunnel <librem_tunnel_android_>`_ application.

.. raw:: html

   </details>

.. iOS collapsible section

.. raw:: html

   <details>
   <summary><a>iOS</a></summary>

.. _l1_tunnel_install_ios:

#. Download and install the `Librem Tunnel <librem_tunnel_ios_>`_ application from the App Store.

.. raw:: html

   </details>

.. PureOS desktop collapsible section

.. raw:: html

   <details>
   <summary><a>PureOS desktop</a></summary>

.. _l1_tunnel_install_pureos_desktop:

#. Verify that the pre-requisite package ``network-manager-openvpn-gnome`` is installed.

   * Open a terminal window and run the command ``dpkg -l network-manager-openvpn-gnome``.
     The output will contain the text ``ii  network-manager-openvpn-gnome`` if already installed.
   * If it is not installed, run the command ``sudo apt install -y network-manager-openvpn-gnome`` to install it.

#. Retrieve your :ref:`Librem Tunnel credentials <l1_tunnel_credentials_username_password>` and :ref:`.ovpn file <l1_tunnel_credentials_ovpn>`.
#. Open *Settings* → *Network*.
   Under the *VPN* category, click the **"+"** button to add new connection, then select **Import from file...**:

   .. image:: /_files/l1/pureos/tunnel/Tunnel_PureOS_01.png
      :alt: import conn
      :class: no-scaled-link

#. Select the *.ovpn* file and click the **"Open"** button. An *Add VPN* dialog window will appear.
   Enter the Librem Tunnel credentials (*Username* and *Password*) in step 3 and click the **"Add"** button:

   .. image:: /_files/l1/pureos/tunnel/Tunnel_PureOS_02.png
      :alt: add new vpn conn
      :class: no-scaled-link

.. raw:: html

   </details>


.. _l1_tunnel_connect:

Connect
-------

.. Android collapsible section

.. raw:: html

   <details>
   <summary><a>Android</a></summary>

.. _l1_tunnel_connect_android:

#. Start the Librem Tunnel app and tap the rocket icon to create a new profile:

   .. image:: /_files/l1/android/tunnel/LibremTunnel_01.png
      :scale: 40%
      :alt: Librem Tunnel 1
      :class: no-scaled-link

#. Tap the checkmark icon to add your profile:

   .. image:: /_files/l1/android/tunnel/LibremTunnel_02.png
      :scale: 40%
      :alt: Librem Tunnel 2
      :class: no-scaled-link

   Your profile is created:

   .. image:: /_files/l1/android/tunnel/LibremTunnel_03.png
      :scale: 40%
      :alt: Librem Tunnel 3
      :class: no-scaled-link

#. Tap the newly added profile to activate it.
   Android will warn you about adding new VPN connection, approve it:

   .. image:: /_files/l1/android/tunnel/LibremTunnel_04.png
      :scale: 40%
      :alt: Librem Tunnel 4
      :class: no-scaled-link

#. Enter your login info and tap **OK** button:

   .. image:: /_files/l1/android/tunnel/LibremTunnel_05.png
      :scale: 40%
      :alt: Librem Tunnel 5
      :class: no-scaled-link

#. Wait until it is connected:

   .. image:: /_files/l1/android/tunnel/LibremTunnel_06.png
      :scale: 40%
      :alt: Librem Tunnel 6
      :class: no-scaled-link

#. When *Initialization Sequence Completed* appears, tap the arrow to return back to the previous screen:

   .. image:: /_files/l1/android/tunnel/LibremTunnel_07.png
      :scale: 40%
      :alt: Librem Tunnel 7
      :class: no-scaled-link

   You are finished!

.. raw:: html

   </details>

.. iOS collapsible section

.. raw:: html

   <details>
   <summary><a>iOS</a></summary>

.. _l1_tunnel_connect_ios:

#. Launch the **Librem Tunnel** aplication.
#. Import the ``.ovpn`` file and add your Librem Tunnel credentials.

.. raw:: html

   </details>

.. PureOS desktop collapsible section

.. raw:: html

   <details>
   <summary><a>PureOS desktop</a></summary>

.. _l1_tunnel_connect_pureos_desktop:

#. Click on the right side of the top bar in PureOS
#. Select the option **"VPN Off"**
#. Select **"Connect"**

   .. image:: /_files/l1/pureos/tunnel/Tunnel_PureOS_03.png
      :alt: Librem Tunnel Connect
      :class: no-scaled-link

A padlock symbol on the right side of the top bar indicates that Librem Tunnel is connected.

.. image:: /_files/l1/pureos/tunnel/Tunnel_PureOS_04.png
   :alt: Librem padlock
   :class: no-scaled-link

To verify that Librem Tunnel is connected, open PureBrowser and search for the term **"ip"**, before you connect Librem Tunnel:

.. image:: /_files/l1/pureos/tunnel/Tunnel_PureOS_05.png
   :alt: IP before Librem tunnel
   :class: no-scaled-link

Performing the same search after Librem Tunnel is connected:

.. image:: /_files/l1/pureos/tunnel/Tunnel_PureOS_06.png
   :alt: IP after Librem tunnel
   :class: no-scaled-link

.. raw:: html

   </details>


.. _l1_tunnel_disconnect:

Disconnect
----------

.. Android collapsible section

.. raw:: html

   <details>
   <summary><a>Android</a></summary>

.. _l1_tunnel_disconnect_android:

#. Navigate to the main screen of the **Librem Tunnel** application.

   .. image:: /_files/l1/android/tunnel/LibremTunnel_07.png
      :scale: 40%
      :alt: Librem Tunnel 7
      :class: no-scaled-link

#. Tap on a connected profile to re-connect or disconnect from the VPN:

   .. image:: /_files/l1/android/tunnel/LibremTunnel_08.png
      :scale: 40%
      :alt: Librem Tunnel 8
      :class: no-scaled-link

   You can skip showing the log, go to **Settings** and uncheck option *Show log window*:

   .. image:: /_files/l1/android/tunnel/LibremTunnel_09.png
      :scale: 40%
      :alt: Librem Tunnel 9
      :class: no-scaled-link

.. raw:: html

   </details>

.. PureOS desktop collapsible section

.. raw:: html

   <details>
   <summary><a>PureOS desktop</a></summary>

.. _l1_tunnel_disconnect_pureos_desktop:

#. Click on the right side of the top bar in PureOS
#. Select your Librem Tunnel VPN option
#. Select **"Turn Off"**

   .. image:: /_files/l1/pureos/tunnel/Tunnel_PureOS_07.png
      :alt: IP after Librem tunnel
      :class: no-scaled-link

.. raw:: html

   </details>


.. _l1_tunnel_usage_limit:

Usage limits
------------

+---------------+--------------+---------------+
| Tier          | Device Limit | Traffic Limit |
+===============+==============+===============+
| Free          | 0            | 0 bytes       |
+---------------+--------------+---------------+
| Basic         | 10           | Unlimited     |
+---------------+--------------+---------------+
| Complete      | 10           | Unlimited     |
+---------------+--------------+---------------+