Installing a NATS Server

Search…
NATS philosophy is simplicity. Installation is just decompressing a zip file and copying the binary to an appropriate directory; you can also use your favorite package manager. Here's a list of different ways you can install or run NATS:
​Docker​
​Kubernetes​
​Package Manager​
​Release Zip​
​Development Build​
Installing via Docker
With Docker you can install the server easily without scattering binaries and other artifacts on your system. The only pre-requisite is to install docker.
1
docker pull nats:latest
Copied!
To run NATS on Docker:
1
docker run -p 4222:4222 -ti nats:latest
Copied!
which should output
1
[1] 2019/05/24 15:42:58.228063 [INF] Starting nats-server version #.#.#
2
[1] 2019/05/24 15:42:58.228115 [INF] Git commit [#######]
3
[1] 2019/05/24 15:42:58.228201 [INF] Starting http monitor on 0.0.0.0:8222
4
[1] 2019/05/24 15:42:58.228740 [INF] Listening for client connections on 0.0.0.0:4222
5
[1] 2019/05/24 15:42:58.228765 [INF] Server is ready
6
[1] 2019/05/24 15:42:58.229003 [INF] Listening for route connections on 0.0.0.0:6222
Copied!
More information on containerized NATS is available here.
Installing via a Package Manager
On Windows:
1
choco install nats-server
Copied!
On Mac OS:
1
brew install nats-server
Copied!
To test your installation (provided the executable is visible to your shell):
Typing nats-server should output something like
1
[41634] 2019/05/13 09:42:11.745919 [INF] Starting nats-server version 2.*.*
2
[41634] 2019/05/13 09:42:11.746240 [INF] Listening for client connections on 0.0.0.0:4222
3
...
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
Copied!
On Linux:
1
yay nats-server
Copied!
Downloading a Release Build
You can find the latest release of nats-server here.
Download the zip file matching your systems architecture, and unzip. For this example, assuming version 2.6.2 of the server and a Linux AMD64:
1
curl -L https://github.com/nats-io/nats-server/releases/download/v2.0.0/nats-server-v2.6.2-linux-amd64.zip -o nats-server.zip
Copied!
1
unzip nats-server.zip -d nats-server
Copied!
which should output something like
1
Archive:  nats-server.zip
2
   creating: nats-server-v2.6.2-linux-amd64/
3
  inflating: nats-server-v2.6.2-linux-amd64/README.md
4
  inflating: nats-server-v2.6.2-linux-amd64/LICENSE
5
  inflating: nats-server-v2.6.2-linux-amd64/nats-server
Copied!
and finally:
1
sudo cp nats-server/nats-server-v2.6.2-linux-amd64/nats-server /usr/bin
Copied!
Installing From the Source
If you have Go installed, installing the binary is easy:
1
GO111MODULE=on go get github.com/nats-io/nats-server/v2
Copied!
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) by typing nats-server which should output something like
1
[41634] 2019/05/13 09:42:11.745919 [INF] Starting nats-server version 2.6.2
2
[41634] 2019/05/13 09:42:11.746240 [INF] Listening for client connections on 0.0.0.0:4222
3
...
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
Copied!
NATS v2 and Go Modules
If you are having issues when using the recent versions of NATS and Go modules such as:
1
go: github.com/nats-io/[email protected]: parsing go.mod: unexpected module path "github.com/nats-io/nats.go"
2
go: github.com/nats-io/[email protected]: parsing go.mod: unexpected module path "github.com/nats-io/stan.go"
Copied!
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
2
​
3
go 1.12
4
​
5
require (
6
    github.com/nats-io/nats.go v1.8.1
7
    github.com/nats-io/stan.go v0.5.0
8
)
Copied!
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
3
    github.com/nats-io/nats.go v1.8.1
4
)
Copied!
If embedding both NATS Streaming and NATS Servers:
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
)
Copied!
1.Next, update the imports within the repo:
1
find ./ -type f -name "*.go" -exec sed -i -e 's/github.com\/nats-io\/go-nats-streaming/github.com\/nats-io\/stan.go/g' {} \;
2
​
3
find ./ -type f -name "*.go" -exec sed -i -e 's/github.com\/nats-io\/go-nats/github.com\/nats-io\/nats.go/g' {} \;
4
​
5
find ./ -type f -name "*.go" -exec sed -i -e 's/github.com\/nats-io\/gnatsd/github.com\/nats-io\/nats-server\/v2/g' {} \;
6
​
7
find ./ -type f -name "*.go" -exec sed -i -e 's/github.com\/nats-io\/nats-server/github.com\/nats-io\/nats-server\/v2/g' {} \;
Copied!
1.(Recommended) Run Go fmt as the rename will affect the proper ordering of the imports
Gotchas when using go get
When using go get to fetch the client, include an extra slash at the end of the repo. For example:
1
GO111MODULE=on go get github.com/nats-io/nats.go/@latest
2
GO111MODULE=on go get github.com/nats-io/nats.go/@v1.8.1
Copied!
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/[email protected]
Copied!
Otherwise, go get will fetch the v1.4.1 version of the server, which is also named (gnatsd), the previous name for nats-server.
1
GO111MODULE=on go get github.com/nats-io/[email protected]
2
go: finding github.com/nats-io/gnatsd/server latest
3
go: finding golang.org/x/crypto/bcrypt latest
4
go: finding golang.org/x/crypto latest
Copied!
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
3
​
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
15
go: github.com/nats-io/[email protected]: parsing go.mod: unexpected module path "github.com/nats-io/nats.go"
16
go: error loading module requirements
Copied!
For more information you can review the original issue in GitHub.
Running a NATS service - Previous
Installing, running and deploying a NATS Server
Running and deploying a NATS Server
Last modified 1h ago
Export as PDF
Copy link
Edit on GitHub
Contents
Installing via Docker
Installing via a Package Manager
Downloading a Release Build
Installing From the Source
NATS v2 and Go Modules
Gotchas when using go get