diff --git a/nats-streaming/README-short.txt b/nats-streaming/README-short.txt new file mode 100644 index 000000000..3568f89f2 --- /dev/null +++ b/nats-streaming/README-short.txt @@ -0,0 +1 @@ +NATS Streaming is an open-source, high-performance, cloud native messaging streaming system. diff --git a/nats-streaming/content.md b/nats-streaming/content.md new file mode 100644 index 000000000..7fcd223d6 --- /dev/null +++ b/nats-streaming/content.md @@ -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 (default: test-cluster) + -st, --store Store type: MEMORY|FILE (default: MEMORY) + --dir For FILE store type, this is the root directory + -mc, --max_channels Max number of channels (aka subjects, topics, etc...) + -msu, --max_subs Max number of subscriptions per channel + -mm, --max_msgs Max number of messages per channel + -mb, --max_bytes Max messages total size per channel + -ns, --nats_server 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 Bind to host address (default: 0.0.0.0) + -p, --port Use port for clients (default: 4222) + -P, --pid File to store PID + -m, --http_port Use port for http monitoring + -ms,--https_port Use port for https monitoring + -c, --config Configuration file + +Logging Options: + -l, --log File to redirect log output + -T, --logtime Timestamp log entries (default: true) + -s, --syslog Enable syslog as log method + -r, --remote_syslog 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 required for connections + --pass Password required for connections + --auth Authorization token required for connections + +TLS Options: + --tls Enable TLS, do not verify clients (default: false) + --tlscert Server certificate file + --tlskey Private key for server certificate + --tlsverify Enable TLS, very client certificates + --tlscacert Client certificate CA for verification + +NATS Clustering Options: + --routes Routes to solicit and connect + --cluster Cluster URL for solicited routes + +Common Options: + -h, --help Show this message + -v, --version Show version + --help_tls TLS help. +``` diff --git a/nats-streaming/github-repo b/nats-streaming/github-repo new file mode 100644 index 000000000..a58594919 --- /dev/null +++ b/nats-streaming/github-repo @@ -0,0 +1 @@ +https://github.com/nats-io/nats-streaming-docker diff --git a/nats-streaming/license.md b/nats-streaming/license.md new file mode 100644 index 000000000..316d32e6b --- /dev/null +++ b/nats-streaming/license.md @@ -0,0 +1 @@ +View [license information](https://github.com/nats-io/nats-streaming-server/blob/master/LICENSE) for the software contained in this image. diff --git a/nats-streaming/logo.png b/nats-streaming/logo.png new file mode 100644 index 000000000..c81574f8a Binary files /dev/null and b/nats-streaming/logo.png differ