Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-11-28 21:56:35 +01:00
Code Issues Projects Releases Wiki Activity

Updated Bungee Configuration (markdown)

Aurora Lahtela 2023-10-07 08:16:50 +03:00
parent 82c236f664
commit 301efdf346
1 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Bungee-Configuration.md

@ -6,14 +6,15 @@ For Bukkit or Sponge see [[Bukkit Configuration]]
- [Default Config](https://github.com/plan-player-analytics/Plan/blob/master/Plan/common/src/main/resources/assets/plan/bungeeconfig.yml)
Page version: **5.4 build 1485**
Page version: **5.6 build 2574**
# Settings
## Server
Setting | Default | Description
-- | -- | --
IP | `0.0.0.0` | Since Bungee does not provide a get IP method, IP of the server running Bungee has to be manually set. Set this to an address or IP that connects to the Bungee server machine. **If this setting is not changed from default the plugin will not function**
IP | `0.0.0.0` | Since Bungee does not provide a get IP method, IP of the server running Bungee has to be manually set. Set this to an address or IP that connects to the Bungee server machine.
Name | `Plan` | Uniquely identifies a proxy server if you have multiple. If it is default then `Proxy <id>` is shown on website instead.
Network.Name | `'Plan'` | This name is displayed on the Network page.
## Server Configuration on BungeeCord
@ -33,7 +34,7 @@ Setting | Default | Description
-- | -- | --
Locale | `default` | 2 letter Locale code, see [[Localization]]
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"`
Log_untranslated_locale_keys | `false` | Logs keys that have default value in the currently in-use locale to console. This is to help translators update files.
Dev | `false` | Enables development error logging as well as other debug messages
Delete_logs_after_days| `7` | Number of days after which log files are removed
@ -58,6 +59,7 @@ 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
MySQL.Max_Lifetime | `25 MINUTES` | How long HikariCP will keep connection in the pool. Reduce this if you are getting connection timeout errors.
</details>
<details>
@ -66,19 +68,24 @@ MySQL.Launch_options| `?rewriteBatchedStatements=true&useSSL=false` | Launch opt
Setting | Default | Description
-- | -- | --
Port | `8804` | Port of the Webserver
Alternative_IP | `false` | Should an alternate address be used for the WebServer links
Alternative_IP.Enabled | `false` | Should an alternate address be used for the WebServer links
Alternative_IP.Address | `your.domain.here:%port%` | Address to use as link in inspect and analyze commands if setting above is enabled. %port% will be replaced with the Port automatically. If you have port-forwarded an alternate address to the webserver port, %port% is not required.
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.
Public_html_directory | `"public_html"` | [[Html Customization]] feature that allows hosting any files on the Plan webserver.
Cache.Reduced_refresh_barrier | 15 SECONDS | Prevents constant json updates with this threshold
Cache.Invalidate_query_results_on_disk_after | 7 DAYS | How long to store query page results so that they can be shared
Cache.Invalidate_disk_cache_after | 2 DAYS | How long to store json for the panel data, note that old panel data is deleted when new one is cached.
Cache.Invalidate_memory_cache_after | 5 MINUTES | How long to store json for the panel data in memory, same as above applies.
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.Disable_authentication | `false` | Disables login if HTTPS is enabled.
Security.Disable_registration | `false` | Disables user registration page if HTTPS is enabled.
Security.Access_log.Print_to_console | `false` | Print any incoming request to the console log.
Security.Access_log.Remove_logs_after_days | 30 | How long access log is kept in the Plan database.
Security.CORS.Allow_origin | '"*"' | Allows other sites to fetch JSON from Plan webserver.
Security.Use_X-Forwarded-For_Header | `false` | Allows you to use whitelist with reverse-proxy
Security.Cookies_expire_after | 2 HOURS | Determine time after login-cookies expire
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
Security.IP_whitelist.Enabled | `false` | Enables or disables the IP whitelist for the webserver
Security.IP_whitelist.Whitelist | locahost | List of IP addresses to allow accessing the webserver. Supports wildcards, cidr and dynamic dns (see comment above the setting)
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.
@ -91,6 +98,8 @@ 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
Preserve_join_address_case | `false` | Case sensitive join address storage
</details>
@ -140,6 +149,7 @@ Clean_Database_every | `1` (`HOURS`) | How often database is cleaned of old data
Setting | Default | Description
-- | -- | --
Theme | `default` | See [[Themes]] for more details about this setting
Player_head_image_url | `"https://crafatar.com/avatars/${playerUUID}?size=120&default=MHF_Steve&overlay"` | Change service for player head images
Sessions.Show_on_page | `50` | How many sessions are visible on a page
Sessions.Order_world_pies_by_percentage | `false` | By Default WorldPie is ordered alphabetically, colors are still determined alphabetically.
Players_table.Show_on_server_page | `2500` | How many players are visible on /server page Players tab
@ -221,6 +231,6 @@ Time | Formatted
<summary>Customized_files</summary>
- Related to [Html Customization](https://github.com/plan-player-analytics/Plan/wiki/Html-Customization) and web developer mode (see article for that).
- Related to [PageExtension Resource API](https://github.com/plan-player-analytics/Plan/wiki/APIv5-PageExtension-API) that allows users to edit web files added to Plan by 3rd party plugins.
</details>