Bungee Set Up

Bungee/Velocity Set-Up

This is the Set-Up tutorial for Networks. If you're installing the plugin on a single server refer to Bukkit Set-Up

Steps

1. Create a MySQL Database for Plan
2. Install Plan on the Bungee server
3. Install Plan on the Bukkit servers

1. Create a MySQL Database for Plan

Create a new database in your MySQL with CREATE DATABASE _dbname_

Make sure to GRANT PRIVILEGES to the MySQL user for the new database.

Plan uses a plan_ prefix on all table names, so you can use an existing database.

2. Install Plan on the Bungee server

Place the .jar in the plugins folder and restart the server

2.1 Change the config settings:

2.1.1 Server.IP

Change this to the Address or IP used to connect to your bungee server directly (Without port) - For example play.exampleserver.com or 123.123.4.5

2.1.2 Database Settings

Change these to the settings of the Database you just created.

In case Plan starts with MySQL-error about unrecognized timezone, set up your default timezone for MySQL

2.1.3 WebServer.Port

Plan has a built in webserver - extra web hosting provider is not required if you have an open port on your server. On Bungee/Velocity only one webserver is required.

Change to a suitable port and open the port in the firewall.

• How to open a port on the firewall

Pterodactyl users
The port must be allocated to be accessible, see Possible Additional Setup section

2.2 Reload the plugin

/planbungee reload

/planbungee reload is available even if plugin fails to enable so that you can change the config settings easily.

3. Install Plan on the Bukkit/Sponge servers

NOTE: Do not copy-paste ServerInfoFile.yml: This file stores ServerUUID which differentiates servers from each other. Same ServerUUID will lead to Bungee sending same config settings to two servers!

1. Place the .jar to the plugins folder and restart the bukkit server.
2. Set the Database settings to the same MySQL Bungee is using (Also change Database.Type to MYSQL)
3. Disable the Plan webserver on this server with Webserver.Disable_Webserver setting
4. plan reload on the server

In case of a set-up difficulties you can join discord for support: Discord Support

4. (Optional) Protect the Website with a Login Prompt

In order to enable user authentication, HTTPS set up is required.
This requires a Certificate to be installed in a Java Keystore:

• How to set up SSL Certificate

You can use the same Keystore on all servers.

For further configuration refer to:

• Bungee Configuration
• Bukkit Configuration
• Commands & Permissions

Possible additional Set up

Pterodactyl users

On Pterodactyl the port Plan runs on needs to be allocated.

• Go to node category of your panel (http(s)://panel.domain.com/admin/nodes) & create a new node if you don't have one.
• Navigate to The node > Allocation
• On the right side in Assign New Allocations, put your IP Address (Alias is not necessary) & fill in the port(s) you wish to reserve (for all servers).
• Next, Choose a server from http(s)://panel.domain.fr/admin/servers & navigate to Build Configuration > Allocation Management
• Click on Assign Additional Ports and choose what port(s) you wish to assign to this server. Click Update Build Configuration to save changes.

After the steps change Alternative_IP settings in Plan config to point to the machine Pterodactyl is running on.

Only Bungee WebServer needs to be accessible from outside the machine, but other servers need to be able to communicate with each other.

Azure or similar service

Make sure to enable port forwarding on Azure