Update documentation

github-actions[bot] · github-actions[bot] · commit 4d9f215fb7ae · 2025-08-23T18:47:36.000Z
diff --git a/docs/README.md b/docs/README.md
@@ -12,13 +12,15 @@ title: README
 You've found a comprehensive solution that helps you administrate your DCS World servers. It has a Discord integration 
 ([now optional](#dcsserverbot-installation-non-discord)!) with slash-commands, built in per-server and per-user 
 statistics, optional cloud-based statistics, [Coalitions](./COALITIONS.md)-support, a whole 
-[Tournament-System](./plugins/tournament/README.md) and much more!<br> 
+[Tournament-System](./plugins/tournament/README.md), a third-party [web-frontend](https://github.com/Penfold-88/DCS-Statistics-Dashboard) for
+statistics and much more!
+<p> 
 With its plugin system and reporting framework, DCSServerBot can be enhanced very easily to support whatever might come 
 into your mind. DCSServerBot is a solution for DCS server admins built by a DCS server admin.
-
+<p>
 This documentation shows you the main features, how to install and configure the bot and some more sophisticated 
 stuff at the bottom, if you for instance run multiple servers maybe even over multiple locations. 
-
+<p>
 Now let's see what DCSServerBot can do for you (installation-instructions [below](#installation))!
 
 ---
@@ -345,7 +347,7 @@ NODENAME:                       # this will usually be your hostname
   listen_address: 0.0.0.0       # Optional: On which interface should the bot listen? Default is 127.0.0.1.
   public_ip: 88.77.66.55        # Optional: Your public IP. ONLY if you have a static IP (!), put this in here to speedup the startup-process of the bot.
   slow_system: false            # Optional: if you are using a slower PC to run your servers, you should set this to true (default: false)
-  use_upnp: true                # The bot will auto-detect, if there is an UPnP IGD available and configure this setting initially for you! If you do NOT want to use UPnP, even IF it is abailable, put this to false.
+  use_upnp: true                # The bot will auto-detect, if there is an UPnP IGD available and configure this setting initially for you! If you do NOT want to use UPnP, even IF it is available, put this to false.
   preferred_master: true        # cluster only: this node should be the preferred master node (default: false)
   heartbeat: 30                 # cluster only: time for the heartbeat between the master and agent nodes to run (default: 30)
   cloud_drive: false            # cluster only: set this to false, if you do not have the bot installed on a cloud drive (default and recommended: true) 
@@ -370,6 +372,17 @@ NODENAME:                       # this will usually be your hostname
     cloud: true                 # If you have installed DCS on a NAS or cloud drive, autoupdate and desanitization will only take place once on all your nodes.
     desanitize: true            # Desanitize your MissionScripting.lua after each update. Default is true.
     minimized: true             # Start DCS minimized (default: true)
+    allow_unsafe_api:           # as of DCS 2.9.18: allow dostring_in only in these environments
+      - scripting
+      - gui
+      - userhooks
+    allow_dostring_in:          # as of DCS 2.9.18: allow dostring_in only targeting these contexts
+      - scripting
+      - config
+      - server
+      - mission
+      - gui
+      - export
     user: xxxx                  # Your DCS username (only needed for specific use-cases)
     password: xxxx              # Your DCS password (will be auto-moved by the bot to a secret place)
   instances:
diff --git a/docs/extensions/olympus/README.md b/docs/extensions/olympus/README.md
@@ -17,6 +17,8 @@ DCS_MERCS:
   - name: DCSOlympus
     version: latest
     source: SavedGames
+    # uncomment for auto-update:
+    # repo: https://github.com/Pax1601/DCSOlympus
 ```
 To use the DCS Olympus client, you need [Node.js](https://nodejs.org/download/release/latest-v20.x/) installed.
 Click on the link, download and install it. Remember the installation location, as you need to provide it in the 
diff --git a/docs/extensions/srs/README.md b/docs/extensions/srs/README.md
@@ -38,12 +38,14 @@ MyNode:
           config: '{instance.home}\Config\SRS.cfg'
           host: 127.0.0.1
           port: 5002
-          minimized: true     # start SRS minimized (default: true)
+          gui_server: true    # Optional: use the SRS-Server.exe (GUI server) instead of the command line one
+          minimized: true     # Old SR-Server.exe: start SRS minimized (default: true)
           autoconnect: true   # install the appropriate DCS-SRS-AutoConnectGameGUI.lua, default: true
           awacs: true         # if you use LotAtc
           lotatc_export_port: 10712
           blue_password: blue
           red_password: red
+          show_passwords: false   # Optional: do not show red/blue passwords in the status embed (default: true)
           radio_effect_override: false                # optional: disable radio effects (LOS, etc)
           global_lobby_frequencies: 248.22,30.0,127.0 # optional: set your music channels in here
           autostart: true     # optional: if you manage your SRS servers outside of DCSSB, set that to false
diff --git a/docs/plugins/README.md b/docs/plugins/README.md
@@ -278,7 +278,7 @@ function myplugin.onPlayerConnect(id)
     dcsbot.sendBotTable(msg)
 end
 
-DCS.setUserCallbacks(myplugin)
+Sim.setUserCallbacks(myplugin)
 ```
 
 ### lua/commands.lua
@@ -292,7 +292,7 @@ local dcsbot = base.dcsbot
 
 function dcsbot.pauseMission(json)
     log.write('DCSServerBot', log.DEBUG, 'Mission: pauseMission()') 
-    DCS.setPause(true)
+    Sim.setPause(true)
 end
 ```
 
diff --git a/docs/plugins/creditsystem/README.md b/docs/plugins/creditsystem/README.md
@@ -14,10 +14,11 @@ away due to punishment points a player gets due to team-kills or the like.
 ## Configuration
 The CreditSystem is configured with a file named config\plugins\creditsystem.yaml. You'll find a sample file in that directory:
 ```yaml
-DEFAULT:              # valid for all servers
-  initial_points: 10  # The initial points a player gets (default = 0).
-  max_points: 100     # The maximum points a player can get (default = unlimited).
-  multiplier: 1       # multiplier for credit points on proper landings (if payback is enabled in slotblocking.yaml)
+DEFAULT:                # valid for all servers
+  initial_points: 10    # The initial points a player gets (default = 0).
+  max_points: 100       # The maximum points a player can get (default = unlimited).
+  multiplier: 1.0       # multiplier for credit points on proper landings if payback is enabled in slotblocking.yaml (default: 1.0)
+  points_on_rtb: false  # only give credit points on RTB (default: false)
   squadron_credits: true # enable squadron credits (see below).
   squadron:
     initial_points: 100 # default: 0
diff --git a/docs/plugins/mission/README.md b/docs/plugins/mission/README.md
@@ -73,10 +73,25 @@ DEFAULT:
 You can configure the behaviour of the mission plugin with an optional config/plugins/mission.yaml:
 ```yaml
 DEFAULT:
-  uploads:              # Configure how mission uploads are handled
-    enabled: true       # Here you can disable the feature at all (default: true = enabled)
+  event_filter:       # do NOT report these events (default: [])
+    - connect
+    - disconnect
+    - change_slot
+    - friendly_fire
+    - self_kill
+    - kill
+    - takeoff
+    - landing
+    - crash
+    - eject
+    - pilot_death
+    - shot
+    - hit
+  uploads:                      # Configure how mission uploads are handled
+    enabled: true               # Here you can disable the feature at all (default: true = enabled)
+    channel: 112233445566778899 # Optional: mission upload channel (default: admin channel)
     discord:
-      - DCS Admin       # Define which roles are allowed to upload missions (default: DCS Admin)
+      - DCS Admin               # Define which roles are allowed to upload missions (default: DCS Admin)
 ```
 
 ## Auto-Scanning
diff --git a/docs/plugins/motd/README.md b/docs/plugins/motd/README.md
@@ -67,7 +67,7 @@ If you want to play sounds, make sure that you loaded them into the mission firs
       display_type: chat      # the message will be displayed in the in-game chat
     - delay: 120              # this message will be displayed every 2 mins
       message: "To see your stats, you can link your user by using /linkme in your discord!"
-      receipients: '!@everyone' # and will be sent to anybody that is not linked yet (has not the discord role @everyone)
+      recipients: '!@everyone' # and will be sent to anybody that is not linked yet (has not the discord role @everyone)
       display_type: popup     # Message will be a popup
 ```
 
diff --git a/docs/plugins/punishment/README.md b/docs/plugins/punishment/README.md
@@ -33,10 +33,13 @@ DEFAULT:
     human: 12
     AI: 8
     reason: Friendly fire on a team member
-  - event: collision_hit    # if you hit another team member, you get 5 points, 1 if it was an AI.
+  - event: collision_hit    # If you hit another team member, you get 5 points, 1 if it was an AI.
     human: 5
     AI: 1
     reason: Colliding with a team member
+  - event: reslot           # If you re-slotted when being shot at, you get 30 points (you stole a kill)
+    default: 30
+    reason: Respawning when being shot at
   forgive: 30               # People can forgive others in-between of 30 seconds (default) with the .forgive in-game chat command.
   punishments:              # list of punishments, based on the users penalty points
   - points: 100             # we temp-ban the player when they reached 100 points.
diff --git a/docs/plugins/restapi/README.md b/docs/plugins/restapi/README.md
@@ -5,8 +5,8 @@ nav_section: plugins/restapi
 ---
 
 # Plugin RestAPI
-This API provides a very simple RestAPI that you can call from your webserver to receive data from DCSServerBot.
-It is WIP, and it will be enhanced in the future.
+This API provides a very simple RestAPI that you can user together with the [WebService](../../services/webservice/README.md).
+You can use it to power the [DCS Statistics Dasboard](https://github.com/Penfold-88/DCS-Statistics-Dashboard).
 
 ## Configuration
 As RestAPI is an optional plugin, you need to activate it in main.yaml first like so:
@@ -15,26 +15,42 @@ opt_plugins:
   - restapi
 ```
 
-There is some very basic endpoint configuration available as of now, which you can add in your 
-config/plugins/restapi.yaml like so:
+You can configure the RestAPI endpoints in your config\plugins\restapi.yaml like so:
 ```yaml
 DEFAULT:
-  listen: 0.0.0.0   # the interface to bind the internal webserver to
-  port: 9876        # the port the internal webserver is listening on
-  prefix: /stats    # use this prefix (optional)
+  prefix: /stats            # Optional: use this prefix
+  api_key: aaabbbcccc       # Optional: API key to be used to secure the API
+  endpoints:                 # endpoint configuration
+    servers:                # /servers
+      filter:               # config parameter (in this case, the server filter list)
+        - 'MyPrivateServer' # Do not show a server named "MyPrivateServer"
+        - '(.*)Private(.*)' # Do not show any server that has "Private" in its name 
 ```
 
+> [!WARNING]
+> Do NOT use a prefix if you work with the DCS Statistics Dasboard!
+
 ## RestAPI
 The following commands are available through the API
 
-| API        | GET / POST | Parameters                      | Return                                                                                                                                                                                                                                               | Description                                                                           |
-|------------|------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|
-| /getuser   | POST       | nick: string                    | {"name": string, "last_seen": date}                                                                                                                                                                                                                  | Return a list of players ordered by last seen that match this nick.                   |
-| /stats     | POST       | nick: string, date: date        | {<br>"deaths": int,<br>"aakills": int,<br>"aakdr": float,<br>"lastSessionKills": int,<br>"lastSessionDeaths": int,<br>"killsbymodule": [<br>{"module": string, "kills": int}<br>],<br>"kdrByModule": [<br>{"module": string, "kdr": float}<br>]<br>} | Statistics of this player                                                             |
-| /topkills  | GET        |                                 | {"fullNickname": string, "AAkills": int, "deaths": int, "AAKDR": float}                                                                                                                                                                              | Top 10 of players ordered by kills descending.                                        |
-| /topkdr    | GET        |                                 | {"fullNickname": string, "AAkills": int, "deaths": int, "AAKDR": float}                                                                                                                                                                              | Same as /topkills but ordered by AAKDR descending.                                    |
-| /missilepk | POST       | nick: string, date: date        | {"weapon": {"weapon-name": string, "pk": float}}                                                                                                                                                                                                     | Probability of kill for each weapon per given user.                                   |
-| /linkme    | POST       | discord_id: string, force: bool | {"token": 1234, "timestamp": "2025-02-03 xx:xx:xx...", "rc": 0}                                                                                                                                                                                      | Same as /linkme in discord. Returns a new token that can be used in the in-game chat. |
+| API               | GET / POST | Parameters                                            | Description                                                                           |
+|-------------------|------------|-------------------------------------------------------|---------------------------------------------------------------------------------------|
+| /serverstats      | GET        |                                                       | A comprehensive statistic for your whole setup.                                       |
+| /servers          | GET        |                                                       | Status for each server.                                                               |
+| /getuser          | POST       | nick: string                                          | Return a list of players ordered by last seen that match this nick.                   |
+| /stats            | POST       | nick: string, date: date                              | Statistics of this player                                                             |
+| /highscore        | GET        | [server_name: string], [period: string], [limit: int] | Highscore output                                                                      |
+| /topkills         | GET        | [limit: int]                                          | Top x of players ordered by kills descending.                                         |
+| /topkdr           | GET        | [limit: int]                                          | Same as /topkills but ordered by AAKDR descending.                                    |
+| /trueskill        | GET        | [limit: int]                                          | Top x trueskill ratings.                                                              |
+| /weaponpk         | POST       | nick: string, date: date                              | Probability of kill for each weapon per given user.                                   |
+| /credits          | POST       | nick: string, date: date, [campaign]                  | Credits of a specific player.                                                         |
+| /traps            | POST       | nick: string, date: string, [limit: int]              | Lists the traps of that user.                                                         |
+| /squadrons        | GET        |                                                       | Lists all squadrons.                                                                  |
+| /squadron_members | POST       | name: string                                          | Lists the members of the squadron with that name.                                     |
+| /squadron_credits | POST       | name: string, [campaign]                              | Lists the members of the squadron with that name.                                     |
+| /linkme           | POST       | discord_id: string, force: bool                       | Same as /linkme in discord. Returns a new token that can be used in the in-game chat. |
 
-> [!IMPORTANT]
-> It is advisable to use a reverse proxy like nginx and maybe an SSL encryption between your webserver and this endpoint. 
+> [!NOTE]
+> To get a more detailled API-documentation, please enable debug in your WebService config and 
+> access https://localhost:9876/docs.
diff --git a/docs/services/cron/README.md b/docs/services/cron/README.md
@@ -108,9 +108,9 @@ DEFAULT:
 ```
 
 e) popup
-Send a popup
+Send a popup to a running server.
 ```yaml
-DEFAULT:
+DCS.server_release:
   actions:
     - cron: '55 3 * * 1'                # Send a message to everyone at Mo, 03:55h
       action:
@@ -120,7 +120,20 @@ DEFAULT:
           timeout: 20
 ```
 
-f) purge_channel
+f) broadcast
+Send a popup to all running servers.
+```yaml
+DEFAULT:
+  actions:
+    - cron: '55 3 * * 1'                # Send a message to everyone at Mo, 03:55h
+      action:
+        type: broadcast                     
+        params:
+          message: Server will shut down in 5 mins!
+          timeout: 20
+```
+
+g) purge_channel
 Delete messages from a Discord channel.
 ```yaml
 DEFAULT:
@@ -136,7 +149,7 @@ DEFAULT:
           ignore: 119922883377446655    # ignore this user id AND message id (either the bot's or persistent messages in the channel); can be either an ID or a list of IDs
 ```
 
-g) dcs_update
+h) dcs_update
 Run a DCS update at a specific time.
 ```yaml
 DEFAULT:
@@ -149,3 +162,15 @@ DEFAULT:
             - 120
             - 60
 ```
+
+i) node_shutdown
+Shutdown / restart the bot.
+```yaml
+DEFAULT:
+  actions:
+    - cron: '0 3 * * *'     # run every night at 03:00
+      action:
+        type: node_shutdown  # restart the bot
+        params:
+          restart: true
+```
diff --git a/docs/services/music/README.md b/docs/services/music/README.md
@@ -25,6 +25,7 @@ DEFAULT:
   popup: Now playing {song} on {frequency}{modulation}  # optional - popup message when a song starts to play
   chat: Now playing {song} on {frequency}{modulation}   # optional - chat message when a song starts to play
   pause_without_players: false    # Pause music, when no player is active (default: true)
+  debug: true                     # Put the output of DCS-SR-ExternalAudio.exe to the dcssb*.log
   radios:
     Radio 1:                      # Name of the radio, can be anything
       type: SRSRadio              # we currently only support SRS, so this has to be in
diff --git a/docs/services/webservice/README.md b/docs/services/webservice/README.md
@@ -0,0 +1,30 @@
+---
+layout: default
+title: README
+nav_section: services/webservice
+---
+
+# Service WebService
+This service provides a simple web service. It is WIP, and it will be enhanced in the future.
+Currently you can use it with the [RestAPI plugin](https://github.com/frankkopp/DCSServerBot3/tree/master/services/restapi).
+
+## Configuration
+The webservice can be configured in its config/services/webservice.yaml file:
+```yaml
+DEFAULT:
+  listen: 0.0.0.0   # the interface to bind the internal webserver to
+  port: 9876        # the port the webservice is listening on
+  debug: false      # Enable /openapi.json, /docs and /redoc endpoints to test the API (default: false)
+```
+
+> [!NOTE]
+> To access the API documentation, you can enable debug and access the documentation with these links: 
+> http://localhost:9876/docs
+> http://localhost:9876/redoc
+> Please refer to the [OpenAPI specification](https://swagger.io/specification/) for more information.
+
+> [!WARNING]
+> Do NOT enable debug for normal operations, especially if you expose the port to the outside world.
+
+> [!IMPORTANT]
+> It is advisable to use a reverse proxy like nginx and maybe SSL encryption to secure the webservice. 
