nsc
NATS account configurations are built using the nsc
tool. The NSC tool allows you to:
- Create and edit Operators, Accounts, Users
- Manage publish and subscribe permissions for Users
- Define Service and Stream exports from an account
- Reference Service and Streams from another account
- Generate Activation tokens that grants access to a private service or stream
- Generate User credential files
- Describe Operators, Accounts, Users, and Activations
- Push and pull account JWTs to an account JWTs server
Installation
Installing nsc
is easy:
curl -L https://raw.githubusercontent.com/nats-io/nsc/master/install.py | python
The script will download the latest version of nsc
and install it into your system.
Alternatively, you can use nsc
with the nats-box Docker image:
$ docker run --rm -it -v $(pwd)/nsc:/nsc synadia/nats-box:latest
# In case NSC not initialized already:
nats-box:~# nsc init
nats-box:~# chown -R 1000:1000 /nsc
$ tree -L 2 nsc/
nsc/
├── accounts
│ ├── nats
│ └── nsc.json
└── nkeys
├── creds
└── keys
5 directories, 1 file
IMPORTANT: nsc
version 2.2.0 has been released. This version of nsc only supports nats-server
v2.2.0 and nats-account-server
v1.0.0. For more information please refer to the nsc 2.2.0 release notes.
Tutorials
You can find various task-oriented tutorials to working with the tool here:
- Basic Usage
- Configuring Streams
- Configuring Services
- Signing Keys
- Revoking Users or Activations
- Working with Managed Operators
Tool Documentation
For more specific browsing of the tool syntax, check out the nsc
tool documentation. It can be found within the tool itself:
> nsc help
Or an online version here.