From 87ac0b0f129c69d30d72d87b169f7e2558cae669 Mon Sep 17 00:00:00 2001 From: Bryan Ashby Date: Sun, 4 Nov 2018 20:14:54 -0700 Subject: [PATCH] Notes on algorithms --- docs/servers/ssh.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/servers/ssh.md b/docs/servers/ssh.md index 676afb51..51471e28 100644 --- a/docs/servers/ssh.md +++ b/docs/servers/ssh.md @@ -16,10 +16,10 @@ You then need to enable the SSH server in your `config.hjson`: { loginServers: { ssh: { - enabled: true + enabled: true port: 8889 privateKeyPem: /path/to/ssh_private_key.pem - privateKeyPass: YOUR_PK_PASS + privateKeyPass: YOUR_PK_PASS } } } @@ -29,9 +29,11 @@ You then need to enable the SSH server in your `config.hjson`: | Option | Description |---------------------|--------------------------------------------------------------------------------------| -| `privateKeyPem` | Path to private key file -| `privateKeyPass` | Password to private key file -| `firstMenu` | First menu an SSH connected user is presented with -| `firstMenuNewUser` | Menu presented to user when logging in with `users::newUserNames` in your config.hjson (defaults to `new` and `apply`) -| `enabled` | Enable/disable SSH server -| `port` | Configure a custom port for the SSH server +| `privateKeyPem` | Path to private key file. +| `privateKeyPass` | Password to private key file. +| `firstMenu` | First menu an SSH connected user is presented with. +| `firstMenuNewUser` | Menu presented to user when logging in with `users::newUserNames` in your config.hjson (defaults to `new` and `apply`). +| `enabled` | Enable/disable SSH server. +| `port` | Configure a custom port for the SSH server. +| `algorithms` | Configuration block for SSH algoritms. Includes arrays with keys of `kex`, `cipher`, `hmac`, and `compress`. See the algorithms section in the [ssh2-streams](https://github.com/mscdex/ssh2-streams#ssh2stream-methods) documentation for details. For defaults set by ENiGMA½, see `core/config.js`. +| `traceConnections` | Set to `true` to enable full trace-level information on SSH connections.