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

Updated External WebServer Use (markdown)

Risto Lahtela 2019-01-17 14:54:06 +02:00
parent 6ede5e210f
commit d69a34cf39
1 changed files with 26 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
External-WebServer-Use.md

@ -1,9 +1,6 @@
![Plan Header](http://puu.sh/AXSg7/5f2f78c06c.jpg)
# External WebServer Use
> **4.6.0 has been released, but config settings are not yet up to date.**
> Please be patient as it will take a while to update all config references.
Plan offers some **limited support** for use with an external WebServer running on the same machine as the minecraft server. (And possibly another machine if network mounted drives are available)
This is done by exporting the HTML files whenever Analysis or a command like /plan inspect is run.
@ -13,19 +10,31 @@ The /players-page may contain dead links to Player pages because they are only e
## Enabling HTML Export
```
Analysis:
...
Export:
Enabled: false
DestinationFolder: 'Analysis Results'
# -----------------------------------------------------
# These settings will make Plan write .js, .css, .json and .html files to some location on disk.
# Relative path will render to /plugins/Plan/path
# Make sure user running the server has write permissions to the path.
# -----------------------------------------------------
Export:
HTML_Export_path: 'Analysis Results'
JSON_Export_path: 'Raw JSON'
Parts:
JavaScript_and_CSS: false
# Player pages/JSON are only written on join/leave.
Player_pages: false
Player_JSON: false
Players_page: false
Server_page: false
Server_JSON: false
```
Setting | Description
-- | --
Export.Enabled | Enables exporting the files to the DestinationFolder
Export.DestinationFolder | Folder inside /plugins/Plan/ or a full path to the folder that the files should be exported to.
HTML_Export_path | Folder inside /plugins/Plan/ or a full path to the folder that the HTML files should be exported to.
JSON_Export_path | Folder inside /plugins/Plan/ or a full path to the folder that the JSON files should be exported to.
Parts | Enables exporting the files to the respective export path
If your external web server is serving files from a folder on the machine, it is recommended to copy the full path to the DestinationFolder setting (For example `'C:\webserver\public_html'` or `'etc/webserver/public_html'`)
If your external web server is serving files from a folder on the machine, it is recommended to copy the full path to the HTML_Export_path setting (For example `'C:\webserver\public_html'` or `'etc/webserver/public_html'`)
> Ensure that the user running the minecraft server has write & read permission to the folder you're exporting the files to, otherwise exceptions will occur when creating the files.
@ -38,16 +47,16 @@ On Bukkit servers it is possible to disable the WebServer.
> If you're running Plan with Bungee, the internal WebServer is required for communication between Bukkit & Bungee and **should not be disabled**
```
WebServer:
Webserver:
...
DisableWebServer: false
ExternalWebServerAddress: "https://www.example.address"
Disable_Webserver: false
External_Webserver_address: "https://www.example.address"
```
Setting | Description
-- | --
DisableWebServer | Disables the WebServer initialization (WebServer is not started on Enable)
ExternalWebServerAddress | Address that is used instead of the WebServer address when the WebServer is offline.
Disable_Webserver| Disables the WebServer initialization (WebServer is not started on Enable)
External_Webserver_address| Address that is used instead of the WebServer address when the WebServer is offline.
ExternalWebServerAddress should be set to an address that allows appending of folder names such as /player/playername & /server etc.
External_Webserver_address should be set to an address that allows appending of folder names such as /player/playername & /server etc.
If you export the html to a separate folder (eg. `../public_html/plan`) The setting should reflect that (`"https://www.example.address/plan"`)