Persistence Options + Comprehensive README

.gitignore

@@ -0,0 +1 @@
+reforger/

Dockerfile

@@ -75,6 +75,11 @@ ENV GAME_PROPS_VON_DISABLE_UI=false
 ENV GAME_PROPS_VON_DISABLE_DIRECT_SPEECH_UI=false
 ENV GAME_PROPS_VON_CAN_TRANSMIT_CROSS_FACTION=false
 
+# Persistence (disabled by default - set any to enable)
+ENV PERSISTENCE_AUTO_SAVE_INTERVAL=""
+ENV PERSISTENCE_HIVE_ID=""
+ENV PERSISTENCE_JSON_FILE_PATH=""
+
 ENV SKIP_INSTALL=false
 
 WORKDIR /reforger
@@ -91,5 +96,6 @@ STOPSIGNAL SIGINT
 
 COPY *.py /
 COPY docker_default.json /
+COPY persistence_default.json /
 
 CMD ["python3","/launch.py"]

README.md

@@ -26,17 +26,129 @@ Simply check-out / copy [the provided docker-compose.yml](docker-compose.yml) an
 
 ## Parameters
 
-Check [the Dockerfile](Dockerfile#L32-L67), more docs will come later.
-
 ### Configs
 
-By default the configs are generated from the ENV variables in the dockerfile. After the first run the file can be expanded with additional options manually, but the fields will always be overwritten by the ENV variables.
+By default the configs are generated from the ENV variables in the Dockerfile. After the first run the file can be expanded with additional options manually, but the fields will always be overwritten by the ENV variables.
 
 Alternatively, change the `ARMA_CONFIG` variable to a file present in the `Configs` volume. It will be used without modification.
 
-### Experimental server
+### Steam / Installation
+
+| Variable | Default | Description |
+|---|---|---|
+| `STEAM_USER` | *(empty)* | Steam username (anonymous login if empty) |
+| `STEAM_PASSWORD` | *(empty)* | Steam password |
+| `STEAM_APPID` | `1874900` | Steam app ID. Use `1890870` for the experimental server |
+| `STEAM_BRANCH` | `public` | Steam branch to install from |
+| `STEAM_BRANCH_PASSWORD` | *(empty)* | Password for the Steam branch |
+| `SKIP_INSTALL` | `false` | Skip the SteamCMD install/update step |
+
+### Server / Network
+
+| Variable | Default | Description |
+|---|---|---|
+| `ARMA_CONFIG` | `docker_generated` | Config file name (without `.json`). Set to use a custom config from the `Configs` volume without ENV overrides |
+| `ARMA_PROFILE` | `/home/profile` | Server profile directory |
+| `ARMA_BINARY` | `./ArmaReforgerServer` | Path to the server binary |
+| `ARMA_PARAMS` | *(empty)* | Additional command-line parameters (e.g. `-loadSessionSave` to resume a previous session) |
+| `ARMA_MAX_FPS` | `120` | Maximum server FPS |
+| `ARMA_WORKSHOP_DIR` | `/reforger/workshop` | Workshop / addons directory |
+| `SERVER_BIND_ADDRESS` | `0.0.0.0` | Address the server binds to |
+| `SERVER_BIND_PORT` | `2001` | Port the server binds to (UDP) |
+| `SERVER_PUBLIC_ADDRESS` | *(empty)* | Public IP address for server browser |
+| `SERVER_PUBLIC_PORT` | `2001` | Public port for server browser |
+| `SERVER_A2S_ADDRESS` | `0.0.0.0` | A2S query address. Set both address and port to enable; leave either empty to disable |
+| `SERVER_A2S_PORT` | `17777` | A2S query port (UDP) |
+
+**NOTE**: The full list of [Startup Parameters](https://community.bistudio.com/wiki/Arma_Reforger:Startup_Parameters#Hosting) for `ARMA_PARAMS` can be found on the Arma Reforger wiki.
+
+### RCON
 
-To use the experimental server instead of the regular set `STEAM_APPID` variable to `1890870`.
+RCON is activated by defining the `RCON_PASSWORD` variable.
+
+| Variable | Default | Description |
+|---|---|---|
+| `RCON_ADDRESS` | `0.0.0.0` | RCON bind address |
+| `RCON_PORT` | `19999` | RCON port (UDP) |
+| `RCON_PASSWORD` | *(empty)* | RCON password. Required for RCON to start. Must be at least 3 characters, no spaces |
+| `RCON_PERMISSION` | `admin` | [Permission](https://community.bistudio.com/wiki/Arma_Reforger:Server_Config#permission) level for all RCON clients |
+
+### Game
+
+| Variable | Default | Description |
+|---|---|---|
+| `GAME_NAME` | `Arma Reforger Docker Server` | Server name shown in the server browser |
+| `GAME_PASSWORD` | *(empty)* | Password required to join the server |
+| `GAME_PASSWORD_ADMIN` | *(auto-generated)* | Admin password. If not set, a random passphrase is generated and printed to the console |
+| `GAME_ADMINS` | *(empty)* | Comma-delimited list of admin identityIds and/or steamIds |
+| `GAME_SCENARIO_ID` | `{ECC61978EDCC2B5A}Missions/23_Campaign.conf` | Scenario to load |
+| `GAME_MAX_PLAYERS` | `32` | Maximum number of players |
+| `GAME_VISIBLE` | `true` | Whether the server is visible in the server browser |
+| `GAME_SUPPORTED_PLATFORMS` | `PLATFORM_PC,PLATFORM_XBL,PLATFORM_PSN` | Comma-separated list of supported platforms |
+| `GAME_MODS_IDS_LIST` | *(empty)* | Comma-separated mod IDs with optional version (e.g. `5965770215E93269=1.0.6,5965550F24A0C152`) |
+| `GAME_MODS_JSON_FILE_PATH` | *(empty)* | Path to a JSON file containing an array of mod objects (see [Mods](#mods)) |
+
+### Game Properties
+
+| Variable | Default | Description |
+|---|---|---|
+| `GAME_PROPS_BATTLEYE` | `true` | Enable BattlEye anti-cheat |
+| `GAME_PROPS_DISABLE_THIRD_PERSON` | `false` | Disable third-person camera |
+| `GAME_PROPS_FAST_VALIDATION` | `true` | Enable fast addon validation |
+| `GAME_PROPS_SERVER_MAX_VIEW_DISTANCE` | `2500` | Maximum view distance (meters) |
+| `GAME_PROPS_SERVER_MIN_GRASS_DISTANCE` | `50` | Minimum grass render distance (meters) |
+| `GAME_PROPS_NETWORK_VIEW_DISTANCE` | `1000` | Network view distance (meters) |
+| `GAME_PROPS_VON_DISABLE_UI` | `false` | Disable VON UI |
+| `GAME_PROPS_VON_DISABLE_DIRECT_SPEECH_UI` | `false` | Disable VON direct speech UI |
+| `GAME_PROPS_VON_CAN_TRANSMIT_CROSS_FACTION` | `false` | Allow cross-faction VON transmission |
+
+### Persistence
+
+Persistence is **disabled by default** — the system works automatically for most use cases. Set any `PERSISTENCE_*` variable to enable the persistence config section.
+
+**NOTE**: ``-loadSessionSave`` must be enabled in order to load session saves. 
+
+| Variable | Default | Description |
+|---|---|---|
+| `PERSISTENCE_AUTO_SAVE_INTERVAL` | *(empty)* | Minutes between auto-saves (0–60). 0 disables auto-save. Server default is 10 |
+| `PERSISTENCE_HIVE_ID` | *(empty)* | Hive identifier (0–16383). Used when multiple servers share a persistence database |
+| `PERSISTENCE_JSON_FILE_PATH` | *(empty)* | Path to a JSON file containing `databases` and/or `storages` objects (see below) |
+
+For advanced persistence setups (external databases, custom storages), create a JSON file with `databases` and/or `storages` objects and mount it into the container:
+
+```sh
+-v ${PWD}/persistence.json:/persistence.json
+-e PERSISTENCE_JSON_FILE_PATH="/persistence.json"
+-e PERSISTENCE_AUTO_SAVE_INTERVAL=15
+```
+
+Example `persistence.json`:
+
+```json
+{
+  "databases": {
+    "webapi": {
+      "preset": "{0123456789ABCDEF}Configs/Systems/Persistence/Database/JsonWebApi.conf",
+      "options": {
+        "url": "https://persistence-db.example.com:5539/api/v1",
+        "headers": {
+          "X-API-KEY": "your-api-key",
+          "Content-Type": "application/json"
+        }
+      }
+    }
+  },
+  "storages": {
+    "session": {
+      "database": "webapi"
+    }
+  }
+}
+```
+
+**Documentation**:
+- [Persistence](https://community.bistudio.com/wiki/Arma_Reforger:Persistence_System) 
+- [Persistence Server Configuration](https://community.bistudio.com/wiki/Arma_Reforger:Server_Config#persistence)
 
 ### Mods
 
@@ -56,7 +168,7 @@ Path to a JSON file that contains array of mod objects.
 
 ```sh
 -v ${PWD}/mods_file.json:/mods_file.json
--e GAME_MODS_JSON_FILE_PATH="/mods_file.json" 
+-e GAME_MODS_JSON_FILE_PATH="/mods_file.json"
 ```
 
 ```json
@@ -67,17 +179,8 @@ Path to a JSON file that contains array of mod objects.
   }
 ]
 ```
-### RCON
-
-RCON can be activated by defining the `RCON_PASSWORD` variable.
-
-```sh
--e RCON_PASSWORD="ExamplePassword123"
-```
 
-The password:
-* is required for RCON to start
-* does not support spaces
-* must be at least 3 characters long
+### Documentation
 
-Use `-e RCON_PERMISSION=""` to change [permission](https://community.bistudio.com/wiki/Arma_Reforger:Server_Config#permission) for all RCON clients.
+The full Server Configuration can be found [here](https://community.bistudio.com/wiki/Arma_Reforger:Server_Config).  
+The Dockerfile may not include every option that is currently available and may need updated and may require being updated for additional support of features.

launch.py

@@ -248,6 +248,29 @@ def bool_str(text):
                 config_mod_ids.append(provided_mod["modId"])
                 config["game"]["mods"].append(valid_mod)
 
+    # Persistence (only added when at least one persistence ENV is defined)
+    persistence_defined = (
+        env_defined("PERSISTENCE_AUTO_SAVE_INTERVAL")
+        or env_defined("PERSISTENCE_HIVE_ID")
+        or env_defined("PERSISTENCE_JSON_FILE_PATH")
+    )
+    if persistence_defined:
+        persistence = {}
+        if env_defined("PERSISTENCE_AUTO_SAVE_INTERVAL"):
+            persistence["autoSaveInterval"] = int(
+                os.environ["PERSISTENCE_AUTO_SAVE_INTERVAL"]
+            )
+        if env_defined("PERSISTENCE_HIVE_ID"):
+            persistence["hiveId"] = int(os.environ["PERSISTENCE_HIVE_ID"])
+        if env_defined("PERSISTENCE_JSON_FILE_PATH"):
+            with open(os.environ["PERSISTENCE_JSON_FILE_PATH"]) as f:
+                persistence_json = json.load(f)
+                allowed_keys = ["databases", "storages"]
+                for key in allowed_keys:
+                    if key in persistence_json:
+                        persistence[key] = persistence_json[key]
+        config["game"]["gameProperties"]["persistence"] = persistence
+
     f = open(CONFIG_GENERATED, "w")
     json.dump(config, f, indent=4)
     f.close()

persistence_default.json

@@ -0,0 +1,13 @@
+{
+  "databases": {
+    "default": {
+      "preset": "{2BBBE828EF1B5F39}Configs/Systems/Persistence/Database/JsonFile.conf",
+      "options": {}
+    }
+  },
+  "storages": {
+    "session": {
+      "database": "default"
+    }
+  }
+}