Mr_Steppy/multi-ssh
1
0
Fork 0
Code Issues 8 Pull Requests 1 Actions Packages Projects Releases 1 Wiki Activity

Update README.md

Browse Source 
Improve configuration section and add building from source section
This commit is contained in:
Leonard Steppy 2024-12-14 17:58:13 +01:00
parent d48fa4d489
commit 375ecb386b
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -4,7 +4,14 @@ An application to upload a file or perform a command on multiple servers via ssh
## Configuration
Set the environment variable `MSSH_SERVERS` to configure the server directories of your ssh servers
Set the environment variable `MSSH_SERVERS` to configure the server directories of your ssh servers.
Furthermore, ensure that in your shell the following commands are set up and working:
- ssh
- scp
- ssh-agent
- ssh-add
Ergo you should be able to connect to your desired servers via ssh and be able to start an ssh agent.
### Linux example
@ -50,3 +57,13 @@ For detailed usage of the upload feature see
```bash
multi-ssh -u --help
```
## Building from source
This is a rust project so you will need [rustup and cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html).
Once you have that installed, just run
```bash
cargo build --release
```
and you will find an executable in `target/release`.