From d3a04126302a777cdd1f4dc265014f01b3079d14 Mon Sep 17 00:00:00 2001
From: Piotr Siuszko <siuszko@zoho.com>
Date: Tue, 29 Oct 2024 12:09:34 +0100
Subject: [PATCH] Update server docs

---
 Docs/docs/guides/dedicated-servers.md | 45 ++++++++++++++++++---------
 1 file changed, 30 insertions(+), 15 deletions(-)

diff --git a/Docs/docs/guides/dedicated-servers.md b/Docs/docs/guides/dedicated-servers.md
index 8a922f6a..cd0f7a3c 100644
--- a/Docs/docs/guides/dedicated-servers.md
+++ b/Docs/docs/guides/dedicated-servers.md
@@ -11,28 +11,26 @@ img[src*='#center'] {
 
 Beamable SDK is made with support for a dedicated servers in mind from start. There is developed [Hathora Sample Project](../samples/hathora-demo.md) which contains working project with dedicated server support and Dockerfile for a Linux server container builds.
 
-## Differences from client code
+## Server specific flow
 
-### User Slots
+When running dedicated server it is expected to run a single lobby match. Lobby ID can be passed as a command line argument `BeamableDedicatedServerInstanceLobbyId=ID_HERE` or with environment variable `BEAMABLE_DEDICATED_SERVER_INSTANCE_LOBBY_ID`. If no value is provided, it will be assumed that the user will run multiple matches per server and will make the calls to RefreshLobbyDataOperation from their integration with their game server orchestrator.
 
-User Slots are a big part of the regular workflow when working with Beamable SDK. For server though they are not used. 
+Another thing worth noting is the fact that there is no `OnReady` call since no user account is used on server side. There is still option to perform requests to Beamable backend by using Signed Requests. Using them is handled automatically, but requires to provide the Realm Secret to the server via command line or environment variable. In the same way it is possible to setup server customer and realm config as described in table below:
 
-### Online Subsystems
+| Value      | Command line argument      | Environment variable |
+| ------------- | ------------- |-------------  |
+| Realm secret | `beamable-realm-secret` | `BEAMABLE_REALM_SECRET` |
+| Beamable Customer ID (CID) | `beamable-customer-override` | `BEAMABLE_CUSTOMER_OVERRIDE` |
+| Beamable Realm ID (PID) | `beamable-realm-override` | `BEAMABLE_REALM_OVERRIDE` |
+| Dedicated Server Lobby ID | `BeamableDedicatedServerInstanceLobbyId` | `BEAMABLE_DEDICATED_SERVER_INSTANCE_LOBBY_ID` |
 
-Beamable can be used with Unreal Online Subsystem. `*.Target.cs` project build configuration file should already contain `Beam.ConfigureGame` method call. Enabling Online subsystem would require updating the value of the second argument of that method, `Beam.OssConfig` value, example values for Hathora sample project:
+Realm Secret can be aquired easily from command line in the project directory by calling command `dotnet beam config secret`.
 
-```csharp
-var oss = new Beam.OssConfig()
-{
-    IsEnabled = true,
+## Differences from client code
 
-    HooksEnabled = true,
-    HookSubsystemImplementation = "FOnlineSubsystemHathoraDemo",
-    HookSubsystemIncludePath = "Customer/OnlineSubsystemHathoraDemo.h",
+### User Slots
 
-    AdditionalHookModules = new[] { "HathoraSDK" }
-};
-```
+User Slots are a big part of the regular workflow when working with Beamable SDK. For server though they are not used. For interfaces containing the `UserSlot` parameter, that parameter is not used.
 
 ### Microservices
 
@@ -47,3 +45,20 @@ public class ServerInfo
 ```
 
 [Hathora Sample Project](../samples/hathora-demo.md) contains example of the implementation.
+
+### Online Subsystems
+
+Beamable can be used with Unreal Online Subsystem. `*.Target.cs` project build configuration file should already contain `Beam.ConfigureGame` method call. Enabling Online subsystem would require updating the value of the second argument of that method, `Beam.OssConfig` value, example values for Hathora sample project:
+
+```csharp
+var oss = new Beam.OssConfig()
+{
+    IsEnabled = true,
+
+    HooksEnabled = true,
+    HookSubsystemImplementation = "FOnlineSubsystemHathoraDemo",
+    HookSubsystemIncludePath = "Customer/OnlineSubsystemHathoraDemo.h",
+
+    AdditionalHookModules = new[] { "HathoraSDK" }
+};
+```
\ No newline at end of file