floodgate setup page

Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com>
2024-01-27 23:22:14 -08:00
1 parent cf9ca33c79
commit 83e73be2ea
@@ -1,82 +0,0 @@
 ---
 title: Floodgate Setup
 page_sidebar: false
 ---
 # Floodgate Setup
 <div class="alert alert-warning" role="alert">
 	Floodgate does <b>NOT</b> replace Geyser! It allows Geyser players to join servers without needing to log into a paid Java Edition account.   
 </div>
 [//]: # ()
 [//]: # (<div class="nav nav-tabs setup-tabs" role="tablist" aria-label="Setup Options">)
 [//]: # (    <li class="nav-item" role="presentation">)
 [//]: # (        <a class="nav-link active" href="#" data-bs-toggle="tab" data-bs-target="#spigot-option" type="button" role="tab" aria-controls="spigot-option" aria-selected="false"><img src="/img/icons/paper.png" alt="paper icon"> Paper / Spigot</a>)
 [//]: # (    </li>)
 [//]: # (    <li class="nav-item" role="presentation">)
 [//]: # (        <a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#fabric-option" type="button" role="tab" aria-controls="fabric-option" aria-selected="false"><img src="/img/icons/fabric.png" alt="fabric icon"> Fabric</a>)
 [//]: # (    </li>)
 [//]: # (    <li class="nav-item" role="presentation">)
 [//]: # (        <a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#proxy-option" type="button" role="tab" aria-controls="proxy-option" aria-selected="false"><img src="/img/icons/velocity.svg" alt="velocity icon"> Proxy Servers</a>)
 [//]: # (    </li>)
 [//]: # (    <li class="nav-item" role="presentation">)
 [//]: # (        <a class="nav-link" href="#" data-bs-toggle="tab" data-bs-target="#standalone-option" type="button" role="tab" aria-controls="standalone-option" aria-selected="false"><img src="/img/icons/geyser.png" alt="geyser icon"> Standalone</a>)
 [//]: # (    </li>)
 [//]: # (  </div>)
 [//]: # ()
 [//]: # (  <div class="tab-content mt-4">)
 [//]: # (    <div id="spigot-option" class="tab-pane fade show active" role="tabpanel">)
 [//]: # (        {% capture my_include %}{% include setup/instructions/floodgate/spigot.md %}{% endcapture %})
 [//]: # (        {{ my_include | markdownify }})
 [//]: # (    </div>)
 [//]: # (    <div id="fabric-option" class="tab-pane fade" role="tabpanel">)
 [//]: # (        {% capture my_include %}{% include setup/instructions/floodgate/fabric.md %}{% endcapture %})
 [//]: # (        {{ my_include | markdownify }})
 [//]: # (    </div>)
 [//]: # (    <div id="proxy-option" class="tab-pane fade" role="tabpanel">)
 [//]: # (        {% capture my_include %}{% include setup/instructions/floodgate/proxy.md %}{% endcapture %})
 [//]: # (        {{ my_include | markdownify }})
 [//]: # (    </div>)
 [//]: # (    <div id="standalone-option" class="tab-pane fade" role="tabpanel">)
 [//]: # (        {% capture my_include %}{% include setup/instructions/floodgate/standalone.md %}{% endcapture %})
 [//]: # (        {{ my_include | markdownify }})
 [//]: # (    </div>)
 [//]: # (</div>)
 <h4 class="mt-4">Further information:</h4>
 <ul>
  <li><a href="/floodgate/features/">Floodgate Features</a></li>
  <li><a href="/floodgate/api/">Floodgate API</a></li>
 </ul>
@@ -0,0 +1,34 @@
 ---
 title: Floodgate Setup
 page_sidebar: false
 ---
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 import Fabric from './setup/fabric.mdx';
 import ProxyServers from './setup/proxy-servers.mdx';
 import PaperSpigot from './setup/paper-spigot.mdx';
 import Standalone from './setup/standalone.mdx';
 import PlatformIcon from '../../src/components/PlatformIcon'
 import FabricIcon from '@site/static/img/icons/fabric.png';
 import ProxyServersIcon from '@site/static/img/icons/velocity.png';
 import PaperSpigotIcon from '@site/static/img/icons/paper.png';
 import StandaloneIcon from '@site/static/img/icons/geyser.png';
 <Tabs>
    <TabItem value="paper-spigot" label={<PlatformIcon img={PaperSpigotIcon} text="Paper / Spigot"/>} default>
        <PaperSpigot/>
    </TabItem>
    <TabItem value="fabric" label={<PlatformIcon img={FabricIcon} text="Fabric"/>}>
        <Fabric/>
    </TabItem>
    <TabItem value="proxy-servers" label={<PlatformIcon img={ProxyServersIcon} text="Proxy Servers"/>}>
        <ProxyServers/>
    </TabItem>
    <TabItem value="standalone" label={<PlatformIcon img={StandaloneIcon} text="Standalone"/>}>
        <Standalone/>
    </TabItem>
 </Tabs>
@@ -0,0 +1,12 @@
 ## Floodgate-Fabric setup
 1. Download Floodgate-Fabric from the [modrinth page](https://modrinth.com/mod/floodgate). 
 2. Place the Floodgate-Fabric.jar in the `mods` folder, and restart the server. **You also need [FabricAPI](https://modrinth.com/mod/fabric-api) installed.**
 3. Change `auth-type` in Geyser's config to `floodgate`.
 4. Restart the server.
 :::note Note for Fabric behind a Velocity proxy
 You will need to configure FabricProxyLite to allow the Fabric server to receive data from Velocity.
 :::
@@ -0,0 +1,6 @@
 ## Floodgate-Spigot setup
 1. Download Floodgate-Spigot from the [download page](https://download.geysermc.org/v2/projects/floodgate/versions/latest/builds/latest/downloads/spigot).
 2. Place the Floodgate-Spigot.jar in the `plugins` folder, and restart the server.
 3. Change `auth-type` in Geyser's config to `floodgate`.
 4. Restart the server.
@@ -0,0 +1,27 @@
 ## Floodgate setup on a BungeeCord/Velocity proxy
 :::info
 You only need to install Floodgate on the BungeeCord or Velocity proxy server, unless you want to use the Floodgate API on the backend servers.
 Additionally, it will display Bedrock edition skins properly.
 :::
 1. Download Floodgate for your proxy software from the [download page](https://geysermc.org/download). 
 2. Place the Floodgate jar in the `plugins` folder, and restart the proxy server.
 3. Change `auth-type` in Geyser's config to `floodgate`.
 4. Restart the server.
 ### Installing Floodgate on servers behind the proxy
 This is only needed when you want to use the Floodgate API on your backend server(s) behind a proxy.
 1. After installing Floodgate on the proxy, install Floodgate on the backend servers (either Floodgate-Spigot, or Floodgate-Fabric).
 2. Enable `ip_forward` in your BungeeCord `config.yml` if using BungeeCord. For Velocity, set up [player information forwarding](https://docs.papermc.io/velocity/player-information-forwarding).
 3. Set `bungeecord` to `true` in your spigot.yml. When using Velocity, see their guide, as they have multiple options that require different setups.
 4. Start the proxy server.
 5. Edit the Floodgate config on your proxy server and set `send-floodgate-data` to `true`.
 6. Copy the `key.pem` file in the proxy Floodgate config folder to all backend servers’ Floodgate config folder.
 7. Restart the backend servers and proxy server.
 :::danger
 DO NOT DISTRIBUTE THIS KEY TO ANYBODY! This key is what allows for Bedrock accounts to bypass the Java Edition authentication, and if anyone gets ahold of this, they can wreak havoc on your server.
 :::
@@ -0,0 +1,15 @@
 ## Floodgate setup with Geyser-Standalone
 :::info
 To be able to use Floodgate authentication, you need to be able to install Floodgate on the Java server you are connecting to.
 :::
 1. Download and install the platform-specific Floodgate jar (e.g. floodgate-spigot, or floodgate-fabric) [here](https://geysermc.org/download). 
 See the platform setup instructions for a detailed, platform specific setup guide. Then, continue with the instructions below.
 2. Change `auth-type` in Geyser Standalone's config to `floodgate`.
 3. Copy the `key.pem` file in the Floodgate config folder to the same directory as Geyser Standalone. 
 4. Restart Geyser-Standalone.
 :::danger
 DO NOT DISTRIBUTE THIS KEY TO ANYBODY! This key is what allows for Bedrock accounts to bypass the Java Edition authentication, and if anyone gets ahold of this, they can wreak havoc on your server.
 :::