Updated Bungee Set Up (markdown)

Rsl1122 2018-07-13 09:12:21 +03:00
parent 0b36cc038e
commit 84ef60d2fa
1 changed files with 53 additions and 28 deletions

@ -10,25 +10,43 @@ This is the Set-Up tutorial for Bungee Networks. If you're installing the plugin
3. Install Plan on the Bukkit servers
4. Set-Up Bukkit-Bungee connection
## Create a MySQL Database for Plan
## 1. Create a MySQL Database for Plan
Create a new database in your MySQL with `CREATE DATABASE _dbname_`
## Install Plan on the Bungee server
Make sure to `GRANT PRIVILEGES` to the MySQL user for the new database.
1. Place the .jar in the plugins folder and restart the server
2. Change the config settings:
- **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`
> 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`
![1](http://puu.sh/zu9tA/15410504a1.png)
- **Database** Settings | Change these to the settings of the Database you just created.
#### 2.1.2 Database Settings
Change these to the settings of the Database you just created.
![2](http://puu.sh/zu9x5/9ccfb5428b.png)
- **WebServer.Port** | Change to a suitable port and open the port in the firewall.
#### 2.1.3 WebServer.Port
Change to a suitable port and open the port in the firewall.
![3](http://puu.sh/zu9yT/40433d2af6.png)
3. Reload the plugin with /planbungee reload
- [How to open a port on the firewall](https://github.com/Rsl1122/Plan-PlayerAnalytics/wiki/Bukkit-Set-Up#step-3-open-port-from-firewall)
> /planbungee reload is available even if plugin fails to enable.
### 2.2 Reload the plugin
## Install Plan on the Bukkit servers
`/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 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!
@ -37,35 +55,41 @@ Create a new database in your MySQL with `CREATE DATABASE _dbname_`
If the Bukkit server is not local, open the firewall for the port.
3. If IP in server.properties is empty, you should change `AlternativeIP `to an address or IP that points to the specific Bukkit server.
## Set-Up Bukkit-Bungee Connection
More about these steps on [[Bukkit Set Up]]
### Enable Bungee Set-up mode
## 4. Set-Up Bukkit-Bungee Connection
- Use `/planbungee setup` to enable setup mode on Bungee
### 4.1 Enable Bungee Set-up mode
Use `/planbungee setup` to enable setup mode on Bungee
![4](http://puu.sh/zu9CK/048e94b481.png)
### Connect Bukkit to Bungee
### 4.2 Connect Bukkit to Bungee
On each Bukkit server, use `/plan m setup <BungeeAddress>` command.
This will attempt to connect to the Bungee server.
> BungeeAddress can be found in the start-up log of Plan on Bungee:
> ![5](http://puu.sh/zu9L3/4c91abc94f.png)
If successful, Bungee will send it's Database settings & Plan will restart. Plan may restart again after checking the config settings found in the database.
If something goes wrong, you can debug the connection with `/planbungee con` and `/plan m con` - Two *OK*s means everything is set up and ready.
> **If Bukkit & Bungee are located on different machines**
> Ensure that:
> - MySQL settings on Bungee are not using localhost
> - MySQL accepts connections from outside the machine it is running on
> - The user in Bungee config does not prevent login from outside the machine
> - The MySQL user in Bungee Plan config does not prevent login from outside the machine
> - Bukkit has an address that is NOT localhost or empty (http://:8804)
> - This can be done by setting AlternativeIP Link as: `<nonLocalhostIP>:%port%`
On each Bukkit server, use `/plan m setup <BungeeAddress>` command.
This will attempt to connect to the Bungee server. If successful, Bungee will send it's Database settings & Plan will restart. Plan may restart again after checking the config settings found in the database.
> BungeeAddress can be found in the start-up log of Plan on Bungee:
> ![5](http://puu.sh/zu9L3/4c91abc94f.png)
### Reload Plan Bungee
### 4.3 Reload Plan Bungee
Use `/planbungee reload` to restart Plan on Bungee to ensure that Set-up is no longer allowed.
You can also use `/planbungee setup` to disable the set-up mode.
In case of a set-up malfunction you can join discord for support:
In case of a set-up difficulties you can join discord for support:
[Discord Support](https://discord.gg/yXKmjzT)
### For further configuration refer to:
@ -73,17 +97,18 @@ In case of a set-up malfunction you can join discord for support:
- [[Bukkit Configuration]]
- [Commands & Permissions](https://github.com/Rsl1122/Plan-PlayerAnalytics/wiki/Commands-%26-Permissions)
## Rare oddities
## Possible additional Set up
### Pterodactyl users
In order to access the Plan WebServer running on BungeeCord server, you need to add additional allocations for the port.
In order to access the Plan WebServer running on the Minecraft server, you need to [add additional allocations for the port](https://pterodactyl-guides.readme.io/docs/allocating-ips-and-ports-to-a-node).
### Azure or similar service
Make sure to enable port forwarding [Azure](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/nsg-quickstart-portal)
Make sure to [enable port forwarding on Azure](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/nsg-quickstart-portal)
**Config restart loop**
In some rare cases an odd symbol in the bungee config can cause an endless Plan restart loop, where Plan keeps restarting after checking the config settings from the Database.
### (Set-up bug) Config restart loop
In some rare cases an odd symbol in the bungee config can cause an endless Plan restart loop on the Bukkit server, where Plan keeps restarting after checking the config settings from the Database.
This can be stopped by setting `Bungee-Override.CopyBungeeConfig: false` in the Plan config.