sshoot - Manage sshuttle VPN sessions
=====================================

|Latest Version| |Build Status| |Coverage Status| |Snap Package|

Command-line interface to manage multiple sshuttle_ VPN sessions.

``sshuttle`` creates a VPN connection from your machine to any remote server
that you can connect to via ssh.

``sshoot`` allows to define multiple VPN sessions using ``sshuttle`` and
start/stop them as needed.

It supports configuration options for most of ``sshuttle``'s features,
providing flexible configuration for profiles.


Usage
-----

Create a profile:

.. code:: bash

    $ sshoot create -r host1.remote -HNd vpn1 10.0.0.0/24

Start it:

.. code:: bash

    $ sshoot start vpn1
    Profile started.

List existing profiles (active ones are marked):

.. code:: bash

    $ sshoot list
         Profile  Remote host   Subnets
    --------------------------------------------
      *  vpn1     host1.remote  10.0.0.0/24
         vpn2     host2.remote  192.168.0.0/16

Stop the profile:

.. code:: bash

    $ sshoot stop vpn1

Remove it:

.. code:: bash

    $ sshoot delete vpn1

    
Install from Snap
-----------------

|Get it from the Snap Store|

``sshoot`` can be installed from `Snap Store`_ on systems where classic Snaps
are supported, via::

  sudo snap install --classic sshoot


.. _sshuttle: https://github.com/sshuttle/sshuttle
.. _`Snap Store`: https://snapcraft.io

.. |Latest Version| image:: https://img.shields.io/pypi/v/sshoot.svg
   :alt: Latest Version
   :target: https://pypi.python.org/pypi/sshoot
.. |Build Status| image:: https://github.com/albertodonato/sshoot/workflows/CI/badge.svg
   :alt: Build Status
   :target: https://github.com/albertodonato/sshoot/actions?query=workflow%3ACI
.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/albertodonato/sshoot/main.svg
   :alt: Coverage Status
   :target: https://codecov.io/gh/albertodonato/sshoot
.. |Snap Package| image:: https://snapcraft.io/sshoot/badge.svg
   :alt: Snap Package
   :target: https://snapcraft.io/sshoot
.. |Get it from the Snap Store| image:: https://snapcraft.io/static/images/badges/en/snap-store-black.svg
   :alt: Get it from the Snap Store
   :target: https://snapcraft.io/sshoot
