ssh-chat icon indicating copy to clipboard operation
ssh-chat copied to clipboard

Improve documentation

Open Fastidious opened this issue 9 years ago • 1 comments

Is the ssh-chat -h accurate on version 1.4?

Usage:
  ssh-chat [OPTIONS]

Application Options:
  -v, --verbose    Show verbose logging.
      --version    Print version and exit.
  -i, --identity=  Private key to identify server with. (default: ~/.ssh/id_rsa)
      --bind=      Host and port to listen on. (default: 0.0.0.0:2022)
      --admin=     File of public keys who are admins.
      --whitelist= Optional file of public keys who are allowed to connect.
      --motd=      Optional Message of the Day file.
      --log=       Write chat log to this file.
      --pprof=     Enable pprof http server for profiling.

Help Options:
  -h, --help       Show this help message

It differs from the one on the README.

Also, could some extra documentation be added? Where do I get the public keys for those I want as admins? Do they need to send it before hand? For more than one, are there all one after the other on a file? Same questions for whitelist. Thanks!

Fastidious avatar Aug 15 '16 15:08 Fastidious

Might be out of date, would you like to update it?

And yes, you need to get pubkeys out of band to whitelist them. It takes a file in the same format as ~/.ssh/authorized_keys

shazow avatar Aug 16 '16 01:08 shazow