feat: add proxy config docs

haveachin · Jun 11, 2024 · 020d7a8 · 020d7a8
1 parent 62a98bf
commit 020d7a8
Show file tree

Hide file tree

Showing 13 changed files with 872 additions and 479 deletions.
diff --git a/configs/proxy.yml b/configs/proxy.yml
@@ -13,4 +13,54 @@ addresses:
 # Send a PROXY Protocol Header to the server to
 # forward the players IP address
 #
-#sendProxyProtocol: true
+#sendProxyProtocol: true
+
+# Reponse that the player sees when the connection to the backend server
+# times out during status or login request.
+#
+dialTimeoutResponse:
+ # The status response that should be displayed to the players
+ #
+ status:
+
+ # The name of the version.
+ # This is displayed on the client side when the version is incompatible.
+ #
+ versionName: "Infrared 1.20.6"
+
+ # The protocol version number determens if the version of the client is compatible with the server.
+ # A list of protocol versions can be found here: https://wiki.vg/Protocol_version_numbers
+ # Set this to -1 to mirror the client version back.
+ #
+ protocolNumber: 766
+ maxPlayerCount: 20
+ playerCount: 0
+ playerSamples:
+ - name: ""
+ uuid: ""
+
+ # Server icon can be provided as base64 or path to a file.
+ #
+ icon: ""
+
+ # MOTD can be just a string or a JSON Text Component.
+ #
+ motd: "Unable to reach backend server"
+
+ # Reason why the player was disconnected during login.
+ #
+ message: "Unable to reach backend server"
+
+# Override Status is similar to the dial timeout response status
+# but instead you just can override some fields in the status.
+#
+overrideStatus:
+ versionName: "1.20.6"
+ protocolNumber: 766
+ maxPlayerCount: 20
+ playerCount: 0
+ playerSamples:
+ - name: ""
+ uuid: ""
+ icon: ""
+ motd: "Unable to reach backend server"
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -3,7 +3,6 @@ import { defineConfig} from 'vitepress'
 export default defineConfig({
  lang: 'en-US',
  title: 'Infrared',
- titleTemplate: ':title | Reverse Proxy',
  description: 'The Minecraft Reverse Proxy',
  cleanUrls: true,
  head: [

diff --git a/docs/community-projects.md b/docs/community-projects.md
@@ -1,12 +1,12 @@
 # Community Projects
 
 > [!NOTE]
-> These projects are managed by the Infrared Community.
+> These projects are managed by the Community.
 > We do **not** provide official support for these projects.
 > Please use their dedicated issue trackers or support channels provided by the respective project.
 > Thanks for understanding.
 
-## Infrared for Pterodactyl
+## Pterodactyl Egg
 
 An egg to run Infrared in Pterodactyl. \
 Repo: [Shadowner/Infrared-Pterodactyl-egg](https://github.com/Shadowner/Infrared-Pterodactyl-egg) \

diff --git a/docs/config/server-status.md b/docs/config/server-status.md
@@ -0,0 +1,4 @@
+# Server Status
+
+The server status is what the server sends to clients to display in the server list.
+
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -27,9 +27,9 @@ The URL of your download should look something like this:
 ```
 https://github.com/haveachin/infrared/releases/download/{version}/infrared_{architecture}.tar.gz
 ```
-For example:
+For latest:
 ```
-https://github.com/haveachin/infrared/releases/download/v1.3.4/infrared_Linux_x86_64.tar.gz
+https://github.com/haveachin/infrared/releases/latest/download/infrared_Linux_x86_64.tar.gz
 ```
 
 ::: tip
@@ -43,7 +43,7 @@ curl -LO https://github.com/haveachin/infrared/releases/download/{version}/infra
 
 Downloading by using Powershell on Windows:
 ```Powershell
-Invoke-WebRequest -Uri https://github.com/haveachin/infrared/releases/download/v1.3.4/infrared_Windows_x86_64.zip -OutFile c:\infrared.zip
+Invoke-WebRequest -Uri https://github.com/haveachin/infrared/releases/latest/download/infrared_Windows_x86_64.zip -OutFile c:\infrared.zip
 ```
 
 ### Extracting the binary