1 |
1 |
2 = symphony-ssh |
2 symphony-ssh |
|
3 ############ |
3 |
4 |
4 == Description |
5 Description |
|
6 ------------ |
5 |
7 |
6 This is a small collection of base classes used for interacting with |
8 This is a small collection of base classes used for interacting with |
7 remote machines over ssh. With them, you can use AMQP (via Symphony) to |
9 remote machines over ssh. With them, you can use AMQP (via Symphony) to |
8 run batch commands, execute templates as scripts, and perform any |
10 run batch commands, execute templates as scripts, and perform any |
9 batch/remoting stuff you can think of without the need of a separate |
11 batch/remoting stuff you can think of without the need of a separate |
42 **NOTE**: If you've upgrade from a version pre 0.2.0, the |
45 **NOTE**: If you've upgrade from a version pre 0.2.0, the |
43 Configurability path has changed from `symphony_ssh`, to an `ssh` key |
46 Configurability path has changed from `symphony_ssh`, to an `ssh` key |
44 under the `symphony` top level. |
47 under the `symphony` top level. |
45 |
48 |
46 |
49 |
47 === path |
50 ### path |
48 |
51 |
49 The absolute path to the ssh binary. |
52 The absolute path to the ssh binary. |
50 |
53 |
51 === user |
54 ### user |
52 |
55 |
53 The default user to connect to remote hosts with. This can be |
56 The default user to connect to remote hosts with. This can be |
54 changed per connection in the AMQP payload. |
57 changed per connection in the AMQP payload. |
55 |
58 |
56 === key |
59 ### key |
57 |
60 |
58 An absolute path to a password-less ssh private key. |
61 An absolute path to a password-less ssh private key. |
59 |
62 |
60 === opts |
63 ### opts |
61 |
64 |
62 SSH client options, passed to the ssh binary on the command line. Note |
65 SSH client options, passed to the ssh binary on the command line. Note |
63 that the defaults have been tested fairly extensively, these are just |
66 that the defaults have been tested fairly extensively, these are just |
64 exposed if you have very specific needs and you know what you're doing. |
67 exposed if you have very specific needs and you know what you're doing. |
65 |
68 |
66 |
69 |
67 == Installation |
70 Installation |
|
71 ------------- |
68 |
72 |
69 gem install symphony-ssh |
73 gem install symphony-ssh |
70 |
74 |
71 |
75 |
72 == Contributing |
76 Contributing |
|
77 ------------ |
73 |
78 |
74 You can check out the current development source with Mercurial via its |
79 You can check out the current development source with Mercurial |
75 {project page}[http://bitbucket.org/mahlon/symphony-ssh]. |
80 [here](http://code.martini.nu/symphony-ssh), or via a mirror: |
|
81 |
|
82 * github: https://github.com/mahlonsmith/Symphony-SSH |
|
83 * SourceHut: https://hg.sr.ht/~mahlon/Symphony-SSH |
76 |
84 |
77 After checking out the source, run: |
85 After checking out the source, run: |
78 |
86 |
79 $ rake |
87 $ rake |
80 |
88 |
82 |
90 |
83 If you use {rvm}[http://rvm.io/], entering the project directory will |
91 If you use {rvm}[http://rvm.io/], entering the project directory will |
84 install any required development dependencies. |
92 install any required development dependencies. |
85 |
93 |
86 |
94 |
87 == License |
95 License |
|
96 ------- |
88 |
97 |
89 Copyright (c) 2014-2018, Mahlon E. Smith and Michael Granger |
98 Copyright (c) 2014-2018, Mahlon E. Smith and Michael Granger |
90 All rights reserved. |
99 All rights reserved. |
91 |
100 |
92 Redistribution and use in source and binary forms, with or without |
101 Redistribution and use in source and binary forms, with or without |