xanmanning.sshuttle

Ansible Role: sshuttle

This Ansible role installs sshuttle in a Python3 Virtual Environment.

Build Status

Requirements

This role has been tested on Ansible version 2.7.0 and above with these Linux distributions:

  • Amazon Linux 2
  • CentOS 8
  • CentOS 7
  • Debian 10
  • Fedora 29
  • Fedora 30
  • Fedora 31
  • Ubuntu 18.04 LTS

Disclaimer

If you encounter any issues, please create a GitHub issue. I maintain this role during my free time, so I may not be able to respond quickly.

Role Variables

Variable Description Default Value
sshuttle_version Specify a version of sshuttle, e.g., 1.0.0. Use false for the latest. false
sshuttle_install_dir Directory to install the sshuttle virtual environments. $HOME/.virtualenvs
sshuttle_venv_name Name for the sshuttle Virtual Environment. sshuttle
sshuttle_venv_suffix Add a custom suffix to the virtual environment. sshuttle_version
sshuttle_venv_site_packages Allow the virtual environment to use global packages. false
sshuttle_install_venv_helper Install a helper to launch executables from the "bin" directory. true
sshuttle_bin_dir Directory to install the helpers. $HOME/bin
sshuttle_install_os_dependencies Allow installation of OS dependencies. false
sshuttle_python3_path Path to a specific Python version for the virtual environment. NULL

Dependencies

This role has no dependencies on other roles.

Example Playbook

To install sshuttle for a single user:

- hosts: sshuttle_hosts
  roles:
    - { role: xanmanning.sshuttle, sshuttle_version: 1.0.0 }

To install the latest version of sshuttle globally:

---
- hosts: sshuttle_hosts
  become: true
  vars:
    sshuttle_install_os_dependencies: true
    sshuttle_install_dir: /opt/sshuttle/bin
    sshuttle_bin_dir: /usr/bin
    sshuttle_venv_name: current
  roles:
    - role: xanmanning.sshuttle

Activating the sshuttle Virtual Environment

You must activate the Python3 virtual environment to use sshuttle. This is done with the following command:

source {{ sshuttle_install_dir }}/{{ sshuttle_venv_name }}/bin/activate

In the global installation example, this command would look like this:

source /opt/sshuttle/bin/current/bin/activate

License

BSD 3-clause

Author Information

Xan Manning

Informazioni sul progetto

Ansible Role to install [sshuttle](https://sshuttle.readthedocs.io/en/stable/manpage.html)

Installa
ansible-galaxy install xanmanning.sshuttle
Licenza
bsd-3-clause
Download
146
Proprietario
Deep in the lab...