SUMMARY.md

Table of contents

• Welcome

Release Notes

• What's New!
  • NATS 2.2
  • NATS 2.0

NATS Concepts

• Overview
  • Compare NATS
• What is NATS
  • Walkthrough Setup
• Subject-Based Messaging
• Core NATS
  • Publish-Subscribe
    • Pub/Sub Walkthrough
  • Request-Reply
    • Request-Reply Walkthrough
  • Queue Groups
    • Queueing Walkthrough
• JetStream
  • Streams
  • Consumers
    • Example
  • JetStream Walkthrough
  • Key/Value Store
    • Key/Value Store Walkthrough
  • Object Store
    • Object Store Walkthrough
• Subject Mapping and Partitioning
• NATS Service Infrastructure
  • NATS Adaptive Deployment Architectures
• Security
• Connectivity

Using NATS

• NATS Tools
  • nats
    • nats bench
  • nk
  • nsc
    • Basics
    • Streams
    • Services
    • Signing Keys
    • Revocation
    • Managed Operators
  • nats-top
    • Tutorial
• Developing With NATS
  • Anatomy of a NATS application
  • Connecting
    • Connecting to the Default Server
    • Connecting to a Specific Server
    • Connecting to a Cluster
    • Connection Name
    • Authenticating with a User and Password
    • Authenticating with a Token
    • Authenticating with an NKey
    • Authenticating with a Credentials File
    • Encrypting Connections with TLS
    • Setting a Connect Timeout
    • Ping/Pong Protocol
    • Turning Off Echo'd Messages
    • Miscellaneous functionalities
    • Automatic Reconnections
      • Disabling Reconnect
      • Set the Number of Reconnect Attempts
      • Avoiding the Thundering Herd
      • Pausing Between Reconnect Attempts
      • Listening for Reconnect Events
      • Buffering Messages During Reconnect Attempts
    • Monitoring the Connection
      • Listen for Connection Events
      • Slow Consumers
  • Receiving Messages
    • Synchronous Subscriptions
    • Asynchronous Subscriptions
    • Unsubscribing
    • Unsubscribing After N Messages
    • Replying to a Message
    • Wildcard Subscriptions
    • Queue Subscriptions
    • Draining Messages Before Disconnect
    • Receiving Structured Data
  • Sending Messages
    • Including a Reply Subject
    • Request-Reply Semantics
    • Caches, Flush and Ping
    • Sending Structured Data
  • JetStream
    • JetStream Model Deep Dive
    • Managing Streams and consumers
    • Consumer Details
    • Publishing to Streams
    • Using the Key/Value Store
    • Using the Object Store
  • Tutorials
    • Advanced Connect and Custom Dialer in Go

Running a NATS service

• Installing, running and deploying a NATS Server
  • Installing a NATS Server
  • Running and deploying a NATS Server
  • Windows Service
  • Flags
• Environmental considerations
• NATS and Docker
  • Tutorial
  • Docker Swarm
  • Python and NGS Running in Docker
  • JetStream
• NATS and Kubernetes
  • Deploying NATS with Helm
  • Creating a Kubernetes Cluster
  • NATS Cluster and Cert Manager
  • Securing a NATS Cluster with cfssl
  • Using a Load Balancer for External Access to NATS
  • Creating a NATS Super Cluster in Digital Ocean with Helm
  • From Zero to K8S to Leafnodes using Helm
• NATS Server Clients
• Configuring NATS Server
  • Configuring JetStream
    • Configuration Management
      • NATS Admin CLI
      • Terraform
      • GitHub Actions
      • Kubernetes Controller
  • Clustering
    • Clustering Configuration
    • JetStream Clustering
      • Administration
      • Troubleshooting
  • Super-cluster with Gateways
    • Configuration
  • Leaf Nodes
    • Configuration
    • JetStream on Leaf Nodes
  • Securing NATS
    • Enabling TLS
    • Authentication
      • Tokens
      • Username/Password
      • TLS Authentication
        • TLS Authentication in clusters
      • NKeys
      • Authentication Timeout
      • Decentralized JWT Authentication/Authorization
        • Account lookup using Resolver
        • Memory Resolver Tutorial
        • Mixed Authentication/Authorization Setup
    • Authorization
    • Multi Tenancy using Accounts
    • OCSP Stapling
  • Logging
  • Enabling Monitoring
  • MQTT
    • Configuration
  • Configuring Subject Mapping
  • System Events
    • System Events & Decentralized JWT Tutorial
  • WebSocket
    • Configuration
• Managing and Monitoring your NATS Server Infrastructure
  • Monitoring
    • Monitoring JetStream
  • Managing JetStream
    • Account Information
    • Naming Streams, Consumers, and Accounts
    • Streams
    • Consumers
    • Data Replication
    • Disaster Recovery
    • Encryption at Rest
  • Managing JWT Security
    • In Depth JWT Guide
  • Upgrading a Cluster
  • Slow Consumers
  • Signals
  • Lame Duck Mode
  • Profiling

Reference

• FAQ
• NATS Protocols
  • Protocol Demo
  • Client Protocol
    • Developing a Client
  • NATS Cluster Protocol
  • JetStream wire API Reference
• Roadmap
• Contributing

Legacy

• STAN aka 'NATS Streaming'
  • STAN Concepts
    • Relation to NATS
    • Client Connections
    • Channels
      • Message Log
      • Subscriptions
        • Regular
        • Durable
        • Queue Group
        • Redelivery
    • Store Interface
    • Store Encryption
    • Clustering
      • Supported Stores
      • Configuration
      • Auto Configuration
      • Containers
    • Fault Tolerance
      • Active Server
      • Standby Servers
      • Shared State
      • Failover
    • Partitioning
    • Monitoring
      • Endpoints
  • Developing With STAN
    • Connecting to NATS Streaming Server
    • Publishing to a Channel
    • Receiving Messages from a Channel
    • Durable Subscriptions
    • Queue Subscriptions
    • Acknowledgements
    • The Streaming Protocol
  • STAN NATS Streaming Server
    • Installing
    • Running
    • Configuring
      • Command Line Arguments
      • Configuration File
      • Store Limits
      • Persistence
        • File Store
        • SQL Store
      • Securing
    • Process Signaling
    • Windows Service
    • Embedding NATS Streaming Server
    • Docker Swarm
    • Kubernetes
      • NATS Streaming with Fault Tolerance.
• nats-account-server
  • Basics
  • Inspecting JWTs
  • Directory Store
  • Update Notifications