Skip to content

Commit

Permalink
fix: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
haveachin committed Feb 4, 2024
1 parent 7e87d71 commit 2fecd94
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
</p>

> [!WARNING]
> Infrared is currently under active development: breaking changes can happen.
> Infrared is currently under active development: bugs and breaking changes can happen.
> Feedback and contributions are welcome.
An ultra lightweight Minecraft reverse proxy and status placeholder:
Expand Down
2 changes: 1 addition & 1 deletion docs/features/filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ filters:
Now you actually need to add filters to your config.
This is a list of all the filters that currently exist:
- [Rate Limiter](rate-limit-ips)
- [Rate Limiter](rate-limiter)
6 changes: 3 additions & 3 deletions docs/features/proxy-protocol.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# PROXY Protocol

Infrared supportes [PROXY Protocol v2]().
Infrared supportes [PROXY Protocol v2](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).

## Receive PROXY Protocol

You can receive PROXY Protocol Headers, but you **need** to specify your trusted [CIDRs](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#IPv4_CIDR_blocks).
To enable it in Infrared you just have to change this in you [global config](../config/index.md):
To enable it in Infrared you just have to change this in you [global config](../config/index):

```yml
# This is for receiving PROXY Protocol Headers
Expand All @@ -28,7 +28,7 @@ proxyProtocol:
## Forward Player IPs
You can forward the player IPs via PROXY Protocol.
To enable it in Infrared you just have to change this in you [**proxy config**](../config/proxies.md):
To enable it in Infrared you just have to change this in you [**proxy config**](../config/proxies):
```yml
# Send a PROXY Protocol Header to the server to
# forward the players IP address.
Expand Down
2 changes: 1 addition & 1 deletion docs/features/rate-limiter.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Rate Limit IPs

You can rate limit by IP address using the `rateLimit` filter.
This can be easily activated in your [**global config**](../config/index.md) by adding this:
This can be easily activated in your [**global config**](../config/index) by adding this:

```yml{2-16}
filters:
Expand Down

0 comments on commit 2fecd94

Please sign in to comment.