Skip to content

Commit

Permalink
update broken links (nats-io#611)
Browse files Browse the repository at this point in the history 
* update broken links

Signed-off-by: ainsley <[email protected]>

* Update README.md

* Update README.md

* Update whats_new.md

* Update README.md

* Update readme.md

* Update security.md

* Update creds.md

---------

Signed-off-by: ainsley <[email protected]>
  • Loading branch information
@gcolliso
gcolliso authored Aug 24, 2023
1 parent 96a0ccd commit b2a4063
Show file tree
Hide file tree
Showing 18 changed files with 24 additions and 30 deletions.
2 changes: 1 addition & 1 deletion reference/nats-protocol/nats-protocol/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ The valid options are as follows, encoded as JSON:
| `echo` | If set to `false`, the server (version 1.2.0+) will not send originating messages from this connection to its own subscriptions. Clients should set this to `false` only for server supporting this feature, which is when `proto` in the `INFO` protocol is set to at least `1`. | bool | false |
| `sig` | In case the server has responded with a `nonce` on `INFO`, then a NATS client must use this field to reply with the signed `nonce`. | string | if `nonce` received |
| `jwt` | The JWT that identifies a user permissions and account. | string | false |
| `no_responders` | Enable [quick replies for cases where a request is sent to a topic with no responders](nats-concepts/core-nats/reqreply#no_responders). | bool | false |
| `no_responders` | Enable [quick replies for cases where a request is sent to a topic with no responders](/nats-concepts/core-nats/request-reply/reqreply.md#no-responders). | bool | false |
| `headers` | Whether the client supports headers. | bool | false |
| `nkey` | The public NKey to authenticate the client. This will be used to verify the signature (`sig`) against the `nonce` provided in the `INFO` message. | string | false |

Expand Down
2 changes: 1 addition & 1 deletion reference/nats-protocol/nats-server-protocol.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## NATS Cluster Protocol

The NATS server clustering protocol describes the protocols passed between NATS servers within a [cluster](../running-a-nats-service/configuration/clustering/) to share accounts, subscriptions, forward messages, and share cluster topology regarding new servers. It is a simple text-based protocol. Servers communicate with each other through a regular TCP/IP or TLS socket using a small set of protocol operations that are terminated by newline.
The NATS server clustering protocol describes the protocols passed between NATS servers within a [cluster](/running-a-nats-service/configuration/clustering/) to share accounts, subscriptions, forward messages, and share cluster topology regarding new servers. It is a simple text-based protocol. Servers communicate with each other through a regular TCP/IP or TLS socket using a small set of protocol operations that are terminated by newline.

The NATS server implements a [zero allocation byte parser](https://youtu.be/ylRKac5kSOk?t=10m46s) that is fast and efficient.

Expand Down
2 changes: 1 addition & 1 deletion release_notes/whats_new.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ For full release information, see links below;

## Server release v2.3.0

* [OCSP support](nats-server/configuration/ocsp.md)
* [OCSP support](/running-a-nats-service/configuration/ocsp.md)

### JetStream

Expand Down
3 changes: 1 addition & 2 deletions running-a-nats-service/clients.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,5 +121,4 @@ If you want to try on a remote server, the NATS team maintains a demo server you

```shell
nats sub -s nats://demo.nats.io ">"
```

```
4 changes: 1 addition & 3 deletions running-a-nats-service/configuration/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,12 +159,10 @@ By default, the JetStream subsystem will store data in the /tmp directory, but y
| `store_dir` | Directory to use for JetStream storage. | `/tmp/nats/jetstream` | 2.2.0 |
| `max_memory_store` | Maximum size of the 'memory' storage | 75% of available memory | 2.2.0 |
| `max_file_store` | Maximum size of the 'file' storage | Up to 1TB if available | 2.2.0 |
| `cipher` | Set to enable storage-level [encryption at rest][encryption]. Choose either `chachapoly` or `aes`. | (not set) | 2.3.0 |
| `cipher` | Set to enable storage-level [encryption at rest](/running-a-nats-service/nats_admin/jetstream_admin/encryption_at_rest.md). Choose either `chachapoly` or `aes`. | (not set) | 2.3.0 |
| `key` | The encryption key to use when encryption is enabled. A key length of at least 32 bytes is recommended. Note, this key is HMAC-256 hashed on startup which reduces the byte length to 64. | (not set) | 2.3.0 |
| `max_outstanding_catchup` | Max in-flight bytes for stream catch-up | 32MB | 2.9.0 |

[encryption]: /running-a-nats-service/nats_admin/jetstream_admin/encryption_at_rest

Here's an example minimal file that will store data in a local "nats" directory with some limits.

`$ nats-server -c js.conf`
Expand Down
4 changes: 2 additions & 2 deletions running-a-nats-service/configuration/clustering/jetstream_clustering/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ Below are explicitly listed server configuration for a three-node cluster across

### Server password configuration

A user and password under the [system account ($SYS)](../sys_accounts/README.md#system-account)
should be configured. The following configuration uses a [bcrypted password](../securing_nats/auth_intro/username_password.md#bcrypted-passwords): `a very long s3cr3t! password`.
A user and password under the [system account ($SYS)](/sys_accounts/README.md#system-account)
should be configured. The following configuration uses a [bcrypted password](/securing_nats/auth_intro/username_password.md#bcrypted-passwords): `a very long s3cr3t! password`.

### Server 1 \(host_a\)

Expand Down
2 changes: 1 addition & 1 deletion running-a-nats-service/configuration/gateways/gateway.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ The subscriber should print
| `host` | Interface where the gateway will listen for incoming gateway connections. |
| `port` | Port where the gateway will listen for incoming gateway connections. |
| `listen` | Combines `host` and `port` as `<host>:<port>` |
| `tls` | A [`tls` configuration map](/running-a-nats-service/configuration/securing_nats/tls.md) for securing gateway connections. `verify` is always enabled. Unless otherwise specified in a [`gateway`](gateway.md#gateway-entry), `cert_file` will be the default client certificate. [See](broken-reference) for certificate pitfalls. |
| `tls` | A [`tls` configuration map](/running-a-nats-service/configuration/securing_nats/tls.md) for securing gateway connections. `verify` is always enabled. Unless otherwise specified in a [`gateway`](gateway.md#gateway-entry), `cert_file` will be the default client certificate. [Certificate pitfalls](/running-a-nats-service/configuration/securing_nats/tls#problems-with-self-signed-certificates). |
| `advertise` | Hostport `<host>:<port>` to advertise how this server can be contacted by other gateway members. This is useful in setups with NAT, or in the cloud when exposed by a Network Load Balancer. |
| `connect_retries` | After how many failed connect attempts to give up establishing a connection to a discovered gateway. Default is `0`, do not retry. When enabled, attempts will be made once a second. This, does not apply to explicitly configured gateways. |
| `authorization` | [Authorization](../securing_nats/auth_intro/#authorization-map) map for gateways. When a single `username`/`password` is used, it defines the authentication mechanism this server expects, and how this server will authenticate itself when establishing a connection to a _discovered_ gateway. This will not be used for gateways explicitly listed in [`gateways`](gateway.md#gateway-entry) and therefore have to be provided as part of the URL. With this authentication mode, either use the same credentials throughout the system or list every gateway explicitly on every server. If the `tls` configuration map specifies `verify_and_map` only provide the expected `username`. Here different certificates can be used, but they do have to map to the same `username`. The authorization map also allows for `timeout` which is honored but `users` and `token` configuration are not supported and will prevent the server from starting. The `permissions` block is ignored. |
Expand Down
2 changes: 1 addition & 1 deletion running-a-nats-service/configuration/securing_nats/authorization.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,4 +156,4 @@ users = [
}
}
]
```
```
2 changes: 1 addition & 1 deletion running-a-nats-service/configuration/securing_nats/tls.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -199,4 +199,4 @@ See: <https://github.com/nats-io/nats.js/issues/369>

### nats.rs

Something around here: <https://github.com/nats-io/nats.rs/blob/master/src/connector.rs#L242>
See: <https://github.com/nats-io/nats.rs/blob/main/async-nats/src/connector.rs>
2 changes: 1 addition & 1 deletion running-a-nats-service/nats_admin/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Managing a NATS Server is simple, typical lifecycle operations include:

* Using the [`nats`](/using-nats/nats-tools/nats%20CLI/readme.md) CLI tool to check server cluster connectivity and latencies, as well as get account information, and manage and interact with streams (and other NATS applications). Try the following examples to learn about the most common ways to use `nats`.
* Using the [`nats`](/using-nats/nats-tools/nats_cli) CLI tool to check server cluster connectivity and latencies, as well as get account information, and manage and interact with streams (and other NATS applications). Try the following examples to learn about the most common ways to use `nats`.
* `nats cheat`
* `nats cheat server`
* `nats stream --help` to monitor, manage and interact with streams
Expand Down
6 changes: 3 additions & 3 deletions running-a-nats-service/nats_admin/jwt.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ This time the message is received by the subscriber:
user b
```

Accounts are a lot more powerful than what has been demonstrated here. Take a look at the complete documentation of [accounts](../configuration/securing_nats/accounts.md#accounts) and the [users](../../nats-server/configuration/securing_nats/auth_intro/) associated with them. All of this is in a plain NATS config file. (Copy the above config and try it using this command: `nats-server -c <filename>`) In order to make any changes, every participating nats-server config file in the same security domain has to change. This configuration is typically controlled by one organization or the administrator.
Accounts are a lot more powerful than what has been demonstrated here. Take a look at the complete documentation of [accounts](../configuration/securing_nats/accounts.md#accounts) and the [users](/running-a-nats-service/configuration/securing_nats/auth_intro) associated with them. All of this is in a plain NATS config file. (Copy the above config and try it using this command: `nats-server -c <filename>`) In order to make any changes, every participating nats-server config file in the same security domain has to change. This configuration is typically controlled by one organization or the administrator.

#### Key Takeaways

Expand Down Expand Up @@ -409,7 +409,7 @@ types. Which one to pick depends upon your needs:
* Will download Accounts from a web server
* Allows for easy publication of account JWTs programmatically
generated using NKEYs and the JWT library.
* The [`nats-account-server`](../../using-nats/nats-tools/nas/) is
* The [`nats-account-server`](https://nats-io.gitbook.io/legacy-nats-docs/nats-account-server) is
such a webserver. When set up correctly, it will inform
`nats-server` of Account JWT changes.
* Depending on configuration, requires read and/or write access to
Expand Down Expand Up @@ -1340,7 +1340,7 @@ func generateUserJWT(userPublicKey, accountPublicKey string, accountSigningKey n
}
```

Inspect the [user claim](https://github.com/nats-io/jwt/blob/master/user_claims.go#L39-L45) for all available properties/limits/permissions to set. When using an [account claim](https://github.com/nats-io/jwt/blob/057ba30017beca2abb0ba35e7db6442be3479c5d/account_claims.go#L107-L114) instead, you can dynamically generate accounts. Additional steps are to push the new account as outlined [here](jwt.md#publicize-an-account-with-push---operator-environmentenvironment-with-push-permissions---all-deployment-modes). Depending on your needs, you may want to consider exchanging the accounts identity NKEY in a similar way that the users key is exchanged in the [next section](jwt.md#distributed-user-creation).
Inspect the [user claim](https://github.com/nats-io/jwt/blob/main/v2/user_claims.go#L57) for all available properties/limits/permissions to set. When using an [account claim](https://github.com/nats-io/jwt/blob/057ba30017beca2abb0ba35e7db6442be3479c5d/account_claims.go#L107-L114) instead, you can dynamically generate accounts. Additional steps are to push the new account as outlined [here](jwt.md#publicize-an-account-with-push---operator-environmentenvironment-with-push-permissions---all-deployment-modes). Depending on your needs, you may want to consider exchanging the accounts identity NKEY in a similar way that the users key is exchanged in the [next section](jwt.md#distributed-user-creation).

#### **Distributed User Creation**

Expand Down
7 changes: 2 additions & 5 deletions running-a-nats-service/nats_admin/monitoring/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The NATS monitoring endpoints support [JSONP](https://en.wikipedia.org/wiki/JSON

### Enabling monitoring

Monitoring can be enabled in [server configuration][config] or as a server [command-line option][options]. The conventional port is `8222`.
Monitoring can be enabled in [server configuration](/running-a-nats-service/configuration#monitoring-and-tracing) or as a server [command-line option](/running-a-nats-service/running/flags.md#server-options). The conventional port is `8222`.

As server configuration:

Expand All @@ -36,10 +36,7 @@ As a command-line option:
```bash
nats-server -m 8222
```
Once the server is running using one of the two methods, go to [http://localhost:8222](http://localhost:8222) to browse the available endpoints detailed below.

[config]: /running-a-nats-service/configuration#monitoring-and-tracing
[options]: /running-a-nats-service/introduction/flags#server-options
Once the server is running using one of the two methods, go to http://localhost:8222 to browse the available endpoints detailed below.

## Monitoring Endpoints

Expand Down
2 changes: 1 addition & 1 deletion running-a-nats-service/nats_admin/profiling.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ For example, to download a CPU profile from NATS running on the same machine wit
curl -o cpu.prof http://localhost:65432/debug/pprof/profile?seconds=30
```

The profile will be saved into `cpu.prof`.
The profile will be saved into `cpu.prof`.
Loading

0 comments on commit b2a4063

Please sign in to comment.