sshuttle/docs/installation.rst

Installation
============

- From PyPI::

      pip install sshuttle

- Debian package manager::

      sudo apt install sshuttle

- Clone::

      git clone https://github.com/sshuttle/sshuttle.git
      cd sshuttle
      ./setup.py install


Optionally after installation
-----------------------------

- Install sudoers configuration. For details, see the "Sudoers File" section in :doc:`usage`
Use Sphinx for documentation See #60 2016-01-17 06:16:36 +01:00			`Installation`
			`============`

			`- From PyPI::`

			`pip install sshuttle`

Fix typos 2021-09-22 14:07:24 +02:00			`- Debian package manager::`
Fix formatting in installation.rst 2020-07-15 00:14:51 +02:00
			`sudo apt install sshuttle`
Auto sudoers file (#269) * added sudoers options to command line arguments * added sudoers options to command line arguments * template for sudoers file * Added option for GUI sudo * added support for GUI sudo * script for auto adding sudo file * sudoers auto add works and validates * small change * Clean up for CI * removed code that belongs in another PR * added path for package bins * added sudoers bin * added sudoers-add to setup file * fixed issue with sudoers bash script * auto sudoers now works * added --sudoers-no-modify option * bin now works with ./run * removed debug print * Updated sudoers-add script * Fixed error passing sudoers config to script * more dynamic building of sudoers file * added option to specify sudoers.d file name * fixed indent issue * fixed indent issue * indent issue * clean up * formating * docs * fix for flags * Update usage.rst * removed shell=true * cleared CI errors * cleared CI errors * removed random * cleared linter issue * cleared linter issue * cleared linter issue * updated sudoers-add script * safer temp file * moved bin directory * moved bin directory * removed print * fixed spacing issue * sudoers commands must only containe upper case latters 2019-12-12 22:15:31 +01:00
Use Sphinx for documentation See #60 2016-01-17 06:16:36 +01:00			`- Clone::`

			`git clone https://github.com/sshuttle/sshuttle.git`
Adds 'cd sshuttle' after 'git' to README and docs 2018-02-14 11:50:04 +01:00			`cd sshuttle`
Use Sphinx for documentation See #60 2016-01-17 06:16:36 +01:00			`./setup.py install`
Auto sudoers file (#269) * added sudoers options to command line arguments * added sudoers options to command line arguments * template for sudoers file * Added option for GUI sudo * added support for GUI sudo * script for auto adding sudo file * sudoers auto add works and validates * small change * Clean up for CI * removed code that belongs in another PR * added path for package bins * added sudoers bin * added sudoers-add to setup file * fixed issue with sudoers bash script * auto sudoers now works * added --sudoers-no-modify option * bin now works with ./run * removed debug print * Updated sudoers-add script * Fixed error passing sudoers config to script * more dynamic building of sudoers file * added option to specify sudoers.d file name * fixed indent issue * fixed indent issue * indent issue * clean up * formating * docs * fix for flags * Update usage.rst * removed shell=true * cleared CI errors * cleared CI errors * removed random * cleared linter issue * cleared linter issue * cleared linter issue * updated sudoers-add script * safer temp file * moved bin directory * moved bin directory * removed print * fixed spacing issue * sudoers commands must only containe upper case latters 2019-12-12 22:15:31 +01:00

			`Optionally after installation`
			`-----------------------------`

Remove --sudoers, improve --sudoers-no-modify Allowing sshuttle to add/overwrite sudoers configuration file at locations of the users' choosing adds complexity to the code compared to asking users to install the sudo configuration themselves. It requires sshuttle to make decisions about how much effort we put into ensuring that the file is written to a proper location. The current method relies on the 'realpath' program which is not installed on MacOS by default. There are serious problems when the sudo configuration is used to allow a user to only run sshuttle as root (with or without a password). First, that user could then use the --sudoers option to give other users sudo privileges. Second, the user can run any command as root because sshuttle accepts a --ssh-cmd parameter which allows a user to specify a program that sshuttle should run. There may also be additional issues that we have not identified. By removing the --sudoers option (and the associated sudoers-add script), this reduces the problems above. This code keeps the --sudoers-no-modify feature which prints a configuration to stdout for the user to install. It includes a clear warning about how --ssh-cmd could potentially be abused to run other programs. A warning about some of these issues has been in sshuttle since version 1.1.0. This commit also adds that warning to more locations in the documentation. 2022-03-04 18:15:24 +01:00			- Install sudoers configuration. For details, see the "Sudoers File" section in :doc:`usage`
Fix formatting in installation.rst 2020-07-15 00:14:51 +02:00