Add NATS Streaming
This is documentation for NATS Streaming server. See https://github.com/docker-library/official-images/pull/2036
This commit is contained in:
parent
9a832e3b61
commit
4a2d30cdf4
|
|
@ -0,0 +1 @@
|
|||
NATS Streaming is an open-source, high-performance, cloud native messaging streaming system.
|
||||
|
|
@ -0,0 +1,120 @@
|
|||
# [NATS Streaming](https://nats.io): A high-performance cloud native messaging streaming system.
|
||||
|
||||
%%LOGO%%
|
||||
|
||||
`nats-streaming` is a high performance streaming server for the NATS Messaging System.
|
||||
|
||||
# Example usage
|
||||
|
||||
```bash
|
||||
# Run a NATS Streaning server
|
||||
# Each server exposes multiple ports
|
||||
# 4222 is for clients.
|
||||
# 8222 is an HTTP management port for information reporting.
|
||||
# use -p or -P as needed.
|
||||
|
||||
$ docker run -d nats-streaming
|
||||
|
||||
Output that you would get if you had started with `-ti` instead of `d` (for daemon):
|
||||
|
||||
[INF] Starting nats-streaming-server[test-cluster] version 0.2.2
|
||||
[INF] Starting nats-server version 0.9.2
|
||||
[INF] Starting http monitor on :8222
|
||||
[INF] Listening for client connections on 0.0.0.0:4222
|
||||
[INF] Server is ready
|
||||
[INF] STAN: Message store is MEMORY
|
||||
[INF] STAN: Maximum of 1000000 will be stored
|
||||
|
||||
To use a file based store instead, you would run:
|
||||
|
||||
$ docker run -d nats-streaming -store file -dir datastore
|
||||
|
||||
[INF] Starting nats-streaming-server[test-cluster] version 0.2.2
|
||||
[INF] Starting nats-server version 0.9.2
|
||||
[INF] Starting http monitor on :8222
|
||||
[INF] Listening for client connections on 0.0.0.0:4222
|
||||
[INF] Server is ready
|
||||
[INF] STAN: Message store is FILE
|
||||
[INF] STAN: Maximum of 1000000 will be stored
|
||||
|
||||
You can also connect to a remote NATS Server running in a docker image.
|
||||
First, run NATS Server:
|
||||
|
||||
$ docker run -d --name=nats-main nats
|
||||
|
||||
Now, start the Streaming server and link it to the above docker image:
|
||||
|
||||
$ docker run -d --link nats-main nats-streaming -ns nats://nats-main:4222
|
||||
|
||||
[INF] Starting nats-streaming-server[test-cluster] version 0.2.2
|
||||
[INF] STAN: Message store is MEMORY
|
||||
[INF] STAN: Maximum of 1000000 will be stored
|
||||
|
||||
Notice that the output shows that the NATS Server was not started, as opposed to the first output.
|
||||
|
||||
```
|
||||
|
||||
# Commandline Options
|
||||
|
||||
```bash
|
||||
Streaming Server Options:
|
||||
-cid, --cluster_id <cluster ID> Cluster ID (default: test-cluster)
|
||||
-st, --store <type> Store type: MEMORY|FILE (default: MEMORY)
|
||||
--dir <directory> For FILE store type, this is the root directory
|
||||
-mc, --max_channels <number> Max number of channels (aka subjects, topics, etc...)
|
||||
-msu, --max_subs <number> Max number of subscriptions per channel
|
||||
-mm, --max_msgs <number> Max number of messages per channel
|
||||
-mb, --max_bytes <number> Max messages total size per channel
|
||||
-ns, --nats_server <url> Connect to this external NATS Server (embedded otherwise)
|
||||
|
||||
Streaming Server TLS Options:
|
||||
-secure Use a TLS connection to the NATS server without
|
||||
verification; weaker than specifying certificates.
|
||||
-tls_client_key Client key for the streaming server
|
||||
-tls_client_cert Client certificate for the streaming server
|
||||
-tls_client_cacert Client certificate CA for the streaming server
|
||||
|
||||
Streaming Server Logging Options:
|
||||
-SD, --stan_debug Enable STAN debugging output
|
||||
-SV, --stan_trace Trace the raw STAN protocol
|
||||
-SDV Debug and trace STAN
|
||||
(See additional NATS logging options below)
|
||||
|
||||
Embedded NATS Server Options:
|
||||
-a, --addr <host> Bind to host address (default: 0.0.0.0)
|
||||
-p, --port <port> Use port for clients (default: 4222)
|
||||
-P, --pid <file> File to store PID
|
||||
-m, --http_port <port> Use port for http monitoring
|
||||
-ms,--https_port <port> Use port for https monitoring
|
||||
-c, --config <file> Configuration file
|
||||
|
||||
Logging Options:
|
||||
-l, --log <file> File to redirect log output
|
||||
-T, --logtime Timestamp log entries (default: true)
|
||||
-s, --syslog Enable syslog as log method
|
||||
-r, --remote_syslog <addr> Syslog server addr (udp://localhost:514)
|
||||
-D, --debug Enable debugging output
|
||||
-V, --trace Trace the raw protocol
|
||||
-DV Debug and trace
|
||||
|
||||
Authorization Options:
|
||||
--user <user> User required for connections
|
||||
--pass <password> Password required for connections
|
||||
--auth <token> Authorization token required for connections
|
||||
|
||||
TLS Options:
|
||||
--tls Enable TLS, do not verify clients (default: false)
|
||||
--tlscert <file> Server certificate file
|
||||
--tlskey <file> Private key for server certificate
|
||||
--tlsverify Enable TLS, very client certificates
|
||||
--tlscacert <file> Client certificate CA for verification
|
||||
|
||||
NATS Clustering Options:
|
||||
--routes <rurl-1, rurl-2> Routes to solicit and connect
|
||||
--cluster <cluster-url> Cluster URL for solicited routes
|
||||
|
||||
Common Options:
|
||||
-h, --help Show this message
|
||||
-v, --version Show version
|
||||
--help_tls TLS help.
|
||||
```
|
||||
|
|
@ -0,0 +1 @@
|
|||
https://github.com/nats-io/nats-streaming-docker
|
||||
|
|
@ -0,0 +1 @@
|
|||
View [license information](https://github.com/nats-io/nats-streaming-server/blob/master/LICENSE) for the software contained in this image.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 4.4 KiB |
Loading…
Reference in New Issue