Merge pull request #1146 from nats-io/master

[nats-streaming] Fix documentation typos
This commit is contained in:
Tianon Gravi 2018-02-07 16:03:59 -08:00 committed by GitHub
commit 78e2ba475a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 3 deletions

View File

@ -4,18 +4,38 @@
`nats-streaming` is a high performance streaming server for the NATS Messaging System.
# Windows Docker image
# Windows Docker images
Due to restrictions on how the Windows Docker Image is built, running the image without argument will run the NATS Streaming server with memory based store on port 4222 and the monitoring port 8222. If you need to specify any additional argument, or modify these options, you need to specify the executable name as this:
```bash
$ docker run nats-streaming-server nats-streaming-server -p 4223 -m 8223
$ docker run %%IMAGE%% nats-streaming-server -p 4223 -m 8223
```
If you need to specify the entrypoint:
```bash
$ docker run --entrypoint c:/nats-streaming-server/nats-streaming-server %%IMAGE%%
```
# Non Windows Docker images
If you need to provide arguments to the NATS Streaming server, just pass them to the command line. For instance, to change the listen and monitoring port to 4223 and 8223 respectively:
```bash
$ docker run %%IMAGE%% -p 4223 -m 8223
```
If you need to specify the entrypoint:
```bash
$ docker run --entrypoint /nats-streaming-server %%IMAGE%%
```
# Example usage
```bash
# Run a NATS Streaning server
# Run a NATS Streaming server
# Each server exposes multiple ports
# 4222 is for clients.
# 8222 is an HTTP management port for information reporting.