Skip to content

Commit

Permalink
Add notes for runtime configuration of keys and users credentials
Browse files Browse the repository at this point in the history
  • Loading branch information
jjcarstens committed Mar 5, 2022
1 parent a5a765b commit 0078f6a
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@ NervesSSH supports the following configuration items:
* `:daemon_option_overrides` - additional options to pass to `:ssh.daemon/2`.
These take precedence and are unchecked.


### SSH host keys

SSH identifies itself to clients using a host key. Clients can record the key
Expand Down Expand Up @@ -161,6 +160,9 @@ config :nerves_ssh,
]
```

See `NervesSSH.add_authorized_key/1` and `NervesSSH.remove_authorized_key/1`
for managing public keys at runtime.

### Username/password authentication

The SSH console uses public key authentication by default, but it can be
Expand All @@ -175,6 +177,10 @@ config :nerves_ssh,
]
```

You can use `NervesSSH.add_user/2` and `NervesSSH.remove_user/1` for managing
credentials at runtime, but they are not saved to disk so restarting `NervesSSH`
will cause them to be lost (such as a reboot or daemon crash)

## Upgrade from `NervesFirmwareSSH`

If you are migrating from `:nerves_firmware_ssh`, or updating to `:nerves_pack
Expand Down Expand Up @@ -210,5 +216,5 @@ If you are migrating from `:nerves_firmware_ssh`, or updating to `:nerves_pack
* [X] Support public key authentication
* [X] Support username/password authentication
* [ ] Device generated server certificate and key
* [X] Device generated server certificate and key
* [ ] Device generated username/password

0 comments on commit 0078f6a

Please sign in to comment.