Upstream
/
Plan
mirror of https://github.com/plan-player-analytics/Plan.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated Bukkit Configuration (markdown)

Risto Lahtela 2021-01-29 15:43:02 +02:00
parent 040ee9113c
commit 8a62dd1909
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Bukkit-Configuration.md

@ -1,12 +1,12 @@
![Plan Header](http://puu.sh/AXSg7/5f2f78c06c.jpg)
# Bukkit/Sponge Configuration
# Game Server Configuration
This page is about the **Bukkit/Sponge/Nukkit** *config.yml* file and the various settings it provides.
For Bungee see [[Bungee Configuration]]
- [Default Config](https://github.com/plan-player-analytics/Plan/blob/master/Plan/common/src/main/resources/assets/plan/config.yml)
Page version: **5.0 build 367**
Page version: **5.1 build 813**
# Settings by Section
@ -24,7 +24,7 @@ ServerName | `Plan` | Name of the server, displayed on the page and used to acce
Setting | Default | Description
-- | -- | --
Locale | `default` | 2 letter Locale code, see [[Localization]]
Locale | `default` | 2 letter Locale code, see [[Localization]]. `default` for English. `write-all` to write all locales' files
Create_new_locale_file_on_next_enable| `false` | Writes a new `locale.txt` file to the plugin folder on enable.
Debug | `false` | Logger debug mode, takes one or multiple options `'true'`/`'both'`/`'all'`,`'false'`,`'console'`,`'file'`,`'memory'`. Example: `"file, console"`
Dev | `false` | Enables development error logging as well as other debug messages
@ -53,6 +53,8 @@ MySQL.User | `root` | User for editing the database
MySQL.Password | `minecraft` | Password of `MySQL.User`
MySQL.Database | `Plan` | Name of the Database to use
MySQL.Launch_options| `?rewriteBatchedStatements=true&useSSL=false` | Launch options to use
H2.User | `root` | H2 is deprecated, this field is used due to log in the h2 file
H2.Password | `minecraft` | H2 is deprecated, this field is used due to log in the h2 file
</details>
<details>
@ -66,8 +68,10 @@ Alternative_IP.Address | `your.domain.here:%port%` | Address to use as link in i
Internal_IP| `0.0.0.0` | Internal InetAddress to start the WebServer on. 0.0.0.0 manages the Internal IP automatically. No need to change unless running in Docker.
Security.SSL_certificate | | [View the tutorial on setting up a SSL Certificate](https://github.com/plan-player-analytics/Plan/wiki/SSL-Certificate-%28HTTPS%29-Set-Up)
Security.CORS.Allow_origin | '"*"' | Allows other sites to fetch JSON from Plan webserver.
Security.IP_whitelist | `false` | Enables or disables the IP whitelist for the webserver
Security.IP_whitelist.Whitelist | locahost | List of IP addresses to allow accessing the webserver
Disable_Webserver| `false` | Disables the WebServer. This is for [[External WebServer Use]]
External_Webserver_address| `https://www.example.address` | Address to give to users when Plan WebServer is disabled.
External_Webserver_address | `https://www.example.address` | Address to give to users when Plan WebServer is disabled.
</details>
<details>
@ -78,6 +82,7 @@ Setting | Default | Description
Geolocations | `true` | Enable Geolocation gathering
Accept_GeoLite2_EULA | `false` | Allow downloading GeoLite2 Database (Better for geolocation)
Ping | `true` | Enable ping gathering
Disk_space | `true` | Enable free disk space gathering
Commands.Log_unknown| `false` | Log commands that are not registered, e.g. /bremobmreb (Currenly not in use)
Commands.Log_aliases_as_main_command | `true` | Combines command aliases to the main command, e.g. /i to /give (Currenly not in use)