README.md

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

Additional ways of installing nsc are described at nsc's github repository

The script will download the latest version of nsc and install it into your system.

In case NSC is not initialized already do nsc init

Output of 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 Account Streams Import/Export
• Configuring Account Services Import/Export
• 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.