Powered By GitBook
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:
1
curl -L https://raw.githubusercontent.com/nats-io/nsc/master/install.py | python
Copied!
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:
1
$ docker run --rm -it -v $(pwd)/nsc:/nsc synadia/nats-box:latest
2
3
# In case NSC not initialized already:
4
nats-box:~# nsc init
5
nats-box:~# chown -R 1000:1000 /nsc
6
$ tree -L 2 nsc/
7
nsc/
8
├── accounts
9
│ ├── nats
10
│ └── nsc.json
11
└── nkeys
12
├── creds
13
└── keys
14
5 directories, 1 file
Copied!
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:

Tool Documentation

For more specific browsing of the tool syntax, check out the nsc tool documentation. It can be found within the tool itself:
1
> nsc help
Copied!
Or an online version here.
Last modified 4mo ago
Export as PDF
Copy link