Installing

    With Docker you can install the server easily without scattering binaries and other artifacts on your system. The only pre-requisite is to .

    To run NATS on Docker:

    1. > docker run -p 4222:4222 -ti nats:latest
    2. [1] 2019/05/24 15:42:58.228063 [INF] Starting nats-server version #.#.#
    3. [1] 2019/05/24 15:42:58.228115 [INF] Git commit [#######]
    4. [1] 2019/05/24 15:42:58.228201 [INF] Starting http monitor on 0.0.0.0:8222
    5. [1] 2019/05/24 15:42:58.228740 [INF] Listening for client connections on 0.0.0.0:4222
    6. [1] 2019/05/24 15:42:58.228765 [INF] Server is ready
    7. [1] 2019/05/24 15:42:58.229003 [INF] Listening for route connections on 0.0.0.0:6222

    More information on containerized NATS is available here.

    On Windows:

    1. > choco install nats-server

    On Mac OS:

    1. > brew install nats-server

    To test your installation (provided the executable is visible to your shell):

    1. > nats-server
    2. [41634] 2019/05/13 09:42:11.745919 [INF] Starting nats-server version 2.0.0
    3. [41634] 2019/05/13 09:42:11.746240 [INF] Listening for client connections on 0.0.0.0:4222
    4. [41634] 2019/05/13 09:42:11.746249 [INF] Server id is NBNYNR4ZNTH4N2UQKSAAKBAFLDV3PZO4OUYONSUIQASTQT7BT4ZF6WX7
    5. [41634] 2019/05/13 09:42:11.746252 [INF] Server is ready

    You can find the latest release of nats-server .

    If you have Go installed, installing the binary is easy:

    1. > GO111MODULE=on go get github.com/nats-io/nats-server/v2

    This mechanism will install a build of master, which almost certainly will not be a released version. If you are a developer and want to play with the latest, this is the easiest way.

    To test your installation (provided the $GOPATH/bin is set):

    1. > nats-server
    2. [41634] 2019/05/13 09:42:11.745919 [INF] Starting nats-server version 2.0.0
    3. [41634] 2019/05/13 09:42:11.746240 [INF] Listening for client connections on 0.0.0.0:4222
    4. ...
    5. [41634] 2019/05/13 09:42:11.746249 [INF] Server id is NBNYNR4ZNTH4N2UQKSAAKBAFLDV3PZO4OUYONSUIQASTQT7BT4ZF6WX7
    6. [41634] 2019/05/13 09:42:11.746252 [INF] Server is ready

    If you are having issues when using the recent versions of NATS and Go modules such as:

    1. go: github.com/nats-io/go-nats@v1.8.1: parsing go.mod: unexpected module path "github.com/nats-io/nats.go"

    To fix it:

    1) Update your go.mod using the latest tags, for example for both NATS and NATS Streaming clients:

    1. module github.com/wallyqs/hello-nats-go-mod
    3. go 1.12
    5. require (
    6.     github.com/nats-io/nats.go v1.8.1
    7.     github.com/nats-io/stan.go v0.5.0
    8. )

    Or if you want to import the NATS Server v2 to embed it, notice the /v2 after the nats-server module name. If that is not present, then go modules will not fetch it and would accidentally end up with 1.4.1 version of the server.

    1. require (
    2.     github.com/nats-io/nats-server/v2 v2.0.0 // indirect
    3.     github.com/nats-io/nats-streaming-server v0.15.1
    4. )

    2) Next, update the imports within the repo:

    2. find ./ -type f -name "*.go" -exec sed -i -e 's/github.com\/nats-io\/go-nats/github.com\/nats-io\/nats.go/g' {} \;
    4. find ./ -type f -name "*.go" -exec sed -i -e 's/github.com\/nats-io\/gnatsd/github.com\/nats-io\/nats-server\/v2/g' {} \;
    6. find ./ -type f -name "*.go" -exec sed -i -e 's/github.com\/nats-io\/nats-server/github.com\/nats-io\/nats-server\/v2/g' {} \;

    3) (Recommended) Run Go fmt as the rename will affect the proper ordering of the imports

    When using go get to fetch the client, include an extra slash at the end of the repo. For example:

    2. GO111MODULE=on go get github.com/nats-io/nats.go/@v1.8.1

    When trying to fetch the latest version of the server with go get, you have to add v2 at the end:

    1. GO111MODULE=on go get github.com/nats-io/nats-server/v2@latest

    Otherwise, go get will fetch the v1.4.1 version of the server, which is also named (gnatsd), the previous name for nats-server.

    In order to use an older tag, you will have to use the previous name (gnatsd) otherwise it will result in go mod parsing errors.

    1. # OK
    2. GO111MODULE=on go get github.com/nats-io/go-nats/@v1.7.2
    4. # Not OK
    5. GO111MODULE=on go get github.com/nats-io/nats.go/@v1.7.2
    6. go: finding github.com/nats-io/nats.go v1.7.2
    7. go: downloading github.com/nats-io/nats.go v1.7.2
    8. go: extracting github.com/nats-io/nats.go v1.7.2
    9. go: finding github.com/nats-io/go-nats/encoders/builtin latest
    10. go: finding github.com/nats-io/go-nats/util latest
    11. go: finding github.com/nats-io/go-nats/encoders latest
    12. go: finding github.com/nats-io/go-nats v1.8.1
    13. go: downloading github.com/nats-io/go-nats v1.8.1
    14. go: extracting github.com/nats-io/go-nats v1.8.1

    For more information you can review the original issue in .