Files
GeyserWebsite/_includes/setup/instructions/geyser/selfhost/proxy.md
T
chrisandrtm516 d99084701f Feature: Port forwarding examples, providers.json rewording (#194)
* providers.json cleanup, yeet all non-minecraft hosts
advanced-setup.md start, include ovh/oci, or docker/ptero instructions there

* more little fixes

* portforwarding examples

* portforwarding page done?
minor other changes

* fix OVH link, break up long lines, srv records

* online/offline mode mismatch still exists

* portforwarding title instead of advanced setup

* spelling

* macOS instructions

* Rework providers.json

* yeet <br> in favor of bulletpoints

* yeet "\n", remove ni-host as supported

* Apply suggestions from code review

Co-authored-by: rtm516 <rtm516@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: rtm516 <rtm516@users.noreply.github.com>

* change \" to ', or `` depending on context

* mooooore ``

* Address review by @rtm516

---------

Co-authored-by: rtm516 <rtm516@users.noreply.github.com>
2023-09-05 20:01:36 +01:00

53 lines
3.1 KiB
Markdown

# Proxy setup - self-hosting
<div class="alert alert-info" role="alert">
NOTE: <br>
- Install Geyser <b>only</b> on the proxy server! You can install Floodgate on all servers for better skin support &
network-wide Floodgate API availability for other plugins. <br>
- All servers on the network must accept {{ site.data.versions.java }} Java clients, as Geyser imitates one.
</div>
1. Download the plugin for your proxy software from [the download page](https://geysermc.org/download).
2. Place the Geyser jar in the `plugins` folder, and restart the server.
3. Open your Geyser config, located in `/plugins/Geyser-xyz/config.yml`, and find the following:
```yaml
bedrock:
# The IP address that will listen for connections.
# Generally, you should only uncomment and change this if you want to limit what IPs can connect to your server.
#address: 0.0.0.0
# The port that will listen for connections. This is the port that Bedrock players will use to connect to your server.
port: 19132
```
The vital part is the port. This is the port that Bedrock players will use to connect to your server!
If you enable `clone-remote-port`, the port will be overridden and the Java port is used.
Since you are self-hosting, you can choose the port freely - the default port is 19132. <br>
**Important**: Other services/plugins that rely on ports with UDP, such as Voice Chats or Query, cannot share the port with Geyser.
<br>
4. Connecting to your server
<br> <br>
**Connecting locally in the same network** <br>
On the same device as the server, you can connect using `localhost`, or `127.0.0.1` as the address.
Do note: When hosting and playing on the same Windows device, you will need the [loopback fix](/geyser/fixing-unable-to-connect-to-world/#Using-Geyser-on-the-same-computer).
Other devices in the same local network can use your local IPv4 to connect - it starts with `10.` or `192.168.`.
<br> <br>
**Connecting from a different network**<br>
You will need to expose the port Geyser runs on to the Internet if you want players from outside your network to join.
To achieve that, you have two options: <br>
- Port forwarding: Open the Geyser port (e.g. 19132) on the UDP protocol in your router/modem, and in the Windows/Linux firewall.
[Our port forwarding guide](/geyser/port-forwarding) explains how to do this in detail.
Then, players can connect with your public IPv4 + port to your server. <br>
- playit.gg: Instead of opening a port (which might not be an option/if you do not want to expose your home ip), you can use
the playit.gg service to create a tunnel for you to route the traffic through. See our [playit.gg guide](/geyser/playit-gg).
Ngrok will not work since it is TCP-only. <br>
5. Verify whether connections from other networks are possible by running `geyser connectiontest <ip>:<port>` in the console.
<div class="alert alert-info" role="alert">
To allow Bedrock Edition players to join your server without needing to log in to a paid Java Edition account, you can use <a href="/floodgate/setup/">Floodgate</a>.
</div>