Changes between Version 20 and Version 21 of Integrated Webserver

Timestamp:

Jul 31, 2023, 4:30:24 PM (16 months ago)

Author:

Christian Illy

Comment:

--

Integrated Webserver

@@ -14 +14 @@
 
 == Access ==
-The webserver will listen on the port defined as ControlPanelPort (from serverconfig) + 2. I.e. if you have set ControlPanelPort to 8080 (as it is by default) the webserver will listen on ''!http://<yourIpOrDomain>:8082/''
+As from mod version 25_30_44 onwards the mod does no longer provide its own HTTP interface but uses vanilla's. Thus the WebDashboard needs to be enabled in the serverconfig and you can access the mod's page on ''!http://<yourIpOrDomain>:8080/legacymap'' (assuming you did not change the port from its default).
 
 
@@ -20 +20 @@
 To check if the webserver was started look at the output_log.txt. It should contain a line like:
 {{{
-1.234 Started Webserver on 8082
+1.234 Started legacy webmod feature on port 8080, local adress /legacymap
 }}}
-If it does the server was started on the given port.
+If it does the mod should show on the given port and path.
 
 
@@ -44 +44 @@
 == Web Tokens ==
 As tools like server managers obviously can not identify themselves with Steam login a token system has been added. That way those tools can provide a predefined token on ''each'' request to the webserver and those requests will be handled with the permission level given to that specific token. Web tokens are set up with the ''webtokens'' command.
-The tokens have to be passed to each request like this:
- !http://<server>:<port>/map/0/2/1.png?'''adminuser=<tokenuserpart>&admintoken=<tokenpasswordpart>'''
-For example, if your server is running on your machine, port 8082 and you added a webtoken with name "admin" and password "supersecrettoken" a request would look like this:
- !http://localhost:8082/api/getstats?adminuser=admin&admintoken=supersecrettoken
+The tokens have to be passed to each request as HTTP headers, e.g.
+{{{
+GET /map/0/2/1.png
+X-SDTD-API-TOKENNAME: <your tokenname here>
+X-SDTD-API-SECRET: <your token secret here>
+}}}
+For example, if your server is running on your machine, port 8080 and you added a webtoken with name "admin" and password "supersecrettoken" a request sent to ''!http://localhost:8080'' would look like this:
+{{{
+GET /api/getstats
+X-SDTD-API-TOKENNAME: admin
+X-SDTD-API-SECRET: supersecrettoken
+}}}
 
 
 == apache and mod_proxy ==
-If you already have a domain for your server and want a nice looking domain like 7dtd.example.com for your internal webserver instead of http://example.com:8082/ you can use apache and mod_proxy.
+If you already have a domain for your server and want a nice looking domain like 7dtd.example.com for your internal webserver instead of !http://example.com:8082/ you can use apache and mod_proxy.
 We will use apache and ubuntu to provide an example but any other web server or os may be used in a similar way. We will use "example.com" as our domain, please replace it with your own domain or IP address.
 
@@ -89 +97 @@
 }}}
 
-now active the new config and restart apache
+now activate the new config and restart apache
 {{{
 a2ensite 7dtd.example.com.conf
@@ -97 +105 @@
 You should now be able to visit 7dtd.example.com and see the map.
 
-'''Please note that this is _not_ a secure way to hide the ControlPanelPort from your users! Port scanning is always an option!
-
-
-== Planned stuff ==
-* List of players (filter by online, banned, admin/mod, permission level ... anything else?)
-  * Info: name, steamid, ip, playtime, last seen, online/offline, stats, last position ...
-  * Kick/Ban, change permission level
-  * show on map
-  * show trail
-  * show keystones as list and on map (with claimed area overlay)
-  * Send PM
-  * ... ?
-* List of command permissions
-* Chat log
-* Console log
-* ... ?
+'''Please note that this is _not_ a secure way to hide the WebDashboardPort from your users! Port scanning is always an option!'''