diff --git a/Bukkit-Configuration.md b/Bukkit-Configuration.md index 001de4a..dc8b6a2 100644 --- a/Bukkit-Configuration.md +++ b/Bukkit-Configuration.md @@ -26,8 +26,8 @@ Setting | Default | Description -- | -- | -- 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 +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, such as request matching Delete_logs_after_days| `7` | Number of days after which log files are removed @@ -53,6 +53,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.
@@ -61,19 +62,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. @@ -89,6 +95,7 @@ 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) +Preserve_join_address_case | `false` | Case sensitive join address storage
@@ -114,7 +121,7 @@ Setting | Default (Unit) | Description AFK_threshold | `3` (`MINUTES`) | Idle time before Plan considers a player afk Activity_index.Playtime_threshold | `30` (`MINUTES`) | Playtime/Week to be considered Active by Activity Index Remove_inactive_player_data_after | `180` (`DAYS`) | How many days player has to not log in to be removed from the database -Remove_time_series_data_after | `90` (`DAYS`) | How many days Players online & Performance data is stored +Remove_time_series_data_after | `3650` (`DAYS`) | How many days Players online & Performance data is stored Remove_ping_data_after | `14` (`DAYS`) | How many days Ping data is stored Remove_disabled_extension_data_after | `2` (`DAYS`) | How many days data of disabled Extensions in stored @@ -128,7 +135,7 @@ Setting | Default (Unit) | Description -- | -- | -- Check_DB_for_server_config_files_every | `1` (`MINUTES`) | How often database is checked for updated config file Extension_data_refresh_every | `1` (`HOURS`) | How often server data for DataExtensions is updated -Clean_Database_every | `1` (`HOURS`) | How often database is cleaned of old data +Clean_Database_every | `1` (`HOURS`) | How often database is cleaned of old data. @@ -138,6 +145,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 @@ -220,6 +228,6 @@ Time | Formatted
Customized_files -- 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.
\ No newline at end of file