Skip to content

Commit

Permalink
docs: udpate CHANGELOG.md and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
windvalley committed Feb 12, 2022
1 parent 2bfed5e commit f5f9fda
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 9 deletions.
27 changes: 27 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [1.11.0]

### Changed

- Optimize subcommand `config`.

- Update configuration demo file `configs/gossh.yaml`.

- Optimize examples of subcommands.

- Change default tmp dir for subcommand `fetch`.
Default value of flag `-t, --tmp-dir` changed from `/tmp` to `$HOME`.

- Optimize the priority of the ssh authentication methods.
Old: `password > pubkey > ssh-agent`,
New: `ssh-agent > pubkey > password`.
For details at ([#31](https://github.com/windvalley/gossh/issues/31)).

- Optimize description of flag `--timeout.command`.

### Fixed

- Fix a bug about ssh authentication. The bug description:
When attempting ssh-agent fails, pubkey authentication is skipped and password authentication is used directly.

- Fix a bug about ssh-agent authentication method about proxy server.

## [1.10.0]

### Added
Expand Down
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ Feel free to open a new issue if you have any issues, questions or suggestions a
- Auto detect following authentication methods for the login user(default `$USER`):
`Password`: from inventory file, or from flag `-k/--auth.ask-pass`,`-p/--auth.password`,`-a/--auth.pass-file`, or from configuration file.
`Pubkey Authentication`: by identity files(default `$HOME/.ssh/{id_rsa,id_dsa}`), also include that with passphrase.
`SSH-Agent Authentication`: through the system environment variable `$SSH_AUTH_SOCK`.
`SSH-Agent Authentication`: through the system environment variable `$SSH_AUTH_SOCK`.
If the above three authentication methods are valid at the same time, the priority order is: `SSH-Agent` > `Pubkey` > `Password`.

- Provide the target hosts by:
Hosts/host-patterns/host-group-names as positional arguments separated by space.
Expand Down Expand Up @@ -123,9 +124,7 @@ $ make && make install
$ gossh -h
Gossh is a high-performance and high-concurrency ssh tool.
This tool can efficiently manage tens of thousands of Linux server clusters.
It can efficiently execute commands or a local shell script on target hosts,
push files and dirs to target hosts, and fetch files and dirs from target hosts to local.
It can efficiently manage tens of thousands of Linux server clusters.
Find more information at: https://github.com/windvalley/gossh
Expand All @@ -135,8 +134,8 @@ Usage:
Available Commands:
command Execute commands on target hosts
script Execute a local shell script on target hosts
push Copy local files/dirs to target hosts
fetch Copy files/dirs from target hosts to local
push Copy local files and dirs to target hosts
fetch Copy files and dirs from target hosts to local
vault Encryption and decryption utility
config Generate gossh configuration file
version Show gossh version information
Expand Down Expand Up @@ -173,9 +172,7 @@ Flags:
(default same as 'auth.passphrase')
--timeout.task int timeout seconds for the entire gossh task
--timeout.conn int timeout seconds for connecting each target host (default 10)
--timeout.command int timeout seconds for executing commands/script on each target host
or copying local files and dirs to each target host
or copying files and dirs from each target host to local
--timeout.command int timeout seconds for handling each target host
--config string config file (default {$PWD,$HOME}/.gossh.yaml)
-h, --help help for gossh
Expand Down

0 comments on commit f5f9fda

Please sign in to comment.