Skip to content

Commit 19c39e1

Browse files
author
Dan
committed
Updated readme
1 parent 259fc5d commit 19c39e1

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.rst

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,13 +75,19 @@ Frequently asked questions
7575
Is Windows supported?
7676

7777
:A:
78-
The library installs and works on Windows though not formally supported as unit tests are currently posix system only. Pip versions >= 8.0 are required for binary package installation of `gevent` on Windows, a dependency of `ParallelSSH`. Though `ParallelSSH` is pure python code and will run on any platform that has a working Python interpreter, its `gevent` dependency contains native code which either needs a binary package to be provided for the platform or to be built from source. Binary packages for `gevent` are provided for OSX, Linux and Windows platforms as of this time of writing.
78+
The library installs and works on Windows though not formally supported as unit tests are currently posix system only.
79+
80+
Pip versions >= 8.0 are required for binary package installation of `gevent` on Windows, a dependency of `ParallelSSH`.
81+
82+
Though `ParallelSSH` is pure python code and will run on any platform that has a working Python interpreter, its `gevent` dependency contains native code which either needs a binary package to be provided for the platform or to be built from source. Binary packages for `gevent` are provided for OSX, Linux and Windows platforms as of this time of writing.
7983

8084
:Q:
8185
Are SSH agents used?
8286

8387
:A:
84-
All available keys in a running SSH agent in addition to SSH keys in the user's home directory, `~/.ssh/id_dsa`, `~/.ssh/id_rsa` et al are automatically used by ParallelSSH. Use of SSH agent can be disabled by creating a client as `ParallelSSHClient(allow_agent=False)`. `See documentation <http://parallel-ssh.readthedocs.org/en/latest/>`_ for more information.
88+
All available keys in a system configured SSH agent in addition to SSH keys in the user's home directory, `~/.ssh/id_dsa`, `~/.ssh/id_rsa` et al are automatically used by ParallelSSH.
89+
90+
Use of SSH agent can be disabled by creating a client as `ParallelSSHClient(allow_agent=False)`. `See documentation <http://parallel-ssh.readthedocs.org/en/latest/>`_ for more information.
8591

8692
:Q:
8793
Can ParallelSSH forward my SSH agent?
@@ -105,14 +111,15 @@ Frequently asked questions
105111
Is there a way to programmatically provide an SSH key?
106112

107113
:A:
108-
Yes, use the `pkey` parameter of the `ParallelSSHClient class <http://parallel-ssh.readthedocs.org/en/latest/#pssh.ParallelSSHClient>`_. For example:
114+
Yes, use the `pkey` parameter of the `ParallelSSHClient class <http://parallel-ssh.readthedocs.org/en/latest/#pssh.ParallelSSHClient>`_. There is a `load_private_key` helper function in `pssh.utils` that can be used to load any key type. For example:
109115

110-
>>> import paramiko
111-
>>> client_key = paramiko.RSAKey.from_private_key_file('user.key')
116+
>>> from pssh import ParallelSSHClient, utils
117+
>>> client_key = utils.load_private_key('user.key')
112118
>>> client = ParallelSSHClient(['myhost1', 'myhost2'], pkey=client_key)
113119

114120
:Q:
115121
Is there a user's group for feedback and discussion about ParallelSSH?
122+
116123
:A:
117124
There is a public `ParallelSSH Google group <https://groups.google.com/forum/#!forum/parallelssh>`_ setup for this purpose - both posting and viewing are open to the public.
118125

0 commit comments

Comments
 (0)