taigrr/nats.docs
1
0
Fork 0
mirror of https://github.com/taigrr/nats.docs synced 2025-01-18 04:03:23 -08:00
Code Issues Projects Releases Wiki Activity

Streaming: added new auth configuration

Browse Source 
Document the new configuration fields: username, password, token and nkey_seed_file.
Relates to:
https://github.com/nats-io/nats-streaming-server/pull/1100
https://github.com/nats-io/nats-streaming-server/pull/1101

and will be available in the new Streaming release (v0.19.0)
This commit is contained in:
Ivan Kozlovic 2020-10-08 16:39:49 -06:00 committed by GitHub
parent 1a4c1b49c6
commit 1560ea0089
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
nats-streaming-server/configuring/cfgfile.md
View File

@ -74,6 +74,19 @@ In general the configuration parameters are the same as the command line argumen
| encryption\_cipher | Cipher to use for encryption. Currently support AES and CHAHA \(ChaChaPoly\). Defaults to AES | `AES` or `CHACHA` | `encryption_cipher: "AES"` | Depends on platform |
| encryption\_key | Encryption key. It is recommended to specify the key through the `NATS_STREAMING_ENCRYPTION_KEY` environment variable instead | String | `encryption_key: "mykey"` | N/A |
| credentials | Credentials file to connect to external NATS 2.0+ Server | String | `credentials: "streaming_server.creds"` | N/A |
| username | Username to use to connect to NATS Server when authentication with multiple users is enabled | String | `username: "streaming_server"` | N/A |
| password | Password for the above with `username` | String | `password: "password"` | N/A |
| token | Authentication token if the NATS Server requires a token | String | `token: "some_token"` | N/A |
| nkey_seed_file | Path to a NKey seed file (1) if NKey authentication is used | File Path | `nkey_seed_file: "/path/to/some/seedfile"` | N/A |
Notes:
(1) The seed file contains the NKey seed from which the streaming server can extract the public key and the private key used to sign the nonce sent by the NATS Server when accepting connections from the Streaming server. The file is read during the connection process and the key is used to sign but then wiped from memory. The file must contain the seed file with such format:
```
-----BEGIN USER NKEY SEED-----
SU<rest of the seed>
------END USER NKEY SEED------
```
## TLS Configuration