Skip to content

Document possibility to store configuration in a bash alias #562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
khink wants to merge 1 commit into from
Closed

Document possibility to store configuration in a bash alias #562

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 35 additions & 3 deletions docs/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,46 @@ sudo and ssh set up to not require passwords, in which case you won't be
prompted at all.)


Storing configuration
---------------------

At the moment, sshuttle does not use a configuration file. This can become a
nuisance if you have several remote addresses to connect to: The command will
be quite long. In addition, it's hard to remember which IP range is for which
server group.

As a workaround, consider storing the command in a way that makes it more
readable. One way to do this is a shell alias, which will work on MacOS and
Linux::

# ~/.bash_aliases
alias sshuttle_all="sshuttle -r username@sshserver \
10.0.0.0/8 `# Description of server group 1` \
172.16.0.0/12 `# Description of server group 2` \
192.168.0.0/16 `# Description of server group 3` \
...
-v"

Note that ``# Description of server group`` (including the enclosing backticks)
is optional: It's just there to help you remember which server group is for
which customer, or which environment.

Now, after logging in to a new shell, you can type `sshuttle_all` to start
sshuttle for all configured IP ranges. It's also a lot shorter, and easier to
remember.

Note that in this example, we focused on the `bash` shell, but similar methods
are available for other shells. A shell script is also an option.


Usage Notes
-----------
That's it! Now your local machine can access the remote network as if you
were right there. And if your "client" machine is a router, everyone on
your local network can make connections to your remote network.

You don't need to install sshuttle on the remote server;
the remote server just needs to have python available.
the remote server just needs to have python available.
sshuttle will automatically upload and run its source code
to the remote python interpreter.

Expand All @@ -67,7 +99,7 @@ admin access on the server.

Sudoers File
------------
sshuttle can auto-generate the proper sudoers.d file using the current user
sshuttle can auto-generate the proper sudoers.d file using the current user
for Linux and OSX. Doing this will allow sshuttle to run without asking for
the local sudo password and to give users who do not have sudo access
ability to run sshuttle::
Expand All @@ -79,7 +111,7 @@ it is needed.

A costume user or group can be set with the :
option:`sshuttle --sudoers --sudoers-username {user_descriptor}` option. Valid
values for this vary based on how your system is configured. Values such as
values for this vary based on how your system is configured. Values such as
usernames, groups pre-pended with `%` and sudoers user aliases will work. See
the sudoers manual for more information on valid user specif actions.
The options must be used with `--sudoers`::
Expand Down