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

Created External WebServer Use (markdown)

Rsl1122 2017-12-06 09:59:51 +02:00
parent 907b626531
commit bdaf52cbc9
1 changed files with 55 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
External-WebServer-Use.md Normal file

@ -0,0 +1,55 @@
![Plan Header](https://puu.sh/vQyow.jpg)
# External WebServer Use
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.
Players page and scripts are exported when Plan enables.
The /players-page may contain dead links to Player pages because they are only exported when the player joins/leaves or the page is requested with /plan inspect
## Enabling HTML Export
```
Analysis:
...
Export:
Enabled: false
DestinationFolder: 'Analysis Results'
```
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.
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'`)
> 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.
On Bungee systems the Html is only exported by Plan on Bungee even if the export is enabled on the Bukkit servers.
The settings for Bungee Html Export work the same way.
## Disabling internal WebServer of Plan
On Bukkit servers it is possible to disable the WebServer.
> If you're running Plan with Bungee the internal WebServer is required by the WebAPI (Communication between Plan on Bukkit & Bungee) and **should not be disabled**
```
WebServer:
...
# For those that want to serve Html from their own WebServer instead.
# Set up Html Export (https://github.com/Rsl1122/Plan-PlayerAnalytics/wiki/External-WebServer-Use)
# ATTENTION: On BungeeCord systems it is not possible to disable the WebServer on the plugin due to WebAPI requirements.
# If the WebServer is disabled with this setting BungeeCord systems will cease to function.
DisableWebServer: false
ExternalWebServerAddress: "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.
ExternalWebServerAddress 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"`)