mirror of
https://github.com/taigrr/nats.docs
synced 2025-01-18 04:03:23 -08:00
248 lines
14 KiB
Markdown
248 lines
14 KiB
Markdown
# Table of contents
|
|
|
|
* [Introduction](README.md)
|
|
* [What's New!](whats_new.md)
|
|
* [NATS 2.0](whats_new_20.md)
|
|
* [Compare NATS](compare-nats.md)
|
|
* [FAQ](faq.md)
|
|
|
|
## NATS Concepts
|
|
|
|
* [What is NATS](nats-concepts/intro.md)
|
|
* [Subject-Based Messaging](nats-concepts/subjects.md)
|
|
* [Publish-Subscribe](nats-concepts/pubsub.md)
|
|
* [Request-Reply](nats-concepts/reqreply.md)
|
|
* [Queue Groups](nats-concepts/queue.md)
|
|
* [Acknowledgements](nats-concepts/acks.md)
|
|
* [Sequence Numbers](nats-concepts/seq_num.md)
|
|
|
|
## Developing With NATS
|
|
|
|
* [Introduction](developing-with-nats/developer.md)
|
|
* [Connecting](developing-with-nats/connecting/README.md)
|
|
* [Connecting to the Default Server](developing-with-nats/connecting/default_server.md)
|
|
* [Connecting to a Specific Server](developing-with-nats/connecting/specific_server.md)
|
|
* [Connecting to a Cluster](developing-with-nats/connecting/cluster.md)
|
|
* [Connection Name](developing-with-nats/connecting/name.md)
|
|
* [Setting a Connect Timeout](developing-with-nats/connecting/connect_timeout.md)
|
|
* [Ping/Pong Protocol](developing-with-nats/connecting/pingpong.md)
|
|
* [Turning Off Echo'd Messages](developing-with-nats/connecting/noecho.md)
|
|
* [Miscellaneous functionalities](developing-with-nats/connecting/misc.md)
|
|
* [Automatic Reconnections](developing-with-nats/reconnect/README.md)
|
|
* [Disabling Reconnect](developing-with-nats/reconnect/disable.md)
|
|
* [Set the Number of Reconnect Attempts](developing-with-nats/reconnect/max.md)
|
|
* [Avoiding the Thundering Herd](developing-with-nats/reconnect/random.md)
|
|
* [Pausing Between Reconnect Attempts](developing-with-nats/reconnect/wait.md)
|
|
* [Listening for Reconnect Events](developing-with-nats/reconnect/events.md)
|
|
* [Buffering Messages During Reconnect Attempts](developing-with-nats/reconnect/buffer.md)
|
|
* [Securing Connections](developing-with-nats/security/README.md)
|
|
* [Authenticating with a User and Password](developing-with-nats/security/userpass.md)
|
|
* [Authenticating with a Token](developing-with-nats/security/token.md)
|
|
* [Authenticating with an NKey](developing-with-nats/security/nkey.md)
|
|
* [Authenticating with a Credentials File](developing-with-nats/security/creds.md)
|
|
* [Encrypting Connections with TLS](developing-with-nats/security/tls.md)
|
|
* [Receiving Messages](developing-with-nats/receiving/README.md)
|
|
* [Synchronous Subscriptions](developing-with-nats/receiving/sync.md)
|
|
* [Asynchronous Subscriptions](developing-with-nats/receiving/async.md)
|
|
* [Unsubscribing](developing-with-nats/receiving/unsubscribing.md)
|
|
* [Unsubscribing After N Messages](developing-with-nats/receiving/unsub_after.md)
|
|
* [Replying to a Message](developing-with-nats/receiving/reply.md)
|
|
* [Wildcard Subscriptions](developing-with-nats/receiving/wildcards.md)
|
|
* [Queue Subscriptions](developing-with-nats/receiving/queues.md)
|
|
* [Draining Messages Before Disconnect](developing-with-nats/receiving/drain.md)
|
|
* [Structured Data](developing-with-nats/receiving/structure.md)
|
|
* [Sending Messages](developing-with-nats/sending/README.md)
|
|
* [Including a Reply Subject](developing-with-nats/sending/replyto.md)
|
|
* [Request-Reply Semantics](developing-with-nats/sending/request_reply.md)
|
|
* [Caches, Flush and Ping](developing-with-nats/sending/caches.md)
|
|
* [Sending Structured Data](developing-with-nats/sending/structure.md)
|
|
* [Monitoring the Connection](developing-with-nats/events/README.md)
|
|
* [Listen for Connection Events](developing-with-nats/events/events.md)
|
|
* [Slow Consumers](developing-with-nats/events/slow.md)
|
|
* [Tutorials](developing-with-nats/tutorials/README.md)
|
|
* [Explore NATS Pub/Sub](developing-with-nats/tutorials/pubsub.md)
|
|
* [Explore NATS Request/Reply](developing-with-nats/tutorials/reqreply.md)
|
|
* [Explore NATS Queueing](developing-with-nats/tutorials/queues.md)
|
|
* [Advanced Connect and Custom Dialer in Go](developing-with-nats/tutorials/custom_dialer.md)
|
|
|
|
## NATS Server
|
|
|
|
* [Installing](nats-server/installation.md)
|
|
* [Running](nats-server/running/README.md)
|
|
* [Windows Service](nats-server/running/windows_srv.md)
|
|
* [Clients](nats-server/clients.md)
|
|
* [Flags](nats-server/flags.md)
|
|
* [Configuration](nats-server/configuration/README.md)
|
|
* [Securing NATS](nats-server/configuration/securing_nats/README.md)
|
|
* [Enabling TLS](nats-server/configuration/securing_nats/tls.md)
|
|
* [Authentication](nats-server/configuration/securing_nats/auth_intro/README.md)
|
|
* [Tokens](nats-server/configuration/securing_nats/auth_intro/tokens.md)
|
|
* [Username/Password](nats-server/configuration/securing_nats/auth_intro/username_password.md)
|
|
* [TLS Authentication](nats-server/configuration/securing_nats/auth_intro/tls_mutual_auth.md)
|
|
* [NKeys](nats-server/configuration/securing_nats/auth_intro/nkey_auth.md)
|
|
* [Authentication Timeout](nats-server/configuration/securing_nats/auth_intro/auth_timeout.md)
|
|
* [Authorization](nats-server/configuration/securing_nats/authorization.md)
|
|
* [Multi Tenancy using Accounts](nats-server/configuration/securing_nats/accounts.md)
|
|
* [Decentralized JWT Authentication/Authorization](nats-server/configuration/securing_nats/jwt/README.md)
|
|
* [Account lookup using Resolver](nats-server/configuration/securing_nats/jwt/resolver.md)
|
|
* [Memory Resolver Tutorial](nats-server/configuration/securing_nats/jwt/mem_resolver.md)
|
|
* [Mixed Authentication/Authorization Setup](nats-server/configuration/securing_nats/jwt/jwt_nkey_auth.md)
|
|
* [Clustering](nats-server/configuration/clustering/README.md)
|
|
* [Configuration](nats-server/configuration/clustering/cluster_config.md)
|
|
* [TLS Authentication](nats-server/configuration/clustering/cluster_tls.md)
|
|
* [Super-cluster with Gateways](nats-server/configuration/gateways/README.md)
|
|
* [Configuration](nats-server/configuration/gateways/gateway.md)
|
|
* [Leaf Nodes](nats-server/configuration/leafnodes/README.md)
|
|
* [Configuration](nats-server/configuration/leafnodes/leafnode_conf.md)
|
|
* [Logging](nats-server/configuration/logging.md)
|
|
* [Monitoring](nats-server/configuration/monitoring.md)
|
|
* [System Events](nats-server/configuration/sys_accounts/README.md)
|
|
* [System Events & Decentralized JWT Tutorial](nats-server/configuration/sys_accounts/sys_accounts.md)
|
|
* [Managing A NATS Server](nats-server/nats_admin/README.md)
|
|
* [Upgrading a Cluster](nats-server/nats_admin/upgrading_cluster.md)
|
|
* [Slow Consumers](nats-server/nats_admin/slow_consumers.md)
|
|
* [Signals](nats-server/nats_admin/signals.md)
|
|
* [Lame Duck Mode](nats-server/nats_admin/lame_duck_mode.md)
|
|
* [NATS and Docker](nats-server/nats_docker/README.md)
|
|
* [Tutorial](nats-server/nats_docker/nats-docker-tutorial.md)
|
|
* [Docker Swarm](nats-server/nats_docker/docker_swarm.md)
|
|
* [Python and NGS Running in Docker](nats-server/nats_docker/ngs-docker-python.md)
|
|
|
|
## JetStream
|
|
|
|
* [About Jetstream](jetstream/jetstream.md)
|
|
* [Concepts](jetstream/concepts/README.md)
|
|
* [Streams](jetstream/concepts/streams.md)
|
|
* [Consumes](jetstream/concepts/consumers.md)
|
|
* [Configuration](jetstream/concepts/configuration.md)
|
|
* [Getting Started](jetstream/getting_started/README.md)
|
|
* [Using Docker](jetstream/getting_started/using_docker.md)
|
|
* [Using Docker with NGS](jetstream/getting_started/using-docker-with-ngs.md)
|
|
* [Using Source](jetstream/getting_started/using_source.md)
|
|
* [Administration & Usage from CLI](jetstream/administration/README.md)
|
|
* [Account Information](jetstream/administration/account.md)
|
|
* [Streams](jetstream/administration/streams.md)
|
|
* [Consumers](jetstream/administration/consumers.md)
|
|
* [Monitoring](jetstream/monitoring.md)
|
|
* [Data Replication](jetstream/replication.md)
|
|
* [Clustering](jetstream/clustering/README.md)
|
|
* [Administration](jetstream/clustering/administration.md)
|
|
* [Configuration Management](jetstream/configuration_mgmt/README.md)
|
|
* [NATS Admin CLI](jetstream/configuration_mgmt/nats-admin-cli.md)
|
|
* [Terraform](jetstream/configuration_mgmt/terraform.md)
|
|
* [GitHub Actions](jetstream/configuration_mgmt/github_actions.md)
|
|
* [Kubernetes Controller](jetstream/configuration_mgmt/kubernetes_controller.md)
|
|
* [Disaser Recovery](jetstream/disaster_recovery.md)
|
|
* [Model Deep Dive](jetstream/model_deep_dive/README.md)
|
|
* [Stream Limits, Retention Modes and Discard Policy](jetstream/model_deep_dive/stream-limits-retention-modes-and-discard-policy.md)
|
|
* [Message Deduplication](jetstream/model_deep_dive/message-deduplication.md)
|
|
* [Acknowledgment Models](jetstream/model_deep_dive/acknowledgment-models.md)
|
|
* [Exactly Once Delivery](jetstream/model_deep_dive/exactly-once-delivery.md)
|
|
* [Consumer Starting Position](jetstream/model_deep_dive/consumer-starting-position.md)
|
|
* [Ephemeral Consumers](jetstream/model_deep_dive/ephemeral-consumers.md)
|
|
* [Consumer Message Rates](jetstream/model_deep_dive/consumer-message-rates.md)
|
|
* [Stream Templates](jetstream/model_deep_dive/stream-templates.md)
|
|
* [Ack Sampling](jetstream/model_deep_dive/ack-sampling.md)
|
|
* [Storage Overhead](jetstream/model_deep_dive/storage-overhead.md)
|
|
* [NATS API Reference](jetstream/nats_api_reference.md)
|
|
* [Multi-tenancy & Resource Mgmt](jetstream/resource_management.md)
|
|
|
|
## NATS Tools
|
|
|
|
* [Introduction](nats-tools/nats-tools.md)
|
|
* [nats](nats-tools/natscli.md)
|
|
* [nk](nats-tools/nk.md)
|
|
* [nsc](nats-tools/nsc/README.md)
|
|
* [Basics](nats-tools/nsc/nsc.md)
|
|
* [Streams](nats-tools/nsc/streams.md)
|
|
* [Services](nats-tools/nsc/services.md)
|
|
* [Signing Keys](nats-tools/nsc/signing_keys.md)
|
|
* [Revocation](nats-tools/nsc/revocation.md)
|
|
* [Managed Operators](nats-tools/nsc/managed.md)
|
|
* [nats-account-server](nats-tools/nas/README.md)
|
|
* [Basics](nats-tools/nas/nas_conf.md)
|
|
* [Inspecting JWTs](nats-tools/nas/inspecting_jwts.md)
|
|
* [Directory Store](nats-tools/nas/dir_store.md)
|
|
* [Update Notifications](nats-tools/nas/notifications.md)
|
|
* [nats-top](nats-tools/nats_top/README.md)
|
|
* [Tutorial](nats-tools/nats_top/nats-top-tutorial.md)
|
|
* [nats-bench](nats-tools/natsbench.md)
|
|
|
|
## NATS Streaming Concepts
|
|
|
|
* [Introduction](nats-streaming-concepts/intro.md)
|
|
* [Relation to NATS](nats-streaming-concepts/relation-to-nats.md)
|
|
* [Client Connections](nats-streaming-concepts/client-connections.md)
|
|
* [Channels](nats-streaming-concepts/channels/README.md)
|
|
* [Message Log](nats-streaming-concepts/channels/message-log.md)
|
|
* [Subscriptions](nats-streaming-concepts/channels/subscriptions/README.md)
|
|
* [Regular](nats-streaming-concepts/channels/subscriptions/regular.md)
|
|
* [Durable](nats-streaming-concepts/channels/subscriptions/durable.md)
|
|
* [Queue Group](nats-streaming-concepts/channels/subscriptions/queue-group.md)
|
|
* [Redelivery](nats-streaming-concepts/channels/subscriptions/redelivery.md)
|
|
* [Store Interface](nats-streaming-concepts/store-interface.md)
|
|
* [Store Encryption](nats-streaming-concepts/store-encryption.md)
|
|
* [Clustering](nats-streaming-concepts/clustering/README.md)
|
|
* [Supported Stores](nats-streaming-concepts/clustering/supported-stores.md)
|
|
* [Configuration](nats-streaming-concepts/clustering/configuration.md)
|
|
* [Auto Configuration](nats-streaming-concepts/clustering/auto-configuration.md)
|
|
* [Containers](nats-streaming-concepts/clustering/containers.md)
|
|
* [Fault Tolerance](nats-streaming-concepts/ft/README.md)
|
|
* [Active Server](nats-streaming-concepts/ft/active-server.md)
|
|
* [Standby Servers](nats-streaming-concepts/ft/standby-server.md)
|
|
* [Shared State](nats-streaming-concepts/ft/shared-state.md)
|
|
* [Failover](nats-streaming-concepts/ft/failover.md)
|
|
* [Partitioning](nats-streaming-concepts/partitioning.md)
|
|
* [Monitoring](nats-streaming-concepts/monitoring/README.md)
|
|
* [Endpoints](nats-streaming-concepts/monitoring/endpoints.md)
|
|
|
|
## Developing With NATS Streaming
|
|
|
|
* [Introduction](developing-with-nats-streaming/streaming.md)
|
|
* [Connecting to NATS Streaming](developing-with-nats-streaming/connecting.md)
|
|
* [Publishing to a Channel](developing-with-nats-streaming/publishing.md)
|
|
* [Receiving Messages from a Channel](developing-with-nats-streaming/receiving.md)
|
|
* [Durable Subscriptions](developing-with-nats-streaming/durables.md)
|
|
* [Queue Subscriptions](developing-with-nats-streaming/queues.md)
|
|
* [Acknowledgements](developing-with-nats-streaming/acks.md)
|
|
* [The Streaming Protocol](developing-with-nats-streaming/protocol.md)
|
|
|
|
## NATS Streaming Server
|
|
|
|
* [Important Changes](nats-streaming-server/changes.md)
|
|
* [Installing](nats-streaming-server/install.md)
|
|
* [Running](nats-streaming-server/run.md)
|
|
* [Configuring](nats-streaming-server/configuring/README.md)
|
|
* [Command Line Arguments](nats-streaming-server/configuring/cmdline.md)
|
|
* [Configuration File](nats-streaming-server/configuring/cfgfile.md)
|
|
* [Store Limits](nats-streaming-server/configuring/storelimits.md)
|
|
* [Persistence](nats-streaming-server/configuring/persistence/README.md)
|
|
* [File Store](nats-streaming-server/configuring/persistence/file_store.md)
|
|
* [SQL Store](nats-streaming-server/configuring/persistence/sql_store.md)
|
|
* [Securing](nats-streaming-server/configuring/tls.md)
|
|
* [Process Signaling](nats-streaming-server/process-signaling.md)
|
|
* [Windows Service](nats-streaming-server/windows-service.md)
|
|
* [Embedding NATS Streaming Server](nats-streaming-server/embedding.md)
|
|
* [Docker Swarm](nats-streaming-server/swarm.md)
|
|
|
|
## NATS Protocol
|
|
|
|
* [Protocol Demo](nats-protocol/nats-protocol-demo.md)
|
|
* [Client Protocol](nats-protocol/nats-protocol/README.md)
|
|
* [Developing a Client](nats-protocol/nats-protocol/nats-client-dev.md)
|
|
* [NATS Cluster Protocol](nats-protocol/nats-server-protocol.md)
|
|
|
|
## NATS on Kubernetes
|
|
|
|
* [Introduction](nats-on-kubernetes/nats-kubernetes.md)
|
|
* [Basic NATS and NATS Streaming Setup](nats-on-kubernetes/minimal-setup.md)
|
|
* [Creating a Kubernetes Cluster](nats-on-kubernetes/create-k8s-cluster.md)
|
|
* [NATS Streaming Cluster with FT Mode](nats-on-kubernetes/stan-ft-k8s-aws.md)
|
|
* [NATS and Prometheus Operator](nats-on-kubernetes/prometheus-and-nats-operator.md)
|
|
* [NATS Cluster and Cert Manager](nats-on-kubernetes/nats-cluster-and-cert-manager.md)
|
|
* [Securing a NATS Cluster with cfssl](nats-on-kubernetes/operator-tls-setup-with-cfssl.md)
|
|
* [Using a Load Balancer for External Access to NATS](nats-on-kubernetes/nats-external-nlb.md)
|
|
* [Creating a NATS Super Cluster in Digital Ocean with Helm](nats-on-kubernetes/super-cluster-on-digital-ocean.md)
|
|
* [From Zero to K8S to Leafnodes using Helm](nats-on-kubernetes/from-zero-to-leafnodes.md)
|
|
|