Metadata-Version: 2.1
Name: sshconfig
Version: 2.2
Summary: SSH config file generator
Home-page: https://sshconfig.readthedocs.io
Download-URL: https://github.com/kenkundert/sshconfig/tarball/master
Author: Ken Kundert
Author-email: sshconfig@nurdletech.com
License: GPLv3+
Keywords: ssh
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE

SSH Config — SSH Adapts to Your Current Network
===============================================

.. image:: https://pepy.tech/badge/sshconfig/month
    :target: https://pepy.tech/project/sshconfig

.. image:: https://img.shields.io/readthedocs/sshconfig.svg
   :target: https://sshconfig.readthedocs.io/en/latest/?badge=latest

.. image:: https://img.shields.io/pypi/v/sshconfig.svg
    :target: https://pypi.python.org/pypi/sshconfig

.. image:: https://img.shields.io/pypi/pyversions/sshconfig.svg
    :target: https://pypi.python.org/pypi/sshconfig/


:Author: Ken Kundert
:Version: 2.2
:Released: 2022-11-19


Installation
------------

Requires Python3.6 or newer.

You can download and install the latest
stable version of the code from `PyPI <https://pypi.python.org>`_ using::

    pip3 install --user sshconfig

You can find the latest development version of the source code on
`Github <https://github.com/KenKundert/sshconfig>`_.


Introduction
------------

SSH Config generates an SSH config file adapted to the network you are currently 
using.  In this way, you always use the fastest paths available for your SSH 
related activities (sshfs, email, vnc, mercurial, etc.). You can also easily 
reconfigure SSH to make use of proxies as needed or select certain servers or 
ports based on your location or restrictions with the network.

The following situations are supported:

#. You may give the mac address or addresses for your router or routers and your 
   network will automatically be recognized.
#. You can configure which hostname or IP address is used for a particular host 
   depending on which network you are on. In this way you always use the fastest 
   connection available for each host.
#. You can specify that certain hosts are hidden behind other hosts, so that 
   a SSH proxy should be used to access them.
#. You can specify port forwarding information for each host. Then, two SSH 
   configurations will be created for those hosts, one that includes port 
   forwarding and one that does not. That way, once the port forwards are 
   established, you can open additional shells on that host without SSH trying 
   to create conflicting port forwards.
#. You can enter multiple hostnames or IP addresses and give their locations.  
   Then, if you specify your location, the closest server will be used 
   automatically.
#. You can specify proxy configurations and specify that one should be used for 
   all hosts not on your current network.
#. You can specify port restrictions and have SSH work around them if possible 
   (if your server supports alternative ports).
#. You can configure a default location, proxy, or set of port restrictions for 
   each of your known networks.
#. Once host names are defined, they do not change even though you are using 
   different configurations (different networks, locations, proxies, and port 
   restrictions). In this way you can hard code your host names in applications 
   such as Mercurial or Git, and they automatically adapt to your existing 
   network.
#. The entire application, including the configuration files, are Python code, 
   so you have considerable freedom to change the configuration based on things 
   like the name of the machine or the user when generating the SSH config file.

Documentation
-------------

You can find documentation at `ReadTheDocs <https://sshconfig.readthedocs.io>`_.


Issues
------

Please ask questions or report problems on
`Github Issues <https://github.com/KenKundert/sshconfig/issues>`_.


Contributions
-------------

Contributions in the form of pull requests are welcome.
