What do you want to connect today?
We appreciate you signing up for NGS. In a few short steps we'll have you up and running and sending messages.
Installation of the NGS and NSC utilities
NGS depends on two command line tools. The first, called nsc, is an open source tool used to create and edit configurations for the NATS.io account security system. This is the same system used by NGS. The second, called ngs, is used to manage your billing account with Synadia.
The installation process is straightforward. Open up a command prompt and type the following:
$ curl https://downloads.synadia.com/ngs/install.py -sSf | python
This will install the nsc and ngs utilities into ~/.nsc/bin. You can get usage help anytime by executing ngs -h or nsc -h, or search the nsc documentation.
Next we need to tell NSC about Synadia, create an account and user and deploy the account to the NGS servers. To create a new account named "First" (you can use any name here) and deploy it to NGS, open a command prompt and type:
$ nsc init -o synadia -n First
This will import Synadia's operator information, create an account and user named "First" on your local system, deploy the account to NGS, create a billing account on NGS for you and associate it with a free plan. This free plan allows you to use NGS but places some limits on your connections. You can check your limits using:
$ ngs status
The signup process will also generate the necessary credentials to access your account on NGS. To test that everything is working, let's send our first message with one of the tools built into nsc.
$ nsc tool req ngs.echo <some text>
NGS provides three demonstration services to new accounts through a set of automated imports added to your account JWT when you upload it. These services can be accessed with the `nsc` tool as follows:
> nsc tool req ngs.echo HELLO
Published [ngs.echo] : 'HELLO'
Received [_INBOX.IUAKVmH8SZfgJc6M666obM.wn1hGbsk] : '[California, US]: "HELLO"'
Congratulations! You have successfully registered with NGS and sent your first message on the NGS secure global messaging system.
If you are using a version of nsc installed by other means (homebrew, built from source, etc), you may run into issues due to a version mismatch between NGS and the nsc tooling. If you encounter an error related to an unexpected ed25519 key algorithm, or "Error: this version of nsc (x.x.x) is incompatible with the provided jwt v1" set nsc to version 0.5.0.
$ nsc update --version 0.5.0
If you need additional help please contact us at email@example.com.
Paid Plans and Account Limits
You can expand the limits applied to your account by updating to a paid plan. Synadia even offers a "free" paid plan that requires an email and credit card, but doesn't cost anything. In addition to finding plan information on synadia.com/ngs/pricing, you can view information about current plans locally with the following command:
$ ngs plans
You'll see the list of available plans, select the one that most closely matches your requirements. If your needs exceed any of the plans listed, contact us at firstname.lastname@example.org and we’d be happy to help create a custom plan for you. To move to a new plan, type:
$ ngs edit
Follow the instructions, and once you complete the steps, check your email, within a minute or so you will receive an email with a link to a secure payment page. There you can enter your payment information and upgrade your account. You can check your account status with:
$ ngs status
Information about your NGS billing account status will be displayed. We bill on a monthly basis, so you will see a four week expiry, which will be renewed on the next automatic credit card payment.
NGS provides three demonstration services (echo, usage, active) to new accounts through a set of automated imports added to your account JWT when you upload it. These services can be accessed with the nsc tool as follows:
As we saw earlier, the echo service returns what you send it, a standard NATS request.
$ nsc tool req ngs.echo Hello
The usage service shows an approximation of your account-wide data usage.
$ nsc tool req ngs.usage ''
The active service sends out a message stream you can subscribe to. Messages indicate known servers based on various locations in the NGS cluster.
$ nsc tool sub ngs.active
In all three cases, the operator should be synadia, and the account and user should be the ones you want to use to run the tool. Keep in mind that these services are only available when you are connecting to NGS and not when you run locally.