Install Docker Desktop (or Docker CLI)
* [Install Docker Desktop from the official source](https://www.docker.com/products/docker-desktop/) (no account required), * make sure to restart your computer after completing the installation.Install Edgegap Quickstart Docker Extension
* Install from Docker Desktop / Extensions / Browse or [using the link](https://open.docker.com/extensions/marketplace?extensionId=edgegap/docker-extension).
Gain Access to Unreal Engine resources on GitHub
* [Sign up for a GitHub account.](https://github.com/) * Navigate to your [Unreal Engine linked accounts dashboard page](https://www.epicgames.com/account/connections). * Link GitHub account with your Epic account. * Authorize Epic Games to access your GitHub account. * Accept email invitation to join Epic Games organization on GitHub.Generate GitHub Personal Access Token (classic)
* enable only permission `[read:packages]` , * generate token - **store this value safely, you won't see it again**.Generate GitHub Personal Access Token (classic)
* enable only permission `[read:packages]` , * generate token - **store this value safely, you won't see it again**.[ConsoleVariables]
net.IgnoreNetworkChecksumMismatch=1
net.CurrentHandshakeVersion=2
net.MinHandshakeVersion=2
net.VerifyNetSessionID=0
net.VerifyNetClientID=0
[/Script/Engine.GameEngine]
!NetDriverDefinitions=ClearArray
+NetDriverDefinitions=(DefName="GameNetDriver",DriverClassName="OnlineSubsystemUtils.IpNetDriver",DriverClassNameFallback="OnlineSubsystemUtils.IpNetDriver")
[/Script/OnlineSubsystemUtils.IpNetDriver]
MaxClientRate=1000000000
MaxInternetClientRate=1000000000
InitialConnectTimeout=120.0
MaxNetTickRate=60
NetServerMaxTickRate=60
[/Script/BuildSettings.BuildSettings]
DefaultServerTarget=LyraServer
bOverrideBuildEnvironment = true;
bUseLoggingInShipping = true;
bUseChecksInShipping = false;
bBuildWithEditorOnlyData = false;
bUsesSlate = false;
bCompileCEF3 = false;
Optional: Steam Integration
To **integrate Steam**, use `IpNetDriver` as your default Net Driver and verify that the [64 bit steamclient.so for Linux](https://developer.valvesoftware.com/wiki/SteamCMD#Ubuntu) is copied to image on path `/home/ubuntu/.steam/sdk64/` . {% hint style="success" %} Add `steamclient.so` linux library with a single click using our [docker extension](https://docs.edgegap.com/unreal-engine). {% endhint %} Download steamclient.so...
RUN mkdir -p /home/ubuntu/.steam/sdk64
COPY ./steamclient.so /home/ubuntu/.steam/sdk64/steamclient.so
RUN chmod 755 /home/ubuntu/.steam/sdk64/steamclient.so
...
[OnlineSubsystemSteam]
bUseSteamNetworking=false
bAllowP2PPacketRelay=false
SteamDevAppId=480
SteamAppId=480
Troubleshooting and FAQ
Canât connect clients to server - `Request timed out.` , `èŻ·æ±è¶ æ¶` , `ConnectionFailed` , or `Port verification failed` * First, make sure that the container is up, and there are no runtime errors in your logs. * Please verify that your port values in the `docker run` command match. * Please ensure that your game client is connecting to the **external port** shown on your container details page, this value will be always randomized due to security reasons. * Please ensure youâve renamed your target file and configured game builds as described in step [#id-1-configure-project](#id-1-configure-project "mention"). *** My container is up but Iâm not able to connect for several minutes afterwards. * Once a container is up, your game engine initialization begins. This process may take anywhere from seconds to minutes, and the server doesnât accept to player connections during this period. * Consider optimizing your server initialization to decrease this time period. * Game clients should retry connection in 1 second intervals for a limited amount of time (depending on your initialization duration), after which they should return to matchmaking. * Consider adding a loading scene so the server can perform initialization (and travel in case of Unreal Engine) at the same time as clients, while synchronizing state of both. *** `Warning: Could not create socket for bind address` * Please install Epicâs Steam Subsystem plugin through Fab asset store. * When using Edgegap Integration Kit (EGIK) with SteamCore source version downloaded from github, Epicâs Steam Subsystem plugin is not included due to Epic Games plugin distribution policies. *** I connected but my screen is completely dark. * Verify you have the correct **Game Default Map** set under **Edit / Project Settings / Maps & Modes**.Troubleshooting and FAQ
`denied: adding 756.6 MiB of storage resource, which when updated to current usage of 4.3 GiB will exceed the configured upper limit of 4.7 GiB` , `failed commit on ref "layer-sha256:--------": unexpected status from PUT request to https://registry.edgegap.com/` * Seems like youâve run out of image storage space on [Container Registry](https://app.edgegap.com/registry-management/repositories/list). Consider removing unused build artifacts (if you have any) or optimize server build size. If using a custom Dockerfile or .dockerignore, you might be copying some unneeded files into your image. *** `You have reached you Application limit of 2` , `Unable to update docker tag/version: You have reached you Application Version limit of 2` * Youâve reached the limits of our Free tier, please consider upgrading your account. Alternatively, you may remove your existing resources through our [Dashboard](https://app.edgegap.com/). *** My new application version is not listed in the plugin/extension. * Please ensure youâve completed app version create form in the last step.
Troubleshooting and FAQ
Canât connect clients to server - `Request timed out.` , `èŻ·æ±è¶ æ¶` , `ConnectionFailed` , or `Port verification failed` * First, make sure that the deployment is Ready, and there are no runtime exceptions or errors in your deployment log. If your deployment stopped, inspect logs in our [Dashboard](https://app.edgegap.com/deployment-management/deployments/list). * Please verify that your port setting in your server buildâs netcode settings matches the internal port in your [App version](https://app.edgegap.com/application-management/applications/list). For plugin builds, the port is set for you automatically. You can change the port mapping by editing the [App version](https://app.edgegap.com/application-management/applications/list) without rebuilding. Find your protocol in your netcode integration. * Please ensure that your game client is connecting to the **external port** shown on your Deployment details page, this value will be always randomized due to security reasons. * Please ensure youâve renamed your target file and configured game builds as described in step [#id-1.-configure-project](#id-1.-configure-project "mention"). * Are you located in China and are using [Smart Fleets](https://docs.edgegap.com/docs/deployment/session/fleet-manager/fleet)? Your connection may be blocked by the Great Firewall. Consider adding a server located in China to your fleet, or using a VPN to connect. *** My deployment is ready but Iâm not able to connect for several minutes afterwards. * Once a deployment is Ready, your game engine initialization begins. This process may take anywhere from seconds to minutes, and the server doesnât accept to player connections during this period. * Consider optimizing your server initialization to decrease this time period. * Game clients should retry connection in 1 second intervals for a limited amount of time (depending on your initialization duration), after which they should return to matchmaking. * Consider adding a loading scene so the server can perform initialization (and travel in case of Unreal Engine) at the same time as clients, while synchronizing state of both. *** `Warning: Could not create socket for bind address` * Please install Epicâs Steam Subsystem plugin through Fab asset store. * When using Edgegap Integration Kit (EGIK) with SteamCore Integration Kit (SIK) source version downloaded from github, Epicâs Steam Subsystem plugin is not included due to Epic Games plugin distribution policies. *** I connected but my screen is completely dark. * Verify you have the correct **Game Default Map** set under **Edit / Project Settings / Maps & Modes**. * Verify that the [Unreal Engine version compatibility check has been disabled](#id-2.-configure-game-server-builds) in `DefaultEngine.ini`. *** My deployment stopped/restarted and I canât access itâs logs anymore. * In case the server process crashes due to an exception, our system will attempt restarting the server automatically. Consider testing your server locally to uncover the root cause. * We only keep logs for the duration of the deployment, if you wish to inspect logs after deployment stops, please [integrate a third party log storage](https://docs.edgegap.com/docs/deployment/endpoint-storage). * See [#id-5.-deployment-stopped](https://docs.edgegap.com/learn/orchestration/deployments#id-5.-deployment-stopped "mention") to discover all causes for stopping your deployment. *** My deployment stopped automatically after X minutes. * Free Tier deployments have a 60 minute limit, please consider upgrading your account. * All deployments will be terminated after 24 hours of runtime following our server sanitization policy, for infrastructure maintenance, and to prevent racking up unexpected costs when deployment wasnât shut down properly. For long-running servers, consider using [private-fleets](https://docs.edgegap.com/learn/orchestration/private-fleets "mention") with [persistence](https://docs.edgegap.com/learn/orchestration/persistence "mention"). * See [#id-5.-deployment-stopped](https://docs.edgegap.com/learn/orchestration/deployments#id-5.-deployment-stopped "mention") to discover all causes for stopping your deployment. *** What will happen if a player leaves my deployment? * By default, servers donât reject player connections. Authenticating players is up to your devs, since many different methods and player authentication providers can be used. * Game clients may store connection information locally to attempt reconnecting in case of unexpected client crashes. * To allow players to join games in progress, consider using [#backfill](https://docs.edgegap.com/learn/matchmaking/matchmaker-in-depth#backfill "mention") or [Sessions](https://docs.edgegap.com/docs/deployment/session). *** My server shows 100% CPU utilization after becoming ready. * This may not be an issue, as game engines tend to perform CPU-heavy operations during server initializations. If the CPU usage doesnât drop after 2-3 minutes from deployment start, you may need to optimize your server or increase app version resources. * Reducing tick rate can help control CPU usage due to processing less messages. * Youâre limited to 1.5 vCPU and 3GB of memory (RAM) in Free Tier. * You may increase allocated resources when creating a new app version. You can duplicate your App version in our Dashboard and adjust these values as needed, without rebuilding your server or image. *** My deployment is restarting repeatedly and shows error `OOM kill` * This is caused by exceeding allocated memory amount. Consider optimizing memory usage with object pooling, compression, or removing unneeded objects in your scene. * Youâre limited to 1.5 vCPU and 3GB of memory (RAM) in Free Tier. * You may increase allocated resources when creating a new app version. You can duplicate your App version in our Dashboard and adjust these values as needed, without rebuilding your server or image. *** Sometimes, my serverâs memory (RAM) usage spikes to a high value, is that a problem? * As long as you stay within the allocated app version memory amount, this is not an issue. * Exceeding the allocated app version memory amount will cause `OOM kill` (see above). *** Will my server performance be impacted by other servers running on the same machine? * No, our platform ensures that allocated resources will not be used by other studios, or other servers on shared infrastructure. With Edgegap, there are no noisy neighbors.Example .dockerignore file to remove extra files.
```docker
# Compiled Object files
*.slo
*.lo
*.o
*.obj
# Precompiled Headers
*.gch
*.pch
# Compiled Dynamic libraries
*.so
*.dylib
*.dll
# Fortran module files
*.mod
# Compiled Static libraries
*.lai
*.la
*.a
*.lib
# Executables
*.exe
*.out
*.app
*.ipa
# These project files can be generated by the engine
*.xcodeproj
*.xcworkspace
*.sln
*.suo
*.opensdf
*.sdf
*.VC.db
*.VC.opendb
# Precompiled Assets
**/SourceArt/**/*.png
**/SourceArt/**/*.tga
# Builds
**/Build/*
# Whitelist PakBlacklist-Install Docker Desktop (or Docker CLI)
* [Install Docker Desktop from the official source](https://www.docker.com/products/docker-desktop/) (no account required), * make sure to restart your computer after completing the installation.Gain Access to Unreal Engine resources on GitHub
* [Sign up for a GitHub account.](https://github.com/) * Navigate to your [Unreal Engine linked accounts dashboard page](https://www.epicgames.com/account/connections). * Link GitHub account with your Epic account. * Authorize Epic Games to access your GitHub account. * Accept email invitation to join Epic Games organization on GitHub.Generate GitHub Personal Access Token (classic)
* enable only permission `[read:packages]` , * generate token - **store this value safely, you won't see it again**.[ConsoleVariables]
net.IgnoreNetworkChecksumMismatch=1
net.CurrentHandshakeVersion=2
net.MinHandshakeVersion=2
net.VerifyNetSessionID=0
net.VerifyNetClientID=0
[/Script/Engine.GameEngine]
!NetDriverDefinitions=ClearArray
+NetDriverDefinitions=(DefName="GameNetDriver",DriverClassName="OnlineSubsystemUtils.IpNetDriver",DriverClassNameFallback="OnlineSubsystemUtils.IpNetDriver")
[/Script/OnlineSubsystemUtils.IpNetDriver]
MaxClientRate=1000000000
MaxInternetClientRate=1000000000
InitialConnectTimeout=120.0
MaxNetTickRate=60
NetServerMaxTickRate=60
[/Script/BuildSettings.BuildSettings]
DefaultServerTarget=LyraServer
bOverrideBuildEnvironment = true;
bUseLoggingInShipping = true;
bUseChecksInShipping = false;
bBuildWithEditorOnlyData = false;
bUsesSlate = false;
bCompileCEF3 = false;
Optional: Steam Integration
To **integrate Steam**, use `IpNetDriver` as your default Net Driver and verify that the [64 bit steamclient.so for Linux](https://developer.valvesoftware.com/wiki/SteamCMD#Ubuntu) is copied to image on path `/home/ubuntu/.steam/sdk64/` . {% hint style="success" %} Add `steamclient.so` linux library with a single click using our [docker extension](https://docs.edgegap.com/unreal-engine). {% endhint %} Download steamclient.so...
RUN mkdir -p /home/ubuntu/.steam/sdk64
COPY ./steamclient.so /home/ubuntu/.steam/sdk64/steamclient.so
RUN chmod 755 /home/ubuntu/.steam/sdk64/steamclient.so
...
[OnlineSubsystemSteam]
bUseSteamNetworking=false
bAllowP2PPacketRelay=false
SteamDevAppId=480
SteamAppId=480
Troubleshooting and FAQ
`ERROR: failed to run Build function: the Dockerfile cannot be empty` * Some plugin sources may be missing `Dockerfile` and/or `StartServer.sh` , please find a copy these files from github source version of your plugin to your local plugin. *** `open //./pipe/dockerDesktopLinuxEngine: The system cannot find the file specified.` * Verify that Docker is running on your development machine. *** `invalid reference format EdgegapLog: Warning: OnContainerizeCallback: Could not generate container, message:Failed` * Verify that your application name is set and doesn't contain trailing whitespace. * Make sure to press Enter to confirm the input value when done editing. *** [**Couldnât find target rules file for target âProjectNameâ when building a project?**](https://forums.unrealengine.com/t/how-may-i-resolve-an-error-couldnt-find-target-rules-file-for-target-projectname-when-building-a-project/411707) * Change build configuration in your `XYZServerTarget.cs` file: ``` BuildConfig = EProjectPackagingBuildConfigurations::PPBC_Shipping; ``` *** `403 Forbidden, Could not push container, message:Failed` * Please verify your docker credentials are correctly set. * If using Edgegap Container Registry, ensure the username doesnât include `app-version-pull` , which is the profile only allowing pulling images. Your profile should resemble your account email instead. * Verify that you have enough free space in your accountâs [Container Registry](https://app.edgegap.com/registry-management/repositories/list). We recommend trying to [#optimize-server-build-size](#optimize-server-build-size "mention"), and using [our API to delete older images](https://docs.edgegap.com/api/#tag/Container-Registry/operation/image-tag-delete). Images are stored on your local machine until deleted for backups.Install Docker Desktop (or Docker CLI)
* [Install Docker Desktop from the official source](https://www.docker.com/products/docker-desktop/) (no account required), * make sure to restart your computer after completing the installation.Gain Access to Unreal Engine resources on GitHub
* [Sign up for a GitHub account.](https://github.com/) * Navigate to your [Unreal Engine linked accounts dashboard page](https://www.epicgames.com/account/connections). * Link GitHub account with your Epic account. * Authorize Epic Games to access your GitHub account. * Accept email invitation to join Epic Games organization on GitHub.Configure Your Development Environment
* [Download Unreal Engine source code](https://dev.epicgames.com/documentation/en-us/unreal-engine/downloading-unreal-engine-source-code#downloadingthesourcecode). * [Set up Visual Studio](https://dev.epicgames.com/documentation/en-us/unreal-engine/setting-up-visual-studio-development-environment-for-cplusplus-projects-in-unreal-engine).Install an Official Edgegap Unreal Engine Plugin
Choose one of the official plugins: * download [#integration-kit](https://docs.edgegap.com/developer-tools#integration-kit "mention"), * or download [#legacy-plugin](https://docs.edgegap.com/developer-tools#legacy-plugin "mention").[ConsoleVariables]
net.IgnoreNetworkChecksumMismatch=1
net.CurrentHandshakeVersion=2
net.MinHandshakeVersion=2
net.VerifyNetSessionID=0
net.VerifyNetClientID=0
[/Script/Engine.GameEngine]
!NetDriverDefinitions=ClearArray
+NetDriverDefinitions=(DefName="GameNetDriver",DriverClassName="OnlineSubsystemUtils.IpNetDriver",DriverClassNameFallback="OnlineSubsystemUtils.IpNetDriver")
[/Script/OnlineSubsystemUtils.IpNetDriver]
MaxClientRate=1000000000
MaxInternetClientRate=1000000000
InitialConnectTimeout=120.0
MaxNetTickRate=60
NetServerMaxTickRate=60
[/Script/BuildSettings.BuildSettings]
DefaultServerTarget=LyraServer
bOverrideBuildEnvironment = true;
bUseLoggingInShipping = true;
bUseChecksInShipping = false;
bBuildWithEditorOnlyData = false;
bUsesSlate = false;
bCompileCEF3 = false;
Optional: Steam Integration
To **integrate Steam**, use `IpNetDriver` as your default Net Driver and verify that the [64 bit steamclient.so for Linux](https://developer.valvesoftware.com/wiki/SteamCMD#Ubuntu) is copied to image on path `/home/ubuntu/.steam/sdk64/` . {% hint style="success" %} Add `steamclient.so` linux library with a single click using our [docker extension](https://docs.edgegap.com/unreal-engine). {% endhint %} Download steamclient.so...
RUN mkdir -p /home/ubuntu/.steam/sdk64
COPY ./steamclient.so /home/ubuntu/.steam/sdk64/steamclient.so
RUN chmod 755 /home/ubuntu/.steam/sdk64/steamclient.so
...
[OnlineSubsystemSteam]
bUseSteamNetworking=false
bAllowP2PPacketRelay=false
SteamDevAppId=480
SteamAppId=480
Troubleshooting and FAQ
`ERROR: failed to run Build function: the Dockerfile cannot be empty` * Some plugin sources may be missing `Dockerfile` and/or `StartServer.sh` , please find a copy these files from github source version of your plugin to your local plugin. *** `open //./pipe/dockerDesktopLinuxEngine: The system cannot find the file specified.` * Verify that Docker is running on your development machine. *** `invalid reference format EdgegapLog: Warning: OnContainerizeCallback: Could not generate container, message:Failed` * Verify that your application name is set and doesn't contain trailing whitespace. * Make sure to press Enter to confirm the input value when done editing. *** [**Couldnât find target rules file for target âProjectNameâ when building a project?**](https://forums.unrealengine.com/t/how-may-i-resolve-an-error-couldnt-find-target-rules-file-for-target-projectname-when-building-a-project/411707) * Change build configuration in your `XYZServerTarget.cs` file: ``` BuildConfig = EProjectPackagingBuildConfigurations::PPBC_Shipping; ``` *** `403 Forbidden, Could not push container, message:Failed` * Please verify your docker credentials are correctly set. * If using Edgegap Container Registry, ensure the username doesnât include `app-version-pull` , which is the profile only allowing pulling images. Your profile should resemble your account email instead. * Verify that you have enough free space in your accountâs [Container Registry](https://app.edgegap.com/registry-management/repositories/list). We recommend trying to [#optimize-server-build-size](#optimize-server-build-size "mention"), and using [our API to delete older images](https://docs.edgegap.com/api/#tag/Container-Registry/operation/image-tag-delete). Images are stored on your local machine until deleted for backups.Install Unity Linux Build Support Modules
* Use Unity Hub to select tab **Installs**, access **Settings** and **Add Modules** for each Unity version you intend to use with Edgegap platform:
Install Docker Desktop (or Docker CLI)
* [Install Docker Desktop from the official source](https://www.docker.com/products/docker-desktop/) (no account required), * make sure to restart your computer after completing the installation.Install Edgegap's Unity Dedicated Servers Quickstart Plugin
Please refer to [the official plugin repository](https://github.com/edgegap/edgegap-unity-plugin) for detailed instructions on installation. {% embed url="Troubleshooting and FAQ
`!Success: 400 BAD REQUEST - POST | https://api.edgegap.com/v1/wizard/init-quick-start - {"message": "The browser (or proxy) sent a request that this server could not understand."}` * If youâve installed by copying the ZIP file or used a sample project with a copy of the plugin installed this way, you will need to manually install package dependencies including the Newtonsoft JSON library, see [the official plugin repository](https://github.com/edgegap/edgegap-unity-plugin/tree/main?tab=readme-ov-file#instructions-1). * Please contact us on [Community Discord](https://discord.gg/NgCnkHbsGp) for help if this is not the case.Install Unity Linux Build Support Modules
* Use Unity Hub to select tab **Installs**, access **Settings** and **Add Modules** for each Unity version you intend to use with Edgegap platform:
Troubleshooting and FAQ
Unity: The only standalone targets supported are Windows x64 and OSX with OpenXR. * Open your Packages and disable OpenXR before building your server. * The OpenXR plugin is only required for clients and is not compatible with Linux server builds. By excluding it from your server builds you are not losing any functionality.Install Docker Desktop (or Docker CLI)
* [Install Docker Desktop from the official source](https://www.docker.com/products/docker-desktop/) (no account required), * make sure to restart your computer after completing the installation.Troubleshooting and FAQ
`/bin/bash: docker: command not found` , or `could not find Packages\com.edgegap.unity-servers-plugin\Editor` * First, ensure youâve completed [#usage-requirements](https://docs.edgegap.com/developer-tools#usage-requirements "mention"). * Confirm you have verified your Edgegap account, you shouldâve received a verification link by email. * Some settings may have reset after updating your Docker Desktop. Try navigating to your Docker Desktop Settings / Advanced and for âChoose how to configure the installation of Dockerâs CLI tools:â select âSystem (requires password)â. *** `docker build requires exactly 1 argument` * Please verify that your image tag doesnât contain any whitespace characters (spaces, tabs). Re-typing your image tag value will ensure you didnât accidentally copy such characters. *** `(HTTP code 400) unexpected - invalid tag format` * This is a [known issue with macOS Docker version 4.33](https://github.com/docker/for-win/issues/14258), please consider rolling back to 4.32 or upgrading to 4.35. *** `ERROR: failed to solve: ubuntu:22.04: failed to resolve source metadata for http://docker.io/library/ubuntu:22.04: failed to authorize: failed to fetch oauth token` * Are you located in China? Your connection may be interrupted by the Great Firewall. Try running `docker pull ubuntu:22.04` in your command line manually (open command line by pressing Win+R, then type `cmd` and Enter). *** `System.IndexOutOfRangeException: Index was outside the bounds of the array.` * If you installed our Unity quickstart plugin by downloading ZIP, your Unity Editor cache might be broken. Try deleting your plugin copy and installing using the git URL or from Unity Asset Store. You should no longer need Newtonsoft.JSON package as itâs automatically included with the other sources. *** My docker image size is massive (over 1GB) / tiny (below 100mb), is this okay? * This could be okay in some cases, as long as you can run the server and connect successfully (see [#id-4.-test-your-server-locally](#id-4.-test-your-server-locally "mention")). If this is not the case, consider reviewing your build options, resetting them to defaults, and gradually adding options to see how they impact your build size. See also [#optimize-server-build-size](#optimize-server-build-size "mention"). *** Iâm experiencing another issue not mentioned anywhere in this documentation. * First, please try [updating your Edgegap plugin](https://github.com/edgegap/edgegap-unity-plugin?tab=readme-ov-file#update-the-plugin-in-unity) as we may have shipped a fix. If this doesnât help, please contact us on our [Community Discord](https://discord.gg/NgCnkHbsGp) and weâll promptly investigate with you.Troubleshooting and FAQ
Iâm unable to connect to the local docker container using my Unity Editor game client. * First, make sure that the container status is Up and is not Restarting or Exited, which would indicate a runtime exception. If your container is not running, inspect itâs logs via Docker Desktop tab Containers (click on your container) or using `docker logs {container_id} --timestamps` via docker CLI. * Next, please verify that your Network Manager port setting from your server build matches the published port in **Optional docker run parameters**. If it doesnât, try resetting or manually changing the value for this input field to match `{container}` port to your Network Manager setting. Find your protocol in your netcode settings. * Lastly, confirm that your Unity Editor game client netcode settings are using the port published in **Optional docker run parameters** (see screenshot above). *** `(Segmentation fault) - core dumped` * If youâre using a machine with ARM architecture (macOS M1, M2, M3, etc..) you should see this optional parameter included in your Optional docker build parameters: `--platform=linux/amd64` . If you donât, try resetting the value for this input field. *** `SceneId of 9120233082191360994 not found in SceneObjects.` * This could mean that the scene youâre trying to load was not correctly included in the build, a known issue in older plugin versions. To remedy this, please try updating your netcode integration version or [updating your Edgegap plugin](https://github.com/edgegap/edgegap-unity-plugin?tab=readme-ov-file#update-the-plugin-in-unity). *** `http2: server: error reading preface from client //./pipe/docker_engine: file has already been closed` * This is a [known issue with older versions of Docker Desktop for Windows](https://github.com/docker/for-win/issues/13611). Please update your Docker Desktop application and try containerizing again. *** `Curl error 35: Cert handshake failed. Fatal error. UnityTls error code: 7` * This error indicates a root SSL certificate validation issue, a known issue in older plugin versions. To remedy this, please try [updating your Edgegap plugin](https://github.com/edgegap/edgegap-unity-plugin?tab=readme-ov-file#update-the-plugin-in-unity).Troubleshooting and FAQ
`denied: adding 756.6 MiB of storage resource, which when updated to current usage of 4.3 GiB will exceed the configured upper limit of 4.7 GiB` , `failed commit on ref "layer-sha256:--------": unexpected status from PUT request to https://registry.edgegap.com/` * Seems like youâve run out of image storage space on [Container Registry](https://app.edgegap.com/registry-management/repositories/list). Consider removing unused build artifacts (if you have any) or optimize server build size. If using a custom Dockerfile or .dockerignore, you might be copying some unneeded files into your image. *** `You have reached you Application limit of 2` , `Unable to update docker tag/version: You have reached you Application Version limit of 2` * Youâve reached the limits of our Free tier, please consider upgrading your account. Alternatively, you may remove your existing resources through our [Dashboard](https://app.edgegap.com/). *** My new application version is not listed in the plugin/extension. * Please ensure youâve completed app version create form in the last step.Troubleshooting and FAQ
Canât connect clients to server - `Request timed out.` , `èŻ·æ±è¶ æ¶` , `ConnectionFailed` , or `Port verification failed` * First, make sure that the deployment is Ready, and there are no runtime exceptions or errors in your deployment log. If your deployment stopped, inspect logs in our [Dashboard](https://app.edgegap.com/deployment-management/deployments/list). * If youâre using Mirror netcode you need to have ["Auto Start Serverâ](https://mirror-networking.gitbook.io/docs/hosting/edgegap-hosting-plugin-guide#build-and-push) selected in your `NetworkManager` , rebuild, push, and redeploy your server. * If youâre using FishNet netcode you need to enable [âStart on Headlessâ](https://fish-networking.gitbook.io/docs/manual/components/managers/server-manager#settings-are-general-settings-related-to-the-servermanager) in your `ServerManager`, rebuild, push, and redeploy your server. * If youâre using Photon Fusion 2 netcode, please ensure that your server is passing the deployment public IP, external port and the `roomCode` on the server, and the same room code in the client in the [âNeworkRunner.StartGameâ](https://doc.photonengine.com/fusion/current/manual/network-runner#creating-or-joining-a-room) parameter `StartGameArgs`. Deployment ID (e.g. `b63e6003b19f`) is a great choice as itâs globally unique and easily accessible to client by [Matchmaker](https://docs.edgegap.com/learn/matchmaking/matchmaker-in-depth) and [#injected-environment-variables](https://docs.edgegap.com/learn/matchmaking/matchmaker-in-depth#injected-environment-variables "mention"). * Next, please verify that your port setting in your server buildâs netcode settings matches the internal port in your [App version](https://app.edgegap.com/application-management/applications/list). You can change the port mapping by editing the [App version](https://app.edgegap.com/application-management/applications/list) without rebuilding. Find your protocol in your netcode integration. * Please ensure that your game client is connecting to the **external port** shown on your Deployment details page, this value will be always randomized due to security reasons. * If youâre using Secure Websocket (WSS) protocol in your netcode integration, please ensure that your [App version](https://app.edgegap.com/application-management/applications/list) port configuration for the WSS port has TLS Upgrade enabled. * Are you located in China and are using [Smart Fleets](https://docs.edgegap.com/docs/deployment/session/fleet-manager/fleet)? Your connection may be blocked by the Great Firewall. Consider adding a server located in China to your fleet, or using a VPN to connect. *** My deployment stopped/restarted and I canât access itâs logs anymore. * In case the server process crashes due to an exception, our system will attempt restarting the server automatically. Consider [testing your server locally](#id-4.-test-your-server-locally) to uncover the root cause. * We only keep logs for the duration of the deployment, if you wish to inspect logs after deployment stops, please [integrate a third party log storage](https://docs.edgegap.com/docs/deployment/endpoint-storage). * See [#id-5.-deployment-stopped](https://docs.edgegap.com/learn/orchestration/deployments#id-5.-deployment-stopped "mention") to discover all causes for stopping your deployment. *** My deployment stopped automatically after X minutes. * Free Tier deployments have 60 minute limit, please consider upgrading your account. * All deployments will be terminated after 24 hours of runtime following our server sanitization policy, for infrastructure maintenance, and to prevent racking up unexpected costs when deployment wasnât shut down properly. For long-running servers, consider using [private-fleets](https://docs.edgegap.com/learn/orchestration/private-fleets "mention") with [persistence](https://docs.edgegap.com/learn/orchestration/persistence "mention"). * See [#id-5.-deployment-stopped](https://docs.edgegap.com/learn/orchestration/deployments#id-5.-deployment-stopped "mention") to discover all causes for stopping your deployment. *** My deployment is ready but Iâm not able to connect for several minutes afterwards. * Once a deployment is Ready, your game engine initialization begins. This process may take anywhere from seconds to minutes, and the server doesnât accept to player connections during this period. * Consider optimizing your server initialization to decrease this time period. * Game clients should retry connection in 1 second intervals for a limited amount of time (depending on your initialization duration), after which they should return to matchmaking. * Consider adding a loading scene so the server can perform initialization (and travel in case of Unreal Engine) at the same time as clients, while synchronizing state of both. *** My Meta Quest device throws `HTTP 0: Cannot resolve destination host` . * When building Unity apps for Android target, your Internet Access permission may be removed from the output APK client build artifact automatically. * Re-add the permissions in (requires rebuilding client afterwards): * Project Settings / OpenXR / :gear: Meta Quest Support / Force Remove Internet Permissions (uncheck). * Player Settings / Internet Access (set to require). *** What will happen if a player leaves my deployment? * By default, servers donât reject player connections. Authenticating players is up to your devs, since many different methods and player authentication providers can be used. * Game clients may store connection information locally to attempt reconnecting in case of unexpected client crashes. * To allow players to join games in progress, consider using [#backfill](https://docs.edgegap.com/learn/matchmaking/matchmaker-in-depth#backfill "mention") or [Sessions](https://docs.edgegap.com/docs/deployment/session). *** My server shows 100% CPU utilization after becoming ready. * This may not be an issue, as game engines tend to perform CPU-heavy operations during server initializations. If the CPU usage doesnât drop after 2-3 minutes from deployment start, you may need to optimize your server or increase app version resources. * Reducing tick rate can impact CPU usage as the server performs less messaging operations. * If youâre using Mirror netcode you need to have ["Auto Start Serverâ](https://mirror-networking.gitbook.io/docs/hosting/edgegap-hosting-plugin-guide#build-and-push) selected in your `NetworkManager` , rebuild, push, and redeploy your server. * If youâre using FishNet netcode you need to enable [âStart on Headlessâ](https://fish-networking.gitbook.io/docs/manual/components/managers/server-manager#settings-are-general-settings-related-to-the-servermanager) in your `ServerManager`, rebuild, push, and redeploy your server. * Youâre limited to 1.5 vCPU and 3GB of memory (RAM) in Free Tier. * You may increase allocated resources when creating a new app version. You can duplicate your App version in our Dashboard and adjust these values as needed, without rebuilding your server or image. *** My deployment is restarting repeatedly and shows error `OOM kill` * This is caused by exceeding allocated memory amount. Consider optimizing memory usage with object pooling, compression, or removing unneeded objects in your scene. * Ensure your project is loading the default scene containing your `NetworkManager` and the scene is included in Unityâs Build Settings. * Youâre limited to 1.5 vCPU and 3GB of memory (RAM) in Free Tier. * You may increase allocated resources when creating a new app version. You can duplicate your App version in our Dashboard and adjust these values as needed, without rebuilding your server or image. *** Sometimes, my serverâs memory (RAM) usage spikes to a high value, is that a problem? * As long as you stay within the allocated app version memory amount, this is not an issue. * Exceeding the allocated app version memory amount will cause `OOM kill` (see above). *** Will my server performance be impacted by other servers running on the same machine? * No, our platform ensures that allocated resources will not be used by other studios, or other servers on shared infrastructure. With Edgegap, there are no noisy neighbors.Unity C# self-stop API code snippet example
```csharp using System; using System.Collections; using UnityEngine; using UnityEngine.Networking; public class EdgegapSelfStop : MonoBehaviour { private const int MaxRetries = 2; private const int TimeoutSeconds = 30; private string url = Environment.GetEnvironmentVariable("ARBITRIUM_DELETE_URL"); private string token = Environment.GetEnvironmentVariable("ARBITRIUM_DELETE_TOKEN"); public void Run() { StartCoroutine(SendDeleteWithRetry()); } private IEnumerator SendDeleteWithRetry() { if (string.IsNullOrEmpty(url)) { Debug.LogError("Edgegap | ARBITRIUM_DELETE_URL is not set."); yield break; } if (string.IsNullOrEmpty(token)) { Debug.LogError("Edgegap | ARBITRIUM_DELETE_TOKEN is not set."); yield break; } int attempt = 0; while (attempt <= MaxRetries) { attempt++; using (UnityWebRequest request = UnityWebRequest.Delete(url)) { request.timeout = TimeoutSeconds; request.SetRequestHeader("Authorization", token); yield return request.SendWebRequest(); if (request.result == UnityWebRequest.Result.Success) { Debug.Log("Edgegap | DELETE request succeeded."); yield break; } Debug.LogWarning( $"Edgegap | DELETE attempt {attempt} failed.\n" + $"Result: {request.result}, Error: {request.error}" ); if (attempt == MaxRetries) { Debug.LogError("Edgegap | DELETE request failed after all retries."); yield break; } } } } } ```Install Unity Linux Build Support Modules
* Use Unity Hub to select tab **Installs**, access **Settings** and **Add Modules** for each Unity version you intend to use with Edgegap platform:Install Docker Desktop (or Docker CLI)
* [Install Docker Desktop from the official source](https://www.docker.com/products/docker-desktop/) (no account required), * make sure to restart your computer after completing the installation.Troubleshooting and FAQ
Unity error: `[Package Manager Window] Error adding package: https://github.com/edgegap/edgegap-unity-plugin.git` * To add our plugin via git URL, you will need git client installed ([#installation](#installation "mention")). *** Unity Error: `Missing Linux Build Support` * See [#usage-requirements](#usage-requirements "mention"), youâre most likely missing Linux Build Support modules, which you can install through Unity hub. Make sure to choose the same Unity version as your projectâs.Troubleshooting and FAQ
Unity: `[Package Manager Window] Error adding package: https://github.com/edgegap/edgegap-unity-gen2-sdk.git` * To add our plugin via git URL, you will need git client installed ([#installation-1](#installation-1 "mention")). *** Unity: `failed to resolve assembly: 'Edgegap.Gen2.SDK...` * This is a known issue caused by [Unity's Burst compiler](https://docs.unity3d.com/6000.0/Documentation/Manual/com.unity.burst.html). * Install plugin [via ZIP archive](https://github.com/edgegap/edgegap-unity-gen2-sdk/edit/main/README.md#install-via-zip-archive) and delete .asmdef in the plugin folder to resolve this. *** Visual Studio: `type or namespace name could not be found` for Edgegap namespace. 1. In Unity Editor, navigate to **Edit / Preferences / External Tools / Generate .csproj files**. 2. Make sure you have enabled **Git packages**. 3. Click **Regenerate project files**.Troubleshooting and FAQ
I received error `401 Unauthorized` when pushing my server image. * This means you havenât signed in to your container registry. See Container Registry for [Edgegap Container Registry instructions](https://docs.edgegap.com/docs/container/edgegap-container-registry#getting-your-credentials), or the equivalent for your registry provider. Repeating your last operation will not resolve the error. *** I received error `403 Forbidden` when pushing my server image. * This means that either your currently signed in registry user doesnât have sufficient permissions (typically to push a new image), or that you are signed into the incorrect registry provider. Try signing out and signing in with the correct provider and user with sufficient permissions. Repeating your last operation will not resolve the error. *** What is the difference between a registry, repository, and a project? * Think of registry as a storage facility, repository as a storage unit, and project as a storage unit number. Each registry typically includes many repositories, some public, some private to organizations and users. * Example registry: `registry.edgegap.com` . * Example repository: `registry.edgegap.com/my-edgegap-org/my-game-server`. * Example project name: `my-game-server` . *** When pushing new image tags / builds my changes are not reloading correctly. * Make sure that every time you rebuild, you push with a new image tag. Edgegapâs internal caching system uses tag names and in case you overwrite a tag value (e.g. `latest`) it will not pick up on the new build. *** Can I tag the same build artifact multiple times? * Yes, you can tag the same artifact multiple times without issues, serving as multiple aliases to the same build. Keep reading to learn how to remove the tags later. *** What happens when I delete a tag? Why canât I delete a specific artifact using a hash? * Deleting a tag will also cause the associated build artifact to be deleted, if there are no other tags associated with the artifact at the time of [the API request](https://docs.edgegap.com/api/#tag/Container-Registry/operation/image-tag-delete). * Due to docker API standards and to ensure best possible user experience, we only provide an interface for deleting tags. See point above regarding deleting build artifacts.
ARBITRIUM_DEPLOYMENT_LOCATION:
- Detailed information about deployment location.
```json
ARBITRIUM_DEPLOYMENT_LOCATION="{
"city": "Montreal",
"country": "Canada",
"continent": "North America",
"administrative_division": "Quebec",
"timezone": "Eastern Time",
"latitude": 45.513707,
"longitude": -73.619073
}"
```
ARBITRIUM_PORTS_MAPPING:
- Detailed information about your internal and external ports.
```json
ARBITRIUM_PORTS_MAPPING="{
"ports": {
"gameport": {
"name": "Game Port",
"internal": 7777,
"external": 31504,
"protocol": "UDP"
},
"webport": {
"name": "Web Port",
"internal": 8888,
"external": 31553,
"protocol": "TCP"
}
}
}"
```
| Deployment Attribute | Operators | Example Value |
|---|---|---|
status | eq or neq | "ready" or "error" |
request_id | eq | "7e709a0d8efd" |
in or nin | [ "7e709a0d8efd", "4ba353100b4b" ] | |
tags | eq or neq | "tagA" |
in or nin | [ "tagA", "tagB" ] | |
created_at | eq or lte or gte | 2025-05-12T20:03:20Z |
application | eq or neq | "my-app" |
in or nin | [ "my-app", "my-other-app" ] | |
version | eq or neq | "1.0.0" |
in or nin | [ "1.0.0", "prod" ] | |
is_joinable_by_session | eq | true or false |
available_session_sockets | 5 |
List Deployments in Error to troubleshoot and remove.
Encoded URL: ``` https://api.edgegap.com/v1/deployments?query={"filters":[{"field":"status","operator":"eq","value":"error"},{"field":"application","operator":"eq","value":"my-app"},{"field":"version","operator":"eq","value":"green"}],"order_by":[{"field":"created_at","order":"desc"}]} ``` Formatted JSON query: ```json { "filters": [ { "field": "status", "operator": "eq", "value": "error" }, { "field": "application", "operator": "eq", "value": "my-app" }, { "field": "version", "operator": "eq", "value": "green" } ], "order_by": [ { "field": "created_at", "order": "desc" } ] } ```List Deployments with outdated App version to confirm a release is complete.
Encoded URL: ``` https://api.edgegap.com/v1/deployments?query={"filters":[{"field":"status","operator":"eq","value":"ready"},{"field":"application","operator":"eq","value":"my-app"},{"field":"version","operator":"eq","value":"blue"}],"order_by":[{"field":"created_at","order":"desc"}]} ``` Formatted JSON query: ```json { "filters": [ { "field": "status", "operator": "eq", "value": "ready" }, { "field": "application", "operator": "eq", "value": "my-app" }, { "field": "version", "operator": "eq", "value": "blue" } ], "order_by": [ { "field": "created_at", "order": "desc" } ] } ```Example Webhook Payload
```json { "request_id": "f68e011bfb01", "application": "my-game-server", "version": "2024.01.30-16.23.00-UTC", "fqdn": "f68e011bfb01.pr.edgegap.net", "public_ip": "162.254.141.66", "deployed_at": "2026-02-10T20:35:48Z", "termination_scheduled_at": "2026-02-10T21:35:48Z", "ports": { "gameport": { "external": 31504, "internal": 7777, "protocol": "UDP", "name": "gameport", "tls_upgrade": false, "link": "f68e011bfb01.pr.edgegap.net:31504", "proxy": null } }, "location": { "city": "Montreal", "country": "Canada", "continent": "North America", "administrative_division": "Quebec", "timezone": "Eastern Time", "latitude": 45.513707, "longitude": -73.619073 }, "tags": [ "tag1", "tag2" ], "host_id": "alpha-north-america-70364ef8", "host_in_private_fleet": false, "private_fleet_id": "PUBLIC_CLOUD", "vcpu_units": 256, "memory_mib": 512 } ```Canât connect clients to server - Request timed out., èŻ·æ±è¶
æ¶ , ConnectionFailed , or Port verification failed.
* First, make sure that the deployment is Ready, and there are no runtime exceptions or errors in your deployment log. If your deployment stopped, inspect logs in our [Dashboard](https://app.edgegap.com/deployment-management/deployments/list).
* If youâre using Mirror netcode you need to have ["Auto Start Serverâ](https://mirror-networking.gitbook.io/docs/hosting/edgegap-hosting-plugin-guide#build-and-push) selected in your `NetworkManager` , rebuild, push, and redeploy your server.
* If youâre using FishNet netcode you need to enable [âStart on Headlessâ](https://fish-networking.gitbook.io/docs/manual/components/managers/server-manager#settings-are-general-settings-related-to-the-servermanager) in your `ServerManager`, rebuild, push, and redeploy your server.
* If youâre using Photon Fusion 2 netcode, please ensure that your server is passing the deployment public IP, external port and the `roomCode` on the server, and the same room code in the client in the [âNeworkRunner.StartGameâ](https://doc.photonengine.com/fusion/current/manual/network-runner#creating-or-joining-a-room) parameter `StartGameArgs`. Deployment ID (e.g. `b63e6003b19f`) is a great choice as itâs globally unique and easily accessible to client by [Matchmaker](https://docs.edgegap.com/learn/matchmaking/matchmaker-in-depth) assignment and to the [#injected-environment-variables](https://docs.edgegap.com/matchmaking/matchmaker-in-depth#injected-environment-variables "mention").
* Next, please verify that your port setting in your server buildâs netcode settings matches the internal port in your [App version](https://app.edgegap.com/application-management/applications/list). You can change the port mapping by editing the [App version](https://app.edgegap.com/application-management/applications/list) without rebuilding. Find your protocol in your netcode integration.
* Please ensure that your game client is connecting to the **external port** shown on your Deployment details page, this value will be always randomized due to security reasons.
* If youâre using Secure Websocket (WSS) protocol in your netcode integration, please ensure that your [App version](https://app.edgegap.com/application-management/applications/list) port configuration for the WSS port has TLS Upgrade enabled.
* Are you located in China and are using [Smart Fleets](https://docs.edgegap.com/docs/deployment/session/fleet-manager/fleet)? Your connection may be blocked by the Great Firewall. Consider adding a server located in China to your fleet, or using a VPN to connect.
My deployment stopped/restarted and I canât access itâs logs anymore.
* In case the server process crashes due to an exception, our system will attempt restarting the server automatically. Consider testing your server locally to uncover the root cause. * We only keep logs for the duration of the deployment, if you wish to inspect logs after deployment stops, please [integrate a third party log storage](https://docs.edgegap.com/docs/deployment/endpoint-storage). * See [#id-5.-deployment-stopped](#id-5.-deployment-stopped "mention") to discover all causes for stopping your deployment.My deployment stopped automatically after X minutes.
* Free Tier deployments have a 60 minute time limit, please consider upgrading your account. * All deployments will be terminated after 24 hours of runtime following our server sanitization policy, for infrastructure maintenance, and to prevent racking up unexpected costs when deployment wasnât shut down properly. For long-running servers, consider using [private-fleets](https://docs.edgegap.com/learn/orchestration/private-fleets "mention") with [persistence](https://docs.edgegap.com/learn/orchestration/persistence "mention"). * See [#id-5.-deployment-stopped](#id-5.-deployment-stopped "mention") to discover all causes for stopping your deployment.My deployment is ready but Iâm not able to connect for several minutes afterwards.
* Once a deployment is Ready, your game engine initialization begins. This process may take anywhere from seconds to minutes, and the server doesnât accept to player connections during this period. * Consider optimizing your server initialization to decrease this time period. * Game clients should retry connection in 1 second intervals for a limited amount of time (depending on your initialization duration), after which they return to matchmaking. * Consider adding a loading scene so the server can perform initialization (and travel in case of Unreal Engine) at the same time as clients, while synchronizing state of both.My Meta Quest device throws HTTP 0: Cannot resolve destination host .
* When building Unity apps for Android target, your Internet Access permission may be removed from the output APK client build artifact automatically.
* Re-add the permissions in (requires rebuilding client afterwards):
* Project Settings / OpenXR / :gear: Meta Quest Support / Force Remove Internet Permissions (uncheck).
* Player Settings / Internet Access (set to require).
What will happen if a player leaves my deployment?
* By default, servers donât reject player connections. Authenticating players is up to your devs, since many different methods and player authentication providers can be used. * Game clients may store connection information locally to attempt reconnecting in case of unexpected client crashes. * To allow players to join games in progress, consider using [#backfill](https://docs.edgegap.com/matchmaking/matchmaker-in-depth#backfill "mention") or [Sessions](https://docs.edgegap.com/docs/deployment/session).My server shows 100% CPU utilization after becoming ready.
* This may not be an issue, as game engines tend to perform CPU-heavy operations during server initializations. If the CPU usage doesnât drop after 2-3 minutes from deployment start, you may need to optimize your server or increase app version resources. * Reducing tick rate can impact CPU usage as the server performs less messaging operations. * If youâre using Mirror netcode you need to have ["Auto Start Serverâ](https://mirror-networking.gitbook.io/docs/hosting/edgegap-hosting-plugin-guide#build-and-push) selected in your `NetworkManager` , rebuild, push, and redeploy your server. * If youâre using FishNet netcode you need to enable [âStart on Headlessâ](https://fish-networking.gitbook.io/docs/manual/components/managers/server-manager#settings-are-general-settings-related-to-the-servermanager) in your `ServerManager`, rebuild, push, and redeploy your server. * Youâre limited to 1.5 vCPU and 3GB of memory (RAM) in Free Tier. * You may increase allocated resources when creating a new app version. You can duplicate your App version in our Dashboard and adjust these values as needed, without rebuilding your server or image.My deployment is restarting repeatedly and shows error `OOM kill` .
* This behavior is caused by exceeding allocated memory amount. Consider optimizing memory usage with object pooling, compression, or removing unneeded objects in your scene. * Ensure your project is loading the default scene containing your `NetworkManager` and the scene is included in Unityâs Build Settings. * Youâre limited to 1.5 vCPU and 3GB of memory (RAM) in Free Tier. * You may increase allocated resources when creating a new app version. You can duplicate your App version in our Dashboard and adjust these values as needed, without rebuilding your server or image.Sometimes, my serverâs memory (RAM) usage spikes to a high value, is that a problem?
* As long as you stay within the allocated app version memory amount, this is not an issue. * Exceeding the allocated app version memory amount will cause \`OOM kill\` (see above).Will my server performance be impacted by other servers running on the same machine?
* No, our platform ensures that allocated resources will not be used by other studios, or other servers on shared infrastructure. With Edgegap, there are no noisy neighbors.
Auto-scaling Reference Architecture
match-based games,
or with predictable traffic
CPU-intensive games (AI),
or above 1:2 CPU/RAM ratio
16 vCPU
2.0 - 3.7 GHz frequency
16 vCPU
3.7 - 5.1 GHz frequency
Price, pre-paid monthly
(commitment based)
| **$250.00 per Host** | **$290.00 per Host** | {% hint style="success" %} [**Preview a pricing estimate during configuration of your fleet in dashboard**](https://app.edgegap.com/private-fleet-management/private-fleets/list)**.** {% endhint %} **Your first month reservation price and free egress quota are pro-rated.** This means you are charged only for the portion of time until the end of current month. **Reservations automatically renew on the first day of every month at 00:00 UTC until deleted.** Your card will be automatically charged the monthly amount for renewed hosts at this time. {% hint style="success" %} A fleet with [active hosts](#lifecycle) may not swap specifications. Create a new fleet or delete active hosts first. {% endhint %} {% hint style="info" %} Small amount of resources on each host is reserved for Operating System, Monitoring, and Orchestration. {% endhint %} #### Modifying Schedule and Deleting Hosts You may modify or delete this schedule at any time prior to the scheduled time, at no charge. You may designate any number of reserved (active) private hosts for deletion at the end of the current billing period, prior to the renewal date. Deleted hosts will not be charged for subsequent renewals. Any deployments running on private hosts scheduled for deletion will be gracefully shut down at the time of deletion without additional warnings. #### Delayed Start or Insufficient Provider Capacity In the event of delayed private host start or insufficient provider capacity, your payment amount and invoice for the scheduled or renewal periods will be adjusted accordingly. ## đ Locations Choose a centroid by dropping a pin and preview your primary/fallback locations for new hosts. Select a fallback strategy to control suitable locations for each centroid: * **Proximity (default)** - 700 km centroid radius, for more latency-sensitive designs, * **Redundancy** - 1,400 km centroid radius, allowing further locations as fallbacks.
{
"version": "3.2.1",
"inspect": true,
"max_deployment_retry_count": 3,
"profiles": {
"simple-example": {
"ticket_expiration_period": "5m",
"ticket_removal_period": "1m",
"group_inactivity_removal_period": "5m",
"application": {
"name": "my-game-server",
"version": "2024.01.30-16.23.00-UTC"
},
"rules": {
"initial": {
"match_size": {
"type": "player_count",
"attributes": {
"team_count": 1,
"min_team_size": 2,
"max_team_size": 2
}
},
"beacons": {
"type": "latencies",
"attributes": {
"difference": 100,
"max_latency": 200
}
}
},
"expansions": {}
}
}
}
}
The application configuration is not valid for profile XYZ.
* We couldnât find your [application-and-versions](https://docs.edgegap.com/learn/orchestration/application-and-versions "mention"), please verify `application` values.
Docker image for '2024.01.30-16.23.00-UTC' is not cached.
[**đ Upgrade to Pay as You Go tier**](https://app.edgegap.com/user-settings?tab=memberships) **to unlock** [**instant deployments with Caching**](https://docs.edgegap.com/orchestration/deployments#id-1.-start-a-deployment)**.**
* 4GB+ uncached images may take longer to deploy, resulting in [#id-4.-deployment-error](https://docs.edgegap.com/orchestration/deployments#id-4.-deployment-error "mention"). Consider optimizing your server image size ([Unreal Engine](https://docs.edgegap.com/unreal-engine#optimize-server-build-size) / [Unity](https://docs.edgegap.com/unity#optimize-server-build-size)).
* You may proceed anyway, though we recommend testing your deployment time.
Rule Example: beacons
`beacons` rule configured with `"difference": 100, "max_latency": 200` will match:
:white\_check\_mark: Alice and Bob may match:
* Tokyo is discarded (>200 ms),
* latency for Chicago within 100 ms absolute difference.
| Beacon City | Match | abs(A - B) [ms] | Alice [ms] | Bob [ms] |
|---|---|---|---|---|
| Chicago | â | 75.0 | 12.3 | 87.3 |
| Los Angeles | â | 113.2 â | 145.6 | 32.4 |
| n/a | n/a |
| Beacon City | Match | abs(A - B) [ms] | Alice [ms] | Charlie [ms] |
|---|---|---|---|---|
| n/a | n/a | 12.3 | ||
| n/a | n/a | 145.6 | ||
| n/a | n/a | 24.2 |
Troubleshooting & FAQ
My ticket is stuck in `SEARCHING` . * Please verify that youâve created enough tickets with overlapping criteria adhering to your configuration. *** My ticket is stuck switching between `MATCH_FOUND` and `TEAM_FOUND` repeatedly. * Free Tier accounts are limited to 1 deployment at a time. Please consider upgrading or stop your current deployment to start a new one. *** My ticket goes straight to `CANCELLED`. * Your ticket reached itâs expiration. Recreate a new ticket or increase the expiration period in your configuration for testing purposes. *** I receive HTTP 404 Not Found when checking on my ticket. * Your ticket was removed either by a DELETE request, or by reaching itâs removal period (starts after ticket is expired, defined in your configuration). Recreate a new ticket or increase the expiration/removal periods in your configuration for testing purposes.
đ Advanced Example (Complete Example Configuration)
```json { "version": "3.2.1", "inspect": true, "max_deployment_retry_count": 3, "allowed_cors_origins": [ "https://*.my-game-server.com" ], "profiles": { "advanced-example": { "ticket_expiration_period": "5m", "ticket_removal_period": "1m", "group_inactivity_removal_period": "5m" "application": { "name": "my-game-server", "version": "2024.01.30-16.23.00-UTC" }, "rules": { "initial": { "match_size": { "type": "player_count", "attributes": { "team_count": 1, "min_team_size": 4, "max_team_size": 4 } }, "beacons": { "type": "latencies", "attributes": { "difference": 125, "max_latency": 125 } }, "elo_rating": { "type": "number_difference", "attributes": { "max_difference": 50 } }, "selected_game_mode": { "type": "string_equality" }, "selected_map": { "type": "intersection", "attributes": { "overlap": 1 } }, "backfill_group_size": { "type": "intersection", "attributes": { "overlap": 1 } } }, "expansions": { "30": { "elo_rating": { "max_difference": 150 }, "beacons": { "difference": 125, "max_latency": 250 } }, "60": { "elo_rating": { "max_difference": 200 } }, "180": { "match_size": { "team_count": 1, "min_team_size": 1, "max_team_size": 4 }, "beacons": { "difference": 99999, "max_latency": 99999 } } } } } } } ```đŸ Custom Lobby Example
```json { "version": "3.2.1", "inspect": true, "max_deployment_retry_count": 3, "profiles": { "custom-lobby-example": { "ticket_expiration_period": "3m", "ticket_removal_period": "1m", "group_inactivity_removal_period": "5m" "application": { "name": "my-game-server", "version": "2024.01.30-16.23.00-UTC" }, "rules": { "initial": { "match_size": { "type": "player_count", "attributes": { "team_count": 1, "min_team_size": 4, "max_team_size": 4 } }, "lobby_id": { "type": "intersection", "attributes": { "overlap": 1 } } }, "expansions": { "10": { "match_size": { "team_count": 1, "min_team_size": 1, "max_team_size": 4 } } } } } } } ```đ„ Backfill Configuration Example
```json { "version": "3.2.1", "inspect": true, "max_deployment_retry_count": 3, "profiles": { "backfill-example": { "ticket_expiration_period": "5m", "ticket_removal_period": "1m", "group_inactivity_removal_period": "5m", "application": { "name": "my-game-server", "version": "2024.01.30-16.23.00-UTC" }, "rules": { "initial": { "match_size": { "type": "player_count", "attributes": { "team_count": 1, "min_team_size": 4, "max_team_size": 4 } }, "beacons": { "type": "latencies", "attributes": { "difference": 100, "max_latency": 200 } }, "backfill_group_size": { "type": "intersection", "attributes": { "overlap": 1 } } }, "expansions": {} } } } } ```
Backfill Scenarios Visualized
đ„ Backfill Example (Backfill Showcase)
```json { "profile": "backfill-example", "attributes": { "assignment": { "request_id": "cd28e6c66554", "fqdn": "cd28e6c66554.pr.edgegap.net", "public_ip": "192.168.2.14", "ports": { "game": { "internal": 7777, "external": 56890, "link": "cd28e6c66554.pr.edgegap.net:56890", "protocol": "UDP" }, "web": { "internal": 22, "external": 57440, "link": "cd28e6c66554.pr.edgegap.net:57440", "protocol": "TCP" }, "server": { "internal": 80, "external": 50110, "link": "cd28e6c66554.pr.edgegap.net:50110", "protocol": "TCP" } }, "location": { "city": "Montreal", "country": "Canada", "continent": "North America", "administrative_division": "Quebec", "timezone": "America/Toronto" } } }, "tickets": { "c3d057h5h6f7j889fk43": { "player_ip": "174.25.48.238", "attributes": { "beacons": { "New York": 12.2, "Los Angeles": 45.3, "Paris": 78.3 }, "backfill_group_size": [ "2", "1" ] }, "group_id": "192bb97e-7fd6-4d86-8ce4-61c53c9fef16", "id": "c3d057h5h6f7j889fk43", "created_at": "2024-08-20T13:38:05.251393+00:00" }, "cqg0bg9583s738h9dkf6": { "player_ip": "217.34.85.142", "attributes": { "beacons": { "New York": 21.0, "Los Angeles": 30.2, "Paris": 101.1 }, "backfill_group_size": [ "2", "1" ] }, "group_id": "aea7df3c-d391-4ea3-a3ec-dded422fe7c8", "id": "cqg0bg9583s738h9dkf6", "created_at": "2024-08-20T13:38:05.251393+00:00" } }, "assigned_ticket": null } ```đ„ Backfill Assignment Example (Backfill Showcase)
```json { "profile": "backfill-example", "attributes": { "assignment": { "request_id": "cd28e6c66554", "fqdn": "cd28e6c66554.pr.edgegap.net", "public_ip": "192.168.2.14", "ports": { "game": { "internal": 7777, "external": 56890, "link": "cd28e6c66554.pr.edgegap.net:56890", "protocol": "UDP" }, "web": { "internal": 22, "external": 57440, "link": "cd28e6c66554.pr.edgegap.net:57440", "protocol": "TCP" }, "server": { "internal": 80, "external": 50110, "link": "cd28e6c66554.pr.edgegap.net:50110", "protocol": "TCP" } }, "location": { "city": "Montreal", "country": "Canada", "continent": "North America", "administrative_division": "Quebec", "timezone": "America/Toronto" } } }, "tickets": { "c3d057h5h6f7j889fk43": { "player_ip": "174.25.48.238", "attributes": { "beacons": { "New York": 12.2, "Los Angeles": 45.3, "Paris": 78.3 }, "backfill_group_size": [ "2", "1" ] }, "group_id": "192bb97e-7fd6-4d86-8ce4-61c53c9fef16", "id": "c3d057h5h6f7j889fk43", "created_at": "2024-08-20T13:38:05.251393+00:00" }, "cqg0bg9583s738h9dkf6": { "player_ip": "217.34.85.142", "attributes": { "beacons": { "New York": 21.0, "Los Angeles": 30.2, "Paris": 101.1 }, "backfill_group_size": [ "2", "1" ] }, "group_id": "aea7df3c-d391-4ea3-a3ec-dded422fe7c8", "id": "cqg0bg9583s738h9dkf6", "created_at": "2024-08-20T13:38:05.251393+00:00" } }, "assigned_ticket": { "profile": "backfill-example", "player_ip": "244.13.201.244", "attributes": { "beacons": { "New York": 30.2, "Los Angeles": 10.5, "Paris": 123.9 }, "backfill_group_size": [ "new", "1" ] }, "id": "cqg0bg550h7uujd77khg", "group_id": "e0cf41c0-f88f-456e-a032-03b1d6821a9a", "created_at": "2024-08-20T13:38:08.251393+00:00", "status": "HOST_ASSIGNED" } } ```âïž Competitive Game Example
```json { "version": "3.2.1", "inspect": true, "max_deployment_retry_count": 3, "profiles": { "casual-example": { "ticket_expiration_period": "5m", "ticket_removal_period": "1m", "group_inactivity_removal_period": "5m", "application": { "name": "my-game-server", "version": "2024.01.30-16.23.00-UTC" }, "rules": { "initial": { "match_size": { "type": "player_count", "attributes": { "team_count": 2, "min_team_size": 5, "max_team_size": 5 } }, "beacons": { "type": "latencies", "attributes": { "difference": 125, "max_latency": 150 } }, "selected_maps": { "type": "intersection", "attributes": { "overlap": 1 } }, "backfill_group_size": { "type": "intersection", "attributes": { "overlap": 1 } } }, "expansions": { "30": { "beacons": { "difference": 125, "max_latency": 250 } }, "180": { "beacons": { "difference": 99999, "max_latency": 99999 } } } } }, "competitive-example": { "ticket_expiration_period": "5m", "ticket_removal_period": "1m", "group_inactivity_removal_period": "5m" "application": { "name": "my-game-server", "version": "2024.01.30-16.23.00-UTC" }, "rules": { "initial": { "match_size": { "type": "player_count", "attributes": { "team_count": 2, "min_team_size": 5, "max_team_size": 5 } }, "beacons": { "type": "latencies", "attributes": { "difference": 125, "max_latency": 150 } }, "versus_ranks": { "type": "intersection", "attributes": { "overlap": 1 } } }, "expansions": { "120": { "beacons": { "difference": 125, "max_latency": 250 } } } } }, "challenger-example": { "ticket_expiration_period": "5m", "ticket_removal_period": "1m", "group_inactivity_removal_period": "5m" "application": { "name": "my-game-server", "version": "2024.01.30-16.23.00-UTC" }, "rules": { "initial": { "match_size": { "type": "player_count", "attributes": { "team_count": 2, "min_team_size": 5, "max_team_size": 5 } }, "beacons": { "type": "latencies", "attributes": { "difference": 125, "max_latency": 150 } }, "elo_rating": { "type": "number_difference", "attributes": { "max_difference": 50 } } }, "expansions": { "120": { "beacons": { "difference": 125, "max_latency": 250 } } } } } } } ```| Game Mode | Team Count | Team Size | Total Players |
|---|---|---|---|
| 5v5 FPS | 2 | 5 | 10 |
| 5v5 MOBA | 2 | 5 | 10 |
| 20x3 Battle Royale | 20 | 3 | 60 |
| 10p Free For All | 1 | 10 | 10 |
đ€ Cooperative Game Example
```json { "version": "3.2.1", "inspect": true, "max_deployment_retry_count": 3, "profiles": { "cooperative-example": { "ticket_expiration_period": "3m", "ticket_removal_period": "1m", "group_inactivity_removal_period": "5m", "application": { "name": "my-game-server", "version": "2024.01.30-16.23.00-UTC" }, "rules": { "initial": { "match_size": { "type": "player_count", "attributes": { "team_count": 1, "min_team_size": 4, "max_team_size": 4 } }, "beacons": { "type": "latencies", "attributes": { "difference": 125, "max_latency": 150 } }, "selected_difficulty": { "type": "string_equality" }, "selected_map": { "type": "intersection", "attributes": { "overlap": 1 } }, "player_level": { "type": "number_difference", "attributes": { "max_difference": 10 } }, "backfill_group_size": { "type": "intersection", "attributes": { "overlap": 1 } }, "moderation_flags": { "type": "intersection", "attributes": { "overlap": 1 } } }, "expansions": { "30": { "beacons": { "difference": 125, "max_latency": 250 }, "player_level": { "max_difference": 20 } }, "60": { "match_size": { "team_count": 1, "min_team_size": 2, "max_team_size": 4 } }, "150": { "match_size": { "team_count": 1, "min_team_size": 1, "max_team_size": 4 } } } } } } } ```đ Social Game Example
```json { "version": "3.2.1", "inspect": true, "max_deployment_retry_count": 3, "profiles": { "social-example": { "ticket_expiration_period": "3m", "ticket_removal_period": "1m", "group_inactivity_removal_period": "5m", "application": { "name": "my-game-server", "version": "2024.01.30-16.23.00-UTC" }, "rules": { "initial": { "match_size": { "attributes": { "team_count": 1, "min_team_size": 50, "max_team_size": 50 }, "type": "player_count" }, "beacons": { "attributes": { "difference": 125, "max_latency": 150 }, "type": "latencies" }, "selected_mode": { "type": "intersection", "attributes": { "overlap": 1 } }, "backfill_group_size": { "type": "intersection", "attributes": { "overlap": 1 } }, "moderation_flags": { "type": "intersection", "attributes": { "overlap": 1 } } }, "expansions": { "15": { "beacons": { "difference": 125, "max_latency": 250 }, "match_size": { "team_count": 1, "min_team_size": 20, "max_team_size": 50 } }, "30": { "match_size": { "team_count": 1, "min_team_size": 10, "max_team_size": 50 } }, "150": { "match_size": { "team_count": 1, "min_team_size": 1, "max_team_size": 50 } } } } } } } ```
Matchmaking Sequence
Authorization: xxxxxxxx-e458-4592-b607-c2c28afd8b62
Group Lifecycle Activity Diagram
| Game Design - Feature / Requirement | Pre-Match Lobby | Matchmaker Group |
|---|---|---|
| invite friends to play with me | â | â |
| modify my player/match preferences | â | â |
| view other lobby member preferences | â | â |
| store and manage custom key-value data | â | â |
| notify group members that I'm ready to play | â | â |
| show matchmaking progress and find match | â | â |
| get team assignment for a player/group | â | â |
| retrieve game server connection details | â | â |
| Lobby Service (Third Party) | Unreal Engine | Unity | PC | Consoles | VR/XR | Mobile |
|---|---|---|---|---|---|---|
| Epic Online Services Lobby (Epic Games) | true | true | true | true | true | true |
| Steamworks Lobby (Valve Corporation) | true | true | true | true | true | true |
| Nakama Group (Heroic Labs) | true | true | true | true | true | true |
| Playfab Lobby (Microsoft) | true | true | true | true | true | true |
| brainCloud Lobby (bitHeads) | true | true | true | true | true | true |
| Gamekit Friends (Apple) | true | true | false | false | false | true |
| Custom Lobby (your company) | true | true | true | true | true | true |
Backfill Scenarios Visualized
đ„ Backfill Example (Backfill Showcase)
```json { "profile": "backfill-example", "attributes": { "assignment": { "request_id": "cd28e6c66554", "fqdn": "cd28e6c66554.pr.edgegap.net", "public_ip": "192.168.2.14", "ports": { "game": { "internal": 7777, "external": 56890, "link": "cd28e6c66554.pr.edgegap.net:56890", "protocol": "UDP" }, "web": { "internal": 22, "external": 57440, "link": "cd28e6c66554.pr.edgegap.net:57440", "protocol": "TCP" }, "server": { "internal": 80, "external": 50110, "link": "cd28e6c66554.pr.edgegap.net:50110", "protocol": "TCP" } }, "location": { "city": "Montreal", "country": "Canada", "continent": "North America", "administrative_division": "Quebec", "timezone": "America/Toronto" } } }, "tickets": { "c3d057h5h6f7j889fk43": { "player_ip": "174.25.48.238", "attributes": { "beacons": { "New York": 12.2, "Los Angeles": 45.3, "Paris": 78.3 }, "backfill_group_size": [ "2", "1" ] }, "group_id": "192bb97e-7fd6-4d86-8ce4-61c53c9fef16", "id": "c3d057h5h6f7j889fk43", "created_at": "2024-08-20T13:38:05.251393+00:00" }, "cqg0bg9583s738h9dkf6": { "player_ip": "217.34.85.142", "attributes": { "beacons": { "New York": 21.0, "Los Angeles": 30.2, "Paris": 101.1 }, "backfill_group_size": [ "2", "1" ] }, "group_id": "aea7df3c-d391-4ea3-a3ec-dded422fe7c8", "id": "cqg0bg9583s738h9dkf6", "created_at": "2024-08-20T13:38:05.251393+00:00" } }, "assigned_ticket": null } ```đ„ Backfill Assignment Example (Backfill Showcase)
```json { "profile": "backfill-example", "attributes": { "assignment": { "request_id": "cd28e6c66554", "fqdn": "cd28e6c66554.pr.edgegap.net", "public_ip": "192.168.2.14", "ports": { "game": { "internal": 7777, "external": 56890, "link": "cd28e6c66554.pr.edgegap.net:56890", "protocol": "UDP" }, "web": { "internal": 22, "external": 57440, "link": "cd28e6c66554.pr.edgegap.net:57440", "protocol": "TCP" }, "server": { "internal": 80, "external": 50110, "link": "cd28e6c66554.pr.edgegap.net:50110", "protocol": "TCP" } }, "location": { "city": "Montreal", "country": "Canada", "continent": "North America", "administrative_division": "Quebec", "timezone": "America/Toronto" } } }, "tickets": { "c3d057h5h6f7j889fk43": { "player_ip": "174.25.48.238", "attributes": { "beacons": { "New York": 12.2, "Los Angeles": 45.3, "Paris": 78.3 }, "backfill_group_size": [ "2", "1" ] }, "group_id": "192bb97e-7fd6-4d86-8ce4-61c53c9fef16", "id": "c3d057h5h6f7j889fk43", "created_at": "2024-08-20T13:38:05.251393+00:00" }, "cqg0bg9583s738h9dkf6": { "player_ip": "217.34.85.142", "attributes": { "beacons": { "New York": 21.0, "Los Angeles": 30.2, "Paris": 101.1 }, "backfill_group_size": [ "2", "1" ] }, "group_id": "aea7df3c-d391-4ea3-a3ec-dded422fe7c8", "id": "cqg0bg9583s738h9dkf6", "created_at": "2024-08-20T13:38:05.251393+00:00" } }, "assigned_ticket": { "profile": "backfill-example", "player_ip": "244.13.201.244", "attributes": { "beacons": { "New York": 30.2, "Los Angeles": 10.5, "Paris": 123.9 }, "backfill_group_size": [ "new", "1" ] }, "id": "cqg0bg550h7uujd77khg", "group_id": "e0cf41c0-f88f-456e-a032-03b1d6821a9a", "created_at": "2024-08-20T13:38:08.251393+00:00", "status": "HOST_ASSIGNED" } } ```đ Simple Example (Minimal Recommended Configuration)
{
"version": "3.2.1",
"inspect": true,
"max_deployment_retry_count": 3,
"profiles": {
"simple-example": {
"ticket_expiration_period": "5m",
"ticket_removal_period": "1m",
"group_inactivity_removal_period": "5m",
"application": {
"name": "my-game-server",
"version": "2024.01.30-16.23.00-UTC"
},
"rules": {
"initial": {
"match_size": {
"type": "player_count",
"attributes": {
"team_count": 1,
"min_team_size": 2,
"max_team_size": 2
}
},
"beacons": {
"type": "latencies",
"attributes": {
"difference": 100,
"max_latency": 200
}
}
},
"expansions": {}
}
}
}
}
đ Advanced Example (Complete Example Configuration)
```json { "version": "3.2.1", "inspect": true, "max_deployment_retry_count": 3, "allowed_cors_origins": [ "https://*.my-game-server.com" ], "profiles": { "advanced-example": { "ticket_expiration_period": "5m", "ticket_removal_period": "1m", "group_inactivity_removal_period": "5m" "application": { "name": "my-game-server", "version": "2024.01.30-16.23.00-UTC" }, "rules": { "initial": { "match_size": { "type": "player_count", "attributes": { "team_count": 1, "min_team_size": 4, "max_team_size": 4 } }, "beacons": { "type": "latencies", "attributes": { "difference": 125, "max_latency": 125 } }, "elo_rating": { "type": "number_difference", "attributes": { "max_difference": 50 } }, "selected_game_mode": { "type": "string_equality" }, "selected_map": { "type": "intersection", "attributes": { "overlap": 1 } }, "backfill_group_size": { "type": "intersection", "attributes": { "overlap": 1 } } }, "expansions": { "30": { "elo_rating": { "max_difference": 150 }, "beacons": { "difference": 125, "max_latency": 250 } }, "60": { "elo_rating": { "max_difference": 200 } }, "180": { "match_size": { "team_count": 1, "min_team_size": 1, "max_team_size": 4 }, "beacons": { "difference": 99999, "max_latency": 99999 } } } } } } } ```đŸ Custom Lobby Example
```json { "version": "3.2.1", "inspect": true, "max_deployment_retry_count": 3, "profiles": { "custom-lobby-example": { "ticket_expiration_period": "3m", "ticket_removal_period": "1m", "group_inactivity_removal_period": "5m" "application": { "name": "my-game-server", "version": "2024.01.30-16.23.00-UTC" }, "rules": { "initial": { "match_size": { "type": "player_count", "attributes": { "team_count": 1, "min_team_size": 4, "max_team_size": 4 } }, "lobby_id": { "type": "intersection", "attributes": { "overlap": 1 } } }, "expansions": { "10": { "match_size": { "team_count": 1, "min_team_size": 1, "max_team_size": 4 } } } } } } } ```đ„ Backfill Configuration Example
```json { "version": "3.2.1", "inspect": true, "max_deployment_retry_count": 3, "profiles": { "backfill-example": { "ticket_expiration_period": "5m", "ticket_removal_period": "1m", "group_inactivity_removal_period": "5m", "application": { "name": "my-game-server", "version": "2024.01.30-16.23.00-UTC" }, "rules": { "initial": { "match_size": { "type": "player_count", "attributes": { "team_count": 1, "min_team_size": 4, "max_team_size": 4 } }, "beacons": { "type": "latencies", "attributes": { "difference": 100, "max_latency": 200 } }, "backfill_group_size": { "type": "intersection", "attributes": { "overlap": 1 } } }, "expansions": {} } } } } ```âïž Competitive Game Example
```json { "version": "3.2.1", "inspect": true, "max_deployment_retry_count": 3, "profiles": { "casual-example": { "ticket_expiration_period": "5m", "ticket_removal_period": "1m", "group_inactivity_removal_period": "5m", "application": { "name": "my-game-server", "version": "2024.01.30-16.23.00-UTC" }, "rules": { "initial": { "match_size": { "type": "player_count", "attributes": { "team_count": 2, "min_team_size": 5, "max_team_size": 5 } }, "beacons": { "type": "latencies", "attributes": { "difference": 125, "max_latency": 150 } }, "selected_maps": { "type": "intersection", "attributes": { "overlap": 1 } }, "backfill_group_size": { "type": "intersection", "attributes": { "overlap": 1 } } }, "expansions": { "30": { "beacons": { "difference": 125, "max_latency": 250 } }, "180": { "beacons": { "difference": 99999, "max_latency": 99999 } } } } }, "competitive-example": { "ticket_expiration_period": "5m", "ticket_removal_period": "1m", "group_inactivity_removal_period": "5m" "application": { "name": "my-game-server", "version": "2024.01.30-16.23.00-UTC" }, "rules": { "initial": { "match_size": { "type": "player_count", "attributes": { "team_count": 2, "min_team_size": 5, "max_team_size": 5 } }, "beacons": { "type": "latencies", "attributes": { "difference": 125, "max_latency": 150 } }, "versus_ranks": { "type": "intersection", "attributes": { "overlap": 1 } } }, "expansions": { "120": { "beacons": { "difference": 125, "max_latency": 250 } } } } }, "challenger-example": { "ticket_expiration_period": "5m", "ticket_removal_period": "1m", "group_inactivity_removal_period": "5m" "application": { "name": "my-game-server", "version": "2024.01.30-16.23.00-UTC" }, "rules": { "initial": { "match_size": { "type": "player_count", "attributes": { "team_count": 2, "min_team_size": 5, "max_team_size": 5 } }, "beacons": { "type": "latencies", "attributes": { "difference": 125, "max_latency": 150 } }, "elo_rating": { "type": "number_difference", "attributes": { "max_difference": 50 } } }, "expansions": { "120": { "beacons": { "difference": 125, "max_latency": 250 } } } } } } } ```đ€ Cooperative Game Example
```json { "version": "3.2.1", "inspect": true, "max_deployment_retry_count": 3, "profiles": { "cooperative-example": { "ticket_expiration_period": "3m", "ticket_removal_period": "1m", "group_inactivity_removal_period": "5m", "application": { "name": "my-game-server", "version": "2024.01.30-16.23.00-UTC" }, "rules": { "initial": { "match_size": { "type": "player_count", "attributes": { "team_count": 1, "min_team_size": 4, "max_team_size": 4 } }, "beacons": { "type": "latencies", "attributes": { "difference": 125, "max_latency": 150 } }, "selected_difficulty": { "type": "string_equality" }, "selected_map": { "type": "intersection", "attributes": { "overlap": 1 } }, "player_level": { "type": "number_difference", "attributes": { "max_difference": 10 } }, "backfill_group_size": { "type": "intersection", "attributes": { "overlap": 1 } }, "moderation_flags": { "type": "intersection", "attributes": { "overlap": 1 } } }, "expansions": { "30": { "beacons": { "difference": 125, "max_latency": 250 }, "player_level": { "max_difference": 20 } }, "60": { "match_size": { "team_count": 1, "min_team_size": 2, "max_team_size": 4 } }, "150": { "match_size": { "team_count": 1, "min_team_size": 1, "max_team_size": 4 } } } } } } } ```đ Social Game Example
```json { "version": "3.2.1", "inspect": true, "max_deployment_retry_count": 3, "profiles": { "social-example": { "ticket_expiration_period": "3m", "ticket_removal_period": "1m", "group_inactivity_removal_period": "5m", "application": { "name": "my-game-server", "version": "2024.01.30-16.23.00-UTC" }, "rules": { "initial": { "match_size": { "attributes": { "team_count": 1, "min_team_size": 50, "max_team_size": 50 }, "type": "player_count" }, "beacons": { "attributes": { "difference": 125, "max_latency": 150 }, "type": "latencies" }, "selected_mode": { "type": "intersection", "attributes": { "overlap": 1 } }, "backfill_group_size": { "type": "intersection", "attributes": { "overlap": 1 } }, "moderation_flags": { "type": "intersection", "attributes": { "overlap": 1 } } }, "expansions": { "15": { "beacons": { "difference": 125, "max_latency": 250 }, "match_size": { "team_count": 1, "min_team_size": 20, "max_team_size": 50 } }, "30": { "match_size": { "team_count": 1, "min_team_size": 10, "max_team_size": 50 } }, "150": { "match_size": { "team_count": 1, "min_team_size": 1, "max_team_size": 50 } } } } } } } ```The application configuration is not valid for profile XYZ.
* We couldnât find your [application-and-versions](https://docs.edgegap.com/learn/orchestration/application-and-versions "mention"), please verify `application` values.
Docker image for '2024.01.30-16.23.00-UTC' is not cached.
[**đ Upgrade to Pay as You Go tier**](https://app.edgegap.com/user-settings?tab=memberships) **to unlock** [**instant deployments with Caching**](https://docs.edgegap.com/orchestration/deployments#id-1.-start-a-deployment)**.**
* 4GB+ uncached images may take longer to deploy, resulting in [#id-4.-deployment-error](https://docs.edgegap.com/orchestration/deployments#id-4.-deployment-error "mention"). Consider optimizing your server image size ([Unreal Engine](https://docs.edgegap.com/unreal-engine#optimize-server-build-size) / [Unity](https://docs.edgegap.com/unity#optimize-server-build-size)).
* You may proceed anyway, though we recommend testing your deployment time.
Example Match Scenarios
Rule Example: selected_game_mode
`selected_game_mode` rule will match players case sensitively:
:white\_check\_mark: Alice + Bob + Dave may match,
:x: Alice + Erin, or Charlie + Frank will never match.
| "Free For All" | "Capture The Flag" | "capture the flag" |
| -------------- | ------------------ | ------------------ |
| Alice | Erin | Frank |
| Bob | Charlie | |
| Dave | | |
Rule Example: elo_rating
`elo_rating` rule above with `"max_difference": 50` initially:
:white\_check\_mark: Alice + Bob may match, or Bob + Charlie may match,
:x: Alice + Bob + Charlie will never match.
Rule Example: beacons
`beacons` rule configured with `"difference": 100, "max_latency": 200` will match:
:white\_check\_mark: Alice and Bob may match:
* Tokyo is discarded (>200 ms),
* latency for Chicago within 100 ms absolute difference.
| Beacon City | Match | abs(A - B) [ms] | Alice [ms] | Bob [ms] |
|---|---|---|---|---|
| Chicago | â | 75.0 | 12.3 | 87.3 |
| Los Angeles | â | 113.2 â | 145.6 | 32.4 |
| n/a | n/a |
| Beacon City | Match | abs(A - B) [ms] | Alice [ms] | Charlie [ms] |
|---|---|---|---|---|
| n/a | n/a | 12.3 | ||
| n/a | n/a | 145.6 | ||
| n/a | n/a | 24.2 |
Rule Example: selected_map
`selected_map` rule above with `"overlap": 1` will match:
:white\_check\_mark: Alice + Bob + Charlie may match, or Alice + Bob + Dave may match,
:x: Alice + Bob + Charlie + Dave will never match.
Example Scenario: Expansions
[Initially, we require 1 team composed of exactly 4 players (possibly split in groups)](https://docs.edgegap.com/learn/matchmaking/..#advanced-example) with: * maximum of 125 ms latency against the same (any one) beacon, * latency difference of 125 ms or less between lowest/highest value for the same beacon, * skill rating difference of 50 points or less between lowest and highest ranking player, * the exact same (case sensitive) selected game mode, * at least one matching map selection (case sensitive) amongst players, * at least one matching [backfill group size](#backfill-match) value amongst players. In the example above, we **expand the search by modifying attributes** after:| 30 seconds: |
|
| 60 seconds: |
|
| 3 minutes (180s): |
|
Fine-Tuning Expansions
Predicting player preferences is similar to shooting at a moving target. Start with a less restrictive rule set at release and optimize afterwards in iterations with [#analytics](#analytics "mention"). These questions may help frame your thinking process: * How long is my play session? * 5 min play session means each player rejoins queue every 5 min, which will indirectly reduce queue time due to more players queueing at any given time. * What is my [peak CCU](#user-content-fn-11)[^11] and my [low tide CCU](#user-content-fn-12)[^12]? * If there's high variance (more than 60%) between low/high, you may need a separate profile for low tide to wait longer in each expansion, to accumulate more players. * What is my players' geographic distribution? * Even spread across multiple time zones means the peak and low tide have lower variance, but doesn't improve match speed since players in different regions shouldn't match if your [#ping-optimization](#ping-optimization "mention") is configured correctly (would result in high ping). * What is my skill rating distribution (per region)? * Skill distribution typically follows [Bell curve](https://www.simplypsychology.org/normal-distribution.html) (natural distribution), so with each standard deviation from average, you find less players further away from average. Players with average values will be matched fast, in first expansion, but extremes are a problem. * We recommend to increase the expanded difference amount with each expansion, e.g. 25 -> 50 -> 100, so you account for having less players on the curve extremes. * If you have any challenger tier (pro players) we recommend a separate profile with custom skill setup, since the sample is smaller and often doesn't follow the macro trend across the entire player base. (leaning towards extremes, inverted bell curve) * How can I improve matchmaking speed and match fill rate with small player base? * Learn as much about your players and their preferences as possible! * Consider removing some rules or relaxing restrictions initially. * Relax team size or team count over time - partial match is better than no match. * Increase duration between expansions to accumulate more players. * Contact us for more tips and tricks, specifically for your game design.
| Tier | Hobbyist Tier | Studio Tier | Enterprise Tier |
|---|---|---|---|
| Best Suited For | enthusiasts, solo developers | commercial releases | high-traffic launches |
| Resources | 1 vCPU + 2GB RAM | 6 vCPU + 12GB RAM | 18 vCPU + 48GB RAM |
| Redundancy | 1x virtual node | 3x virtual nodes | 3x virtual nodes |
| Rate Limit (req/s) | 200 | 750 | 2,000 |
| Price, hourly | $0.0312 | $0.146 | $0.548 |
| Price, 30 days (nonstop usage) | $22.464 | $105.12 | $394.56 |
| API endpoint | Free Tier | Hobbyist Tier | Studio Tier | Enterprise Tier |
|---|---|---|---|---|
| Overall Limit | 100 | 200 | 750 | 2,000 |
| Create Deployment | 5 | 10 | 30 | 30 |
| List Beacons | 10 | 20 | 75 | 200 |
| Create Group + Create Ticket + Create Group Ticket | 10 | 20 | 75 | 200 |
| Read Membership + Read Group + Read Ticket | 10 | 120 | 450 | 1,300 |
| Create Backfill | 5 | 10 | 37 | 100 |
Blue/Green DevOps Environment Example
Server to Server Matchmaking Activity Diagram
đ Simple Example (Specific Domains Example)
{
"version": "3.2.0",
"allowed_cors_origins": [
"https://dev.my-game-server.com",
"https://prod.my-game-server.com"
],
"profiles": {
...
}
}
đ Simple Example (Wildcard Domain Example)
{
"version": "3.2.0",
"allowed_cors_origins": ["https://*.my-game-server.com"],
"profiles": {
...
}
}
The application configuration is not valid for profile XYZ.
* We couldnât find your [application-and-versions](https://docs.edgegap.com/learn/orchestration/application-and-versions "mention"), please verify `application` values.
Docker image for '2024.01.30-16.23.00-UTC' is not cached.
[**đ Upgrade to Pay as You Go tier**](https://app.edgegap.com/user-settings?tab=memberships) **to unlock** [**instant deployments with Caching**](https://docs.edgegap.com/orchestration/deployments#id-1.-start-a-deployment)**.**
* 4GB+ uncached images may take longer to deploy, resulting in [#id-4.-deployment-error](https://docs.edgegap.com/orchestration/deployments#id-4.-deployment-error "mention"). Consider optimizing your server image size ([Unreal Engine](https://docs.edgegap.com/unreal-engine#optimize-server-build-size) / [Unity](https://docs.edgegap.com/unity#optimize-server-build-size)).
* You may proceed anyway, though we recommend testing your deployment time.
Why am I getting errors when trying to create a new matchmaker?
* Please read the error, itâs possible youâve misspelled an identifier, rule, or an operator. - Use [JSONLint](https://jsonlint.com/) to validate your JSON formatting, you may have missed a comma or a bracket. - Reach out over [our Community Discord](https://discord.gg/MmJf8fWjnt) for help, weâll be happy to assist. đWhy did my matchmaker turned off automatically after 3 hours?
* Matchmakers in Free Tier are intended for initial tests and are automatically turned off after 3 hours. To continue testing you may [restart your matchmaker](https://app.edgegap.com/matchmaker-management-v2/matchmakers/list). * Consider upgrading to paid tier for unliminted runtime.Why canât I start a second deployment on my account?
* You may only run 1 concurrent deployment in Free Tier. * Please consider upgrading to paid tier for unlimited deployments.Why am I getting assignment/deployment at random times, disregarding player_count?
* You or another team member may have created tickets during a previous testing session which were not assigned. Please [restart your matchmaker](https://app.edgegap.com/matchmaker-management-v2/matchmakers/list).
My ticket is stuck in SEARCHING .
* Please verify youâve created enough matching tickets adhering to your configuration.
My ticket is stuck switching between MATCH_FOUND and TEAM_FOUND repeatedly.
* Free Tier accounts are limited to 1 deployment at a time.
* Please consider upgrading or stop your current deployment to start a new one.
My ticket goes straight to CANCELLED.
* Your ticket reached itâs expiration. Create a new ticket or increase the expiration period in your configuration for testing purposes.
I receive HTTP 404 Not Found when checking on my ticket.
* Your ticket was removed either by a DELETE request, or by reaching itâs removal period (starts after ticket is expired, defined in your configuration). Recreate a new ticket or increase the expiration/removal periods in your configuration for testing purposes.
My matchmaker shows an error, what should I do?
* If this is a development or a testing instance, try restarting your matchmaker first. - Please report any issues through [our Community Discord](https://discord.gg/MmJf8fWjnt). * In case this issue is impacting a live game, create an [urgent support request](https://edgegap.atlassian.net/servicedesk/customer/portal/3).
Server Browser: Flow and Hierarchy
Authorization: xxxxxxxx-e458-4592-b607-c2c28afd8b62
| Parameter | Operators | Example Filter (based on Simple Example) |
|---|---|---|
"joinable_seats" | | |
"string"(metadata) | | |
(metadata) | | |
"bool"(metadata) | eq or ne | |
{
"version": "0.0.5",
"server_instances": {
"expiration_period": "30m",
"indices": {
"third_party_id": "string",
"level": "string",
"mode": "string",
"difficulty": "string",
"seed": "string",
"avg_player_rank": "int",
"max_player_count": "int",
"is_ranked": "bool",
"app_version": "string",
"DEPLOYMENT_LOCATION.city": "string",
"DEPLOYMENT_TAGS": "string",
"IN_PRIVATE_FLEET": "bool",
"HOST_BASE_CLOCK_FREQUENCY": "int",
"DEPLOYMENT_VCPU_UNITS": "int",
"DEPLOYMENT_MEMORY_MB": "int",
"PORT_GAMEPORT_EXTERNAL": "string",
"BEACON_ENABLED": "bool",
"BEACON_PUBLIC_IP": "string",
"BEACON_PORT_UDP_EXTERNAL": "string",
"BEACON_PORT_TCP_EXTERNAL": "string",
"MM_MATCH_ID": "string",
"MM_INTERSECTION": "string",
"MM_EQUALITY": "string"
}
},
"server_instance_slots": {
"indices": {
"third_party_id": "string",
"name": "string",
"max_player_count": "int",
"avg_player_rank": "int",
"avg_player_latency": "int",
"player_ids": "string"
}
},
"seat_reservations": {
"expiration_period": "5m"
},
"scaling_policies": {
"monitoring_interval": "10s",
"deployment_registration_period": "1m"
}
}
| Tier | Hobbyist Tier | Studio Tier | Enterprise Tier |
|---|---|---|---|
| Best Suited For | enthusiasts, solo developers | commercial releases | high-traffic launches |
| Resources | 1 vCPU + 2GB RAM | 6 vCPU + 12GB RAM | 18 vCPU + 48GB RAM |
| Redundancy | 1x virtual node | 3x virtual nodes | 3x virtual nodes |
| Rate Limit (req/s) | 200 | 750 | 2,000 |
| Price, hourly | $0.0312 | $0.146 | $0.548 |
| Price, 30 days (nonstop usage) | $22.464 | $105.12 | $394.56 |
| Tier | Hobbyist Tier | Studio Tier | Enterprise Tier |
|---|---|---|---|
| Best Suited For | enthusiasts, solo developers | commercial releases | high-traffic launches |
| Resources | 1 vCPU + 2GB RAM | 6 vCPU + 12GB RAM | 18 vCPU + 48GB RAM |
| Redundancy | 1x virtual node | 3x virtual nodes | 3x virtual nodes |
| Rate Limit (req/s) | 200 | 750 | 2,000 |
| Price, hourly | $0.0312 | $0.146 | $0.548 |
| Price, 30 days (nonstop usage) | $22.464 | $105.12 | $394.56 |
apiVersion: cert-manager.io/v1
kind: ClusterIssuer
metadata:
name: letsencrypt-staging
namespace: cert-manager
spec:
acme:
server: https://acme-staging-v02.api.letsencrypt.org/directory
email: <YOUR_EMAIL>
privateKeySecretRef:
name: letsencrypt-staging
solvers:
- http01:
ingress:
class: nginx
isProductionEnvironment: true
# The external hostname for the Nakama server - DNS record from last step
externalHostName: <DNS_A_RECORD_URL>
nakama:
# The version of Nakama to deploy.
# See https://hub.docker.com/r/heroiclabs/nakama/tags for available versions.
version: 3.26.0
# Username and password for the Nakama console
username: <USERNAME>
password: <PASSWORD>
apiVersion: cert-manager.io/v1
kind: ClusterIssuer
metadata:
name: letsencrypt-staging
namespace: cert-manager
spec:
acme:
server: https://acme-staging-v02.api.letsencrypt.org/directory
email: <YOUR_EMAIL>
privateKeySecretRef:
name: letsencrypt-staging
solvers:
- http01:
ingress:
class: nginx
{
"count": 100,
"data": ["foo-0", "[...]", "bar-9"],
"pagination": {
"number": 1,
"next_page_number": 2,
"previous_page_number": null
"paginator": {
"num_pages": 10
},
"has_next": true,
"has_previous": false
}
}
View Release Notes 2026
### 2026.01.12 **Improvements đȘ** * Improved messaging on the deployment details page when no [log storage](https://docs.edgegap.com/docs/endpoint-storage/save-container-logs) is configured, displaying a clear explanation instead of a generic error. * Enhanced container image validation on the dashboard to better prevent the creation of application versions with invalid container images. **Fixed â** * Fixed an issue where the available credits section on the dashboard incorrectly displayed âNot Available.â * Fixed the [Out of Memory insights graph](https://app.edgegap.com/analytics/dashboards/list) introduced in the previous release, which was not displaying data correctly. ### 2026.01.07 **New âš** * [**Private Fleets**](https://docs.edgegap.com/learn/orchestration/private-fleets) â Reserve and manage your own fleet of persistent servers (bare metal or VMs) across Edgegap locations worldwide via our self-serve platform. Edgegap fully orchestrates your fleet and automatically scales to our regionless cloud when traffic exceeds capacity, optimizing player experience and infrastructure costs. * [**Server Browser**](https://docs.edgegap.com/learn/server-browser) â Enable players to browse and join persistent servers with ease. Designed for MMOs and social games, it includes game-ready authentication, automated session management with latency optimization, and a scalable private cluster architecture.View Release Notes 2025
### 2025.12.16 **Improvements đȘ** * Added new insights for Deployments Out Of Memory (OOM) in [Analytics](https://app.edgegap.com/analytics/dashboards/list). **Fixed â** * Added missing [pagination](https://docs.edgegap.com/api#response-pagination) support for [Registry API - listing image tags method](https://docs.edgegap.com/api/versioning#get-v1-container-registry-images-image_name-tags). ### 2025.11.03 **Improvements đȘ** * Added SSO support on the account registration page. * Improved caching errors for [Deployments in Error](https://docs.edgegap.com/learn/orchestration/deployments#id-4.-deployment-error) for [V2 deployment API](https://docs.edgegap.com/api/dedicated-servers#post-deployments). * Improved notifications for auto-cleaned [Deployments in Error](https://docs.edgegap.com/learn/orchestration/deployments#id-4.-deployment-error) clarifying no charges were added. * Improved caching indicator criteria, green caching status is now more reliable. **Fixed â** * Fixed incorrect browser auto-translation of quick start token. * Fixed an issue preventing matchmakers or clusters from starting in certain regions. ### 2025.09.11 **New âš** * Easily change your organization's owner under [**Settings > Organizations > Manage Roles**](https://app.edgegap.com/user-settings?tab=organizations). **Fixed â** * Fixed live metrics showing a sum of per-core usage instead of overall percentage. * Fixed an issue with authentication warning showing on dashboard sign-in sometimes. ### 2025.09.09 **New âš** * Link your Discord account for faster support and easier integration. * Added a new server location in Berlin, Germany. **Fixed â** * Fixed deployments getting stuck with an empty environment variable and `is_hidden=true`. * Fixed a bug where a "no login" email was incorrectly sent after a new tier subscription. ### 2025.08.27 **Improvements đȘ** * Dashboard now remembers your signed-in device for 7 days before logging you out. **Fixed â** * Fixed a bug with deployments not being reused for Sessions after 500x Sessions. * Fixed an error thrown due to removing endpoint storage from an application version. * Fixed an error caused by more complex dashboard deployment filters with timestamps. * Fixed an error with some dashboard notifications not displaying descriptions properly. ### 2025.08.20 **New âš** * [Specify your preferred cluster region](https://app.edgegap.com/cluster-management/clusters/list) for private clusters (custom services) through dashboard! **Improvements đȘ** * Rate limiting alerts are now only sent if exceeded multiple times per minute. * Updated [Edgegap registry](https://app.edgegap.com/registry-management/repositories/list) URL to `registry.edgegap.com`. Prefix `registry2` kept as an alias. **Fixed â** * Fixed live metrics errors in deployment dashboard page due to fetching data too early. ### 2025.08.14 **New âš** * Specify your preferred matchmaker region for [private matchmaker tiers](https://docs.edgegap.com/learn/matchmaking/matchmaker-in-depth#hosting-cluster) through dashboard! [Change the region of your running cluster](https://app.edgegap.com/matchmaker-management-v2/matchmakers/list) with a stop-start. [Learn more about zero downtime updates.](https://docs.edgegap.com/learn/matchmaking/matchmaker-in-depth#rolling-updates-and-ab-tests) * Request China mainland region availability for your [app version](https://app.edgegap.com/application-management/applications/list), subject to Edgegap review. **Improvements đȘ** * [Deployment history metrics](https://docs.edgegap.com/learn/advanced-features/deployments#container-metrics) interval is now 2 minutes, matching the metric aggregation period. Live metrics remain unaggregated with 1 second interval measurements. **Fixed â** * Fixed missing deployment tags in deployment list and filtering for [Smart Fleets](https://app.edgegap.com/fleet-management/smart-fleets/list). ### 2025.08.07 **Improvements đȘ** * Updated game samples [fishnet-on-edgegap](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/fishnet-on-edgegap "mention") and [unity-netcode-on-edgegap](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/unity-netcode-on-edgegap "mention") for latest Unity 6 LTS. * Added network metrics legend to deployment live metrics. * Added security schema to v2 openapi specification to simplify testing. **Fixed â** * Fixed an internal error in [metrics API](https://docs.edgegap.com/api/dedicated-servers#get-v1-metrics-deployment-request_id) for deployments not reaching [status Ready](https://docs.edgegap.com/learn/orchestration/deployments#id-3.-deployment-ready) ### 2025.07.23 **New âš** * Create application versions with up to **4âŻvCPU and 8âŻGB of RAM** from dashboard. **Fixed â** * Fixed an occasional issue with missing data points in deployment details history charts. * Fixed a bug preventing creating third party registry profiles with a token longer than 1000 characters (e.g., for Google Registry). ### 2025.07.08 **New âš** * **Edgegap Container Registry capacity increased to 10 GB for all users**, including free tier! **Improvements đȘ** * Improved application creation dashboard page user experience. **Fixed â** * Fixed a bug where the total player count wasnât displayed correctly on the dashboard homepage in some cases. This represents a sum of all IP addresses and coordinates in deploy requests, including matchmaker deployments. * Fixed an issue on the new application version page where inputs werenât pre-filled properly when redirected from the Unity plugin. *** ### 2025.07.02 **New âš** * Create and edit app versions more easily, now with automatic input suggestions for containers! * Filter your [analytics](https://app.edgegap.com/analytics/dashboards/list) reports by application version, to monitor resource usage more easily for versions with varying resource requirements and the same docker image. * Try our simplified and updated game samples without building servers: * Unreal Engine 5.5.4: [lyra-sample](https://docs.edgegap.com/docs/sample-projects/unreal-engine/lyra-sample "mention") * Unity 6: [Photon Fusion 2 Asteroids](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/photon-fusion-2-on-edgegap) | [mirror-pong](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/mirror-pong "mention") | [FishNet HashGrid](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/fishnet-on-edgegap) * Export deployment logs to [endpoint storage](https://app.edgegap.com/endpoint-storage-management/endpoint-storages/list) as newline-delimited JSONs (NDJSON). **Improvements đȘ** * Updated and improved API specification for [Create Application Version](https://docs.edgegap.com/api/versioning#post-v1-app-app_name-version) and [Update Application Version](https://docs.edgegap.com/api/versioning#patch-v1-app-app_name-version-version_name). No changes have been made to API endpoints request/response payloads. * Added more hints for [upgrading matchmaker tiers](https://docs.edgegap.com/learn/matchmaking/matchmaker-in-depth#rolling-updates-and-ab-tests) in dashboard. * View your free credits expiration date in settings. **Fixed â** * Fixed a bug where deployment tags were not displayed on the archived deployment's detail page. *** ### 2025.06.30 **New âš** * **Deploy servers easier, faster, and more reliably than ever** with `v2/deployments` . * Matchmaker and engine plugins will be updated shortly to use this API (in a new version). * We're keeping `v1/deploy` functioning for legacy integrations, no changes are required. **Improvements đȘ** * [Smart Fleets](https://docs.edgegap.com/docs/fleet) now scale up more gradually when started with a high minimum value in policy. You should no longer see errors due to high amount of rapid deployment retries in such scenario. * Updated [subscription pricing visuals in dashboard](https://app.edgegap.com/user-settings?tab=memberships). No changes have been made to platform pricing. **Fixed â** * Fixed disabling container log storage by query parameter for [self-stop deployment API endpoint](https://docs.edgegap.com/api/dedicated-servers#delete-v1-self-stop-request_id-access_point_id). *** ### 2025.05.21 {% hint style="success" %} đ **Matchmaker 3.0.0 is here!** This major update introduces smarter team filling with min/max team size (breaking change), faster and more efficient matchmaking, and improved handling of backfills and latency. [See full changelog...](https://docs.edgegap.com/learn/matchmaking/matchmaker-in-depth#id-3.0.0-may-20-2025)\ \ To upgrade, stop your matchmaker, edit config, and restart. Quick restart wonât apply version updates. {% endhint %} **New âš** * [**Testing and Releases:**](https://app.edgegap.com/test-and-release-management/test-and-release) You can now schedule releases, playtests, demos, and other key events directly from the dashboard. This gives you access to live support and a dedicated meeting room on your launch day, so you're never alone when it matters most. **Improvements đȘ** * New matchmakers will now use upgraded Kubernetes version automatically. We'll reach out to notify owners of running matchmakers to schedule updates ahead of time. **Fixed â** * Fixed a bug where a `label` attribute was incorrectly added to the JSON of pre-configured configurations when creating a matchmaker. *** ### 2025.05.14 **New âš** * A warning notice is now displayed when creating or updating an application version using the `latest` Docker tag, which is [strongly discouraged to avoid unpredictable caching behavior](https://docs.edgegap.com/learn/orchestration/application-and-versions#container-parameters-required). * Review :green\_circle: [available](https://docs.edgegap.com/learn/orchestration/deployments#high-availability) and :blue\_circle: [burstable](https://docs.edgegap.com/learn/orchestration/deployments#high-availability) deployment locations [in dashboard map in real time](https://app.edgegap.com/). **Fixed â** * Deployment details page now shows all deployment tags (previously showing only 10 results). *** ### 2025.05.01 **New âš** * View all associated tags that will be removed when deleting an artifact in [Registry Dashboard](https://app.edgegap.com/registry-management/repositories/list). * Added a direct âPay Invoiceâ link in the [billing section](https://app.edgegap.com/user-settings?tab=invoices) for easier manual payment. **Improvements đȘ** * [Recent Deployments chart in Dashboard](https://app.edgegap.com/) no longer shows the last incomplete 5 minute interval. * All table sorting preferences in dashboard are now saved across sessions. * Removed duplicate deletion messages in dashboard for some edge cases. *** ### 2025.04.28 **New âš** * **View live metrics refreshed every 1 second from deployment page!** Troubleshoot and optimize resource usage more easily by monitoring CPU and memory usage in real time. * **Toggle caching and inspect caching status** easily in your [app versions list dashboard page](https://app.edgegap.com/application-management/applications/list). * **Prevent slow deployments due to configuration errors** when releasing updates. You will be now [automatically notified](https://app.edgegap.com/notifications) when more than 5 uncached deployments are made within 1 minute. **Improvements đȘ** * Open recently updated resources' links in dashboard in a new tab with middle-click. * Improved sign in and sign up layout for a smoother and more intuitive onboarding experience. **Fixed â** * Fixed a bug where container logs stored on your S3 endpoint were not displayed correctly if the app version name contained special characters on the archived deployment details page. * Fixed duplicate displaying of logs for some running deployments. *** ### 2025.04.15 {% hint style="success" %} **Free tier increased to allow** [application-and-versions](https://docs.edgegap.com/learn/orchestration/application-and-versions "mention") **with 1.5 vCPU and 3 GB of memory**, to allow testing more demanding servers (e.g. [Unreal Engine Lyra sample](https://dev.epicgames.com/documentation/en-us/unreal-engine/lyra-sample-game-in-unreal-engine)) before upgrading to pay as you go tier. {% endhint %} **Improvements đȘ** * Improved registration and onboarding to provide a smoother experience. * Improved quick skimming of recent resources - icons are now placed on the left. * Updated [`/v1/stop/{request_id}`](https://docs.edgegap.com/api/dedicated-servers#v1-stop-request_id) API reference with clearer explanations and refined terminology to make it easier to understand. No changes were made to the actual API endpoint. *** ### 2025.04.10 **New âš** * A brand new table is now available on the dashboard home screen! It shows your most recently updated resourcesâapplication versions, matchmakers, and clustersâso you can stay on top of what's happening at a glance and jump straight to what matters. **Fixed â** * Fixed an issue where users registering with an expired invitation link were mistakenly prompted to create an organization. The flow now clearly shows an error if the link is no longer valid. * Fixed a rare issue where deployment container logs were not visible on the dashboard, even when they should have been. * Fixed a bug where the caching notification displayed the wrong time format, leading to confusing information. *** ### 2025.04.02 **New âš** * Our brand-new analytics section is now live on the dashboard! For Pay-as-You-Go users, gain deeper insights into your running containers with near real-time metrics on vCPU and RAM usage, network bandwidth, and more. Optimize performance and stay ahead with better resource monitoring! **Improvements đȘ** * You can now sort the versions list for your applications by name on the dashboard, making it easier to organize and manage them. *** ### 2025.03.27 **New âš** * Deployment tags are now displayed on the session list page, and you can filter sessions by deployment tags. * We now apply the same validations when starting a matchmaker as when creating one. This change clarifies whether a matchmaker might result in flaky matchmaking due to misconfiguration. **Improvements đȘ** * We've refreshed the [`/v1/deploy`](https://docs.edgegap.com/api/dedicated-servers#v1-deploy) API reference with clearer explanations and improved terminology for better comprehension. No changes were made to the specifications. * Added visual banners for new users to guide them to the documentation when landing on the dashboard. *** ### 2025.03.20 **Improvements đȘ** * The matchmaker creation form has been improved to speed up the creation of new matchmakers using templates. Additionally, changes have been made to ensure ongoing progress is not lost when editing the configuration in the creation modal. We also try to prefill the form with your latest application version when using templates. * The registration process using invitation links has been improved to automatically use the email provided by the organization owner, ensuring the flow isn't disrupted by a different email during registration. *** ### 2025.03.17 **New âš** * [Introducing Self-Healing Fleets](https://docs.edgegap.com/docs/fleet): Edgegap now retries your Fleet deployments in Error up to 5 times every day, if the current deployment count is below your target capacity. [Read more about why your deployment may end up in Error.](https://docs.edgegap.com/learn/advanced-features/deployments#id-4.-deployment-error) **Improvements đȘ** * Renamed matchmaker dashboard button label to "Force Stop" instead of "Remove" for matchmakers in Error. This action doesn't change your matchmaker URL or Auth token. *** ### 2025.03.05 **New âš** * Increased the limit of simultaneous errored deployments for free-tier users from 1 to 10. We observed that some users were hitting the previous limit, which led to a poor experience. This change provides more flexibility when testing deployments on the platform. * Organization owners can now view pending member invitations on the organization settings page. **Improvements đȘ** * Added additional validation when creating a matchmaker to help prevent the use of invalid or uncached application versions. * Reorganized the layout of the organization settings page to improve navigation and make it easier to manage your organization and add members. *** ### 2025.02.19 Hosting for Legacy Managed Matchmaker and [Legacy Advanced Matchmaker](https://docs.edgegap.com/learn/advanced-features/managed-clusters) has been deprecated and is no longer available in the API or dashboard. See [Gen2 Managed Matchmaker](https://docs.edgegap.com/docs/release-notes/broken-reference) or [Advanced Matchmaker on Managed Clusters](https://docs.edgegap.com/learn/advanced-features/managed-clusters#advanced-matchmaker) for our latest generation of matchmaking products. **Improvements đȘ** * Made the quick restart button for the matchmaker more visible on the dashboard. * Improved the display of credentials used for pushing images on the registry page. **Fixed â** * Fixed a bug where the same application version name could be used when duplicating an application version on the dashboard. * Fixed a bug where certain content, such as tokens, environment variables and container requirements, was incorrectly translated by browser auto-translate features. *** ### 2025.02.12 **New âš** * We've redesigned the sidebar layout on the dashboard to make it more user-friendly and easier to navigate. **Improvements đȘ** * Made further improvements to the matchmaker readiness validation when starting a Gen2 matchmaker, reducing the likelihood of errors during deployment. * Improved the homepage layout with a smoother loading experience and better element transitions. **Fixed â** * Fixed a validation issue where uppercase characters could be used in the application version container configuration. This change now enforces lowercase characters only. * Fixed a bug where the deployment time remaining displayed on the dashboard was inaccurate in some cases. * Fixed a bug where the matchmaker Swagger documentation was not regenerated after a configuration update. *** ### 2025.02.06 **New âš** * We've added a locking mechanism that prevents the deletion of an application version if it is currently in use by a matchmaker. This change applies to both the API and the dashboard. **Fixed â** * Fixed inconsistencies in the API specifications. *** ### 2025.01.30 **Fixed â** * Fixed an issue where refreshing the matchmaker details page on the dashboard would result in a 500 error. * Fixed an occurrence where the cache for certain app versions could be disabled when communication with Docker was unreliable. * Fixed a bug where the beacons list from the API could include duplicate cities. *** ### 2025.01.21 **New âš** * We've added more locations to our network, providing greater coverage and improved performance for your deployments. **Improvements đȘ** * Enhanced the management of default registry profiles for better clarity. **Fixed â** * Fixed a bug where the container registry page displayed "Invalid DateTime" instead of the actual date in the last pull/push section. * Fixed a bug on the app version details page where the caching progress always displayed as "low (red)" even when the actual coverage was "high (green)." *** ### 2025.01.15 **New âš** * When using a [Docker registry profile](https://docs.edgegap.com/learn/orchestration/application-and-versions#container-parameters-required), creating a new app version will automatically fetch the available images and tags from your repository for selection. * [Deployment environment variables](https://docs.edgegap.com/learn/advanced-features/application-and-versions/#other-parameters-optional) can now be up to 4KB in size. **Fixed â** * Fixed an issue where the plugin for initializing the container registry did not work and failed to provide proper access. * Corrected the return status code from 401 Unauthorized to 400 Bad Request when sending an overly long environment variable in a deployment request. * Fixed a layout issue on the dashboard across multiple pages. * Fixed the matchmaker Gen2 startup flow to reduce potential errors during deployment. *** ### 2025.01.13 {% hint style="info" %} From this release, the API will enforce a CPU/Memory ratio of 1:2. This change aims to keep costs as low as possible for everyone and improve the orchestration of resource usage across all users. {% endhint %} **New âš** * You can now use application environment variables up to 4KB in size. * Our Mava AI chatbot is now available in dashboard, in addition to Discord, allowing access from multiple locations. * We've added a new heatmap to app version details displaying the balance points of your deployment requests. * The homepage map now displays our available beacons. * We've added an option to perform a quick restart of your Gen2 matchmaker without needing to change anything in the configuration. Note that this will delete all current tickets and temporarily make the API inaccessible. **Improvements đȘ** * The relay page now displays the status of your relay sessions. * Adding tags from the dashboard now uses the same validation as the API, allowing a greater range of values. * Improved the matchmaker readiness validation when starting a Gen2 matchmaker, reducing false positives where the status displayed as ready but the matchmaker was still unreachable for a short time. * Accelerated the reload time for a Gen2 matchmaker. * Made backend optimizations to the dashboard for a slightly faster experience. If you encounter unexpected errors on certain pages, please let us know via our [Discord](https://discord.com/invite/NgCnkHbsGp). **Fixed â** * Fixed an issue where metric charts sometimes did not display on the deployment details page. * Fixed an issue where session sockets used always displayed as 0, even when sessions were present in the deployment details page under the session tab. **Documentation đ** * new: [Unreal Engine learning center](https://docs.edgegap.com/docs/release-notes/broken-reference) - [Developer Tools](https://docs.edgegap.com/unreal-engine/developer-tools) and [Getting Started with Servers](https://docs.edgegap.com/unreal-engine) * updated [Gen2 Unity SDK documentation in Unity Developer Tools](https://docs.edgegap.com/unity/developer-tools#matchmaking-sdk) * added [Advanced Example configuration to Getting started with Gen2](https://docs.edgegap.com/docs/release-notes/broken-reference) * added and updated example requests/responses for [Gen2 Matchmaker In-Depth](https://docs.edgegap.com/learn/matchmaking/gen2-matchmaker-in-depth) * added and updated tips for using [Ping Beacons](https://docs.edgegap.com/learn/orchestration/ping-beacons)View Release Notes 2024
### 2024.12.09 {% hint style="info" %} Match Players & Launch Games Instantly, the Easy Way Edgegapâs âGen 2â Matchmaker is now out of Early Access! What might warrant such a change, you might ask? **New, Powerful Features!** Joining the region-less, latency-based matchmaking (the only matchmaker with this feature, that we are aware of) and team matchmaking, we have: * [Automated Backfill](https://docs.edgegap.com/docs/release-notes/broken-reference): Upon (popular) request, weâre adding backfill with automated ticket assignment, which allows you to reuse server seats when players leave the session. * Ideal for filling empty player seats after a match has begun, or for replacing players that have left during a match. * [Group Matchmaking](https://docs.edgegap.com/docs/release-notes/broken-reference): Weâre adding the ability to join as a group to the already available ability to fill multiple teams with players. * Ideal for joining up in a matchmaking queue with a group of friends or coming from a common lobby. {% endhint %} **New âš** * The dashboard now enforces a minimum of 1/4 vCPU when creating an application version. This change aims to reduce integration issues observed with smaller instances and improve first time user experience. If you need access to smaller increments, please contact us. * The API now enforces a minimum of 1/4 vCPU when creating an application version. **Users previously using smaller instances will not be affected by this change.** If you need access to smaller increments, please contact us. * We've added a warning message when updating the maximum duration of an application version. Changing this value can cause running deployments to be immediately stopped. * You can now edit your configuration while the matchmaker is running. This triggers a quick reload of your configuration without requiring a full on/off cycle for your matchmaker. Note: This feature is not recommended for production environments, as it deletes all current tickets and temporarily makes the API unresponsive. **Improvements đȘ** * The minimum size for Matchmaker Gen2 has been reduced to 1 CPU & 2GB of Memory, and it's pricing has been decreased to $0.0312/hour. This change lowers costs for development and testing environments. * We've improved the flow for organization invitations when the invited user is already registered on the platform. * We've improved the matchmaker Gen2 health status to prevent false positives. **Fixed â** * Fixed a bug where relay sessions were not automatically deleted when players timed out or disconnected from the relay. * Fixed a bug where the disable option for an application wasn't preventing deployments from being created. * Fixed a bug with the deployment metric charts that caused them to display incorrect data on the dashboard. **Documentation đ** * We've fixed the search bar to work in the Learning Center as well. * Added documentation for the new matchmaker Gen2 features: [Automated Backfill](https://docs.edgegap.com/docs/release-notes/broken-reference) and [Group Matchmaking](https://docs.edgegap.com/docs/release-notes/broken-reference). *** ### 2024.11.21 **New âš** * We've added functionality to request our new Premium Consultation Service, available through the user modal on the dashboard. * Starting from this release, application versions that don't use caching will be deployed on a subset of locations. As a result, your deployments without caching activated may be further away than before. This change has no effect on cached deployments. This is part of our effort to optimize resource usage and provide a better service to all users. * The dashboard home page now displays a new announcement box at the top to keep you informed of important updates and changes. * We've added a progress bar to the matchmaker Gen2 creation and removal process to give you a better idea of the time remaining. * You can now save credentials from external container registries and use them as default credentials when creating a new application version on the dashboard. This feature will be integrated with our plugins in the future. Default credentials are also working with our registry. * We've added a button to copy your request ID on the deployment page. This feature will help you provide the necessary information when contacting support. * To improve user experience, all application versions must now have a set maximum time to live (TTL) of 24 hours. While this maximum TTL has been enforced internally since the 2024.09.09 release, this change makes it visible on the dashboard, reducing confusion about deployments being deleted unexpectedly. * You can now use filters in the list deployments API route to filter deployments. Some of the available filters are status, version, request ID, tags, and more. Documentation will be updated soon with additional details. * We've added an [API route to delete a lobby](https://docs.edgegap.com/docs/api). * We've added an [API route to list all lobbies](https://docs.edgegap.com/docs/api). **Improvements đȘ** * Whitespace is now supported in the creation of organization names. * Updated lobby name validation to prevent unexpected release errors. * We now support S3 buckets from AWS, alongside most other S3-compatible storage services already supported. **Fixed â** * Fixed a UI bug on the deployment page where using a large number of tags would break the layout. * Fixed a bug where making an API call to a lobby soon after creating it would return a 503 Service Unavailable error. * Fixed a bug where some individual port environment variables were not injected properly into the deployment's container. * Fixed a bug where dashboard deployment logs did not display detailed error messages when a deployment failed. * Fixed a bug where application versions ports would be deleted unexpectedly when updating the application version. * Fixed a bug that caused session and relay session creation to be slower than expected. * Fixed a bug where it was impossible to delete a Gen2 matchmaker when too many errors had occurred when releasing it. **Documentation đ** * Added an [Unreal Top-Down](https://docs.edgegap.com/docs/sample-projects/unreal-engine/top-down-sample) sample project. * Consistency fixes for the Gen2 matchmaker documentation. * Updated the Learning Center with new content and minor consistency improvements. *** ### 2024.10.30 **New âš** * You will now receive a dashboard notification when you reach an API rate limit. This notification helps you avoid unexpected behavior when interacting with the API and alerts you to potential issues and unexpected costs. * You can now filter your deployments by city, country, and continent on the dashboard. * Matchmaker Gen2 JSON errors are now more descriptive and easier to understand when creating or updating a matchmaker. * The JSON configuration editor for the Gen2 matchmaker now supports copy-pasting, undo/redo, collapse/expand, JSON error highlighting, and auto-correction. **Improvements đȘ** * Weâve improved the private matchmaker creation process to make it more user-friendly and intuitive. The flow for creating and deleting a private matchmaker will be slightly longer, but we plan to add a reload feature, allowing you to change your configuration without having to stop and start the matchmaker. **Fixed â** * Fixed a bug with the application version bulk delete feature that was not functioning correctly on the dashboard. * Fixed a bug in which the maximum deployment time was not correctly applied when deploying an application version with caching disabled. * Fixed a bug where the dashboard validation for endpoint storage was returning false positives for misconfigured buckets. **Documentation đ** * We've introduced our new [Learning Center](https://docs.edgegap.com/learn), where you can find all the resources you need to get started with Edgegap. *** ### 2024.10.08 {% hint style="info" %} Matchmaker Gen2 We still ironing out bugs and adding new features to our Matchmaker Gen2. We now have a dedicated changelog for it, which you can find \[here]\(/docs/gen2-matchmaker-changelog). {% endhint %} **New âš** * The dashboard will set the maximum duration for deployment to 60 minutes by default when creating a new application version. This change will help prevent unexpected costs. You can still adjust the duration to your needs. **Fixed â** * Fixed an issue with lobbies where they would not start correctly and return an error message when getting the status. * Fixed the average deployment time section on the dashboard's home page that was sometimes displaying an error message. *** ### 2024.09.25 {% hint style="info" %} Matchmaker Gen2 Our new Matchmaker Gen2 is now live and available to everyone! You can access it directly through the dashboard in the same place as the previous matchmaker. This latest version offers increased flexibility and control over your matchmaking process, all while being easier to use. You can start by creating matchmakers on our free cluster for early testing, and then seamlessly transition to your own dedicated cluster for live games or uninterrupted testing. Matchmaker Gen2 is currently in early access until we fully phase out the previous version, and weâre super excited to have everyone onboard! Check out our [documentation](https://docs.edgegap.com/docs/release-notes/broken-reference) to get started, and donât hesitate to share your feedback with us on [Discord](https://discord.com/invite/NgCnkHbsGp). {% endhint %} **New âš** * We are introducing a "bring your own DNS" feature. This will allow you to use your own domain name for your deployments. This feature is currently in early access, if you are interested in testing it, please reach out to our support team. * Effective with this release, we will now delete protected deployment after a period of 48h. **Improvements đȘ** * Our plugin for Unity has been updated and is now available on the [asset store](https://assetstore.unity.com/packages/tools/network/edgegap-game-server-hosting-212563). **Fixed â** * Fixed some color formatting issues with the session logs on the dashboard. *** ### 2024.09.09 {% hint style="info" %} Weâve begun our closed BETA for Matchmaker Gen 2! This new version is a complete overhaul of the current managed matchmaker, offering greater flexibility and control over your matchmaking process. {% endhint %} {% hint style="success" %} Resource Management To improve resource management and help prevent unnecessary costs on your end, we'll now automatically close deployments that run for over 24 hours. If you need a deployment to stay active longer, let us know and we'll be happy to assist. {% endhint %} **New âš** * Empty relay sessions will now automatically delete after 10 minutes. This change helps manage resources more efficiently and reduces the amount of code needed to manage your relay sessions. **Improvements đȘ** * The container registry page on the dashboard now correctly displays repositories with subfolders. * The registry management API endpoints now support repositories with subfolders. * When creating a new session-type application version, the auto-deploy feature will now be enabled by default. This should reduce confusion around the deployment process. You can still disable auto-deploy if your workflow requires it. * We've added more locations to our network to provide even more coverage and better performance for your deployments. **Fixed â** * Fixed a bug where some locations were not displayed correctly on the deployment details page when they were deleted. This occurred with older terminated deployments. * Fixed a small UI bug with the form inputs on the dashboard. **Documentation đ** * Added an info box on using the `X-Real-IP` header in ticket creation when using the managed matchmaker ([doc](https://docs.edgegap.com/docs/release-notes/broken-reference)). * Fix the injected selector example in the managed matchmaker configuration ([doc](https://docs.edgegap.com/docs/release-notes/broken-reference)). *** ### 2024.08.13 **New âš** * You can now delete your relay session directly from the relay details page on the dashboard. * We've added a feature for the **relay session** to automatically detect when your players are disconnected and remove them from the relay session. This feature will help you manage your sessions more efficiently. We will add a feature to delete empty sessions automatically in the near future. * Lobbies will now automatically close after 3 hours for free tier users. This change will help manage resources more efficiently and ensure optimal performance for all users. **Improvements đȘ** * The default deployment port verification timeout has been increased to 30 seconds. This change will not make your deployment process longer but will prevent errors for customers with longer boot times for their containers. * We've reenabled the Oauth login for the dashboard. This change will allow you to use your Google or GitHub account to log in to the dashboard. **Fixed â** * Fixed an issue where using an invalid IP would break the deployment details page on the dashboard. * Fixed an issue where the sessions tab inside the deployment details page could not be accessed. * Fixed an issue where tooltips and guided tours on the dashboard were not working correctly upon refreshing the page. * Fixed an issue causing longer than expected loading times for the login page on the dashboard. **Documentation đ** * Expanded documentation for sessions management with Fishnet netcode integrations ([doc](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/fishnet-on-edgegap)). * Expanded documentation for sessions management with Mirror netcode integrations ([doc](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/mirror-on-edgegap)). * Added more warnings and troubleshooting steps for the managed matchmaker sample configuration. * Added more insights into the Lobby service compatibility with our services . * Added step to set autodeploy to true when using the managed matchmaker. *** ### 2024.07.24 **New âš** * We now provide both IP and FQDN of our beacons when listing them. This will allow you to choose between the two options when coding your integration. We are introducing a permissive rate limit for the API. This change aims to ensure fair usage and maintain optimal performance while providing flexibility for most use cases. **Improvements đȘ** * We've tweaked the memory usage chart on the dashboard and the API to provide more accurate data when the RAM is spiking. This will help monitor potential issues and optimize your deployments. * We've removed the automatic creation of the demo application when using the initialization button on our plugins. This behavior was causing confusion and issues when mixed with our free tier limitations. * Small consistency improvements on the dashboard UI. * Improved monitoring of our locations to ensure the best performance for your deployments. **Documentation đ** * Added an example for seat sessions management with Fishnet netcode integration ([doc](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/fishnet-on-edgegap)) *** ### 2024.07.11 **Improvements đȘ** * We updated our internal application used for the ping beacons. This update uses a more performant language, ensuring minimal application overhead for the most accurate latency measurement. Usage still remains the same, and no changes are required on your end. * We updated the pricing page on the dashboard to match the pricing page on our website. This update includes a more detailed breakdown of the features available in each tier. **Fixed â** * Fixed an issue where creating a oneClick token with the dashboard would generate the token correctly but not display it properly within the creation modal. **Documentation đ** * Added example for seat sessions management with Mirror netcode integration ([doc](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/mirror-on-edgegap)). *** ### 2024.07.03 {% hint style="warning" %} **Notice to all Matchmaker users:** As part of our ongoing efforts to enhance our infrastructure, we will be transitioning the matchmaker clusters to a new provider. This change is necessary to ensure better performance and reliability for your services. To facilitate this transition, you will need to re-release your matchmaker. The URL will remain the same, so no changes are required on that front. Please note that there will be a brief downtime of approximately 5 minutes during this process. If you wish to perform the migration using an A/B strategy, you can simply start a new matchmaker. It will be on the new cluster with a new URL. Once you replace the URL in your game clients, delete the old one. This approach minimizes any potential disruption and ensures a seamless transition. **Deadline: Please complete this transition by Friday, the 12th of July. After this date, we will re-release all matchmakers still running on the old provider.** {% endhint %} **New âš** * We've added pagination to the artifacts list on the container registry page, making it easier to view all your images. * We've added API routes to get and delete image tags from the container registry, allowing you to manage your tags directly from your scripts, CI/CD, or applications. **Fixed â** * Fixed some unexpected behavior with pagination on the dashboard tables. **Documentation đ** * Updated PlayFab matchmaker bridge documentation for Edgegap integration. ([doc](https://github.com/edgegap/docs-gitbook/blob/main/docs/playfab-bridge/README.md)). * Documentation for deleting artifact tags via API ([doc ](https://github.com/edgegap/docs-gitbook/blob/main/docs/container/edgegap-container-registry/README.md#delete-build-artifacts-via-api), [API](https://github.com/edgegap/docs-gitbook/blob/main/api/README.md#tag/Container-Registry)). * Added common error warning in the Fishnet integration example ([doc](https://github.com/edgegap/docs-gitbook/blob/main/docs/sample-projects/fishnet-on-edgegap/README.md#configure-the-client-build)). * Updated documentation links for netcode integrations with our relays ([doc](https://github.com/edgegap/docs-gitbook/blob/main/docs/distributed-relay-manager/README.md#getting-started)). *** ### 2024.06.27 {% hint style="info" %} A brief notice about our current release cycle: We are currently working on a major update to our matchmaker, focusing our efforts on improving performance, flexibility, and reliability. We're also introducing new features to make creating custom matchmaker rules easier. This explains the slower than usual amount of feature releases you might have noticed. We aim to release this update in the next quarter. Stay tuned for more information. {% endhint %} **New âš** * Day by day billing is now available for all organizations. You can now see the cost of your deployments on a daily basis. This feature is available on the billing section of the settings page. * Relay users are now automatically removed from the session when the relay detects a player has disconnected. **Fixed â** * Bug where the container logs download file was not correctly generated on the deployment details page. * Bug where free tier users could not use the sessions with our matchmaker. * Bug with the removal of a user when a lobby is started. *** ### 2024.05.06 **New âš** * The organization owner can now enable two-factor authentication (2FA) for all members of the organization. Once enabled, all members will be required to set up 2FA on their next login. * We've added a bulk delete option for application versions on the dashboard. You can now select multiple versions and delete them simultaneously. **Improvements đȘ** * The repository list on the registry page is now paginated. **Fixed â** * Bug where egress unit was not correctly displayed on the relays charts. * Bug where the one-to-one port mapping option was not correctly displayed on the port creation form. *** ### 2024.04.29 **New âš** * An option is now available to automatically scroll to the bottom of the container logs on the deployment details page. **Improvements đȘ** * Previously, the `verify_image` option could only be applied to the API route for creating an application version. Now, you can also use it with the API route for updating an application version. **Fixed â** * Fix a bug where applying a filter on dashboard table would remove the current pagination setting. * Fix a bug where it was not possible to delete an image from the dashboard repository page when there is multiple images for a same tag. *** ### 2024.04.03 **New âš** * See your upcoming billing cycle amount due directly on the dashboard. This feature is available for organization owners on the billing section of the settings page. * You can now filter the deployment list by tags directly on the dashboard. The API version will be available soon. * You can now distinctly choose between displaying your current players or Edgegap locations on the homepage map. We're currently working to make it available for your deployments as well. **Improvements đȘ** * Enhanced clarity in the matchmaker component form fields for better usability. * Provided additional insights into the subsequent steps after creating a one-click token for plugins. * Implemented various minor UI enhancements across the dashboard to improve the first-time user experience. **Fixed â** * Resolved several minor issues with layouts and forms across the dashboard. *** ### 2024.02.29 **New âš** * Owners of organizations can now add additional recipients to billing emails. This feature is available on the general settings page. * You can now select a default landing section for the deployment details page. Choose between the map, details, container logs, and charts sections to be the first one shown when opening the deployment details page. {% hint style="info" %} The \`inject\_context\_env\` option in application versions will be deprecated since context will be injected by default in all deployments. These variables are prefixed with \`ARBITRIUM\_\` and are available in the environment of the container. This will not change any behavior and **will be transparent** to the user. {% endhint %} **Improvements đȘ** * Updated messaging around relay add-ons on the tier subscription page to better explain the key differences between them and our authoritative servers offering. * Added a warning to inform users that the dashboard is less optimized for mobile devices. * Registry credentials will now be auto-filled when creating a new application version on the dashboard if you use our registry, making the process faster and less error-prone. **Fixed â** * Fixed a bug where multiple `one-click` tokens could be created instead of using the existing one with plugins. * Fixed a bug in matchmaker environment variables where value validation was too strict. Key and value are now validated based on POSIX standards. * Fixed a bug where creating a session with too many users for the available socket count with the dashboard wizard would fail without proper error message. * Fixed a bug where the colors of charts on the deployment details were not as expected. *** ### 2024.02.19 #### Special Announcement â {% hint style="info" %} Users on the Free Tier now have access to 1 CPU for their deployment, up from 0.5 CPU. Along with this change, we're also introducing a 1-hour max deployment time for Free Tier users. These changes are being introduced to make sure Free Tier users can quickly test more resource-intensive game servers on Edgegap and to ensure these resources are used more efficiently on our infrastructure. Our self-serve plans continue to offer unlimited deployment time. For more details, explore each option's expanded capacity and features on our pricing page. [View Tiers](https://app.edgegap.com/user-settings?tab=memberships) {% endhint %} **New âš** * Additional onboarding questions to help us better understand your needs and provide a more tailored experience. * The remaining time of a deployment will be shown on the deployment details and deployment list page when applicable. * Button to create a deployment from the home page. * Terminate multiple sessions directly from the session list page. **Improvements đȘ** * Added more guidance when container validation fails during application version creation. * Added more guidance for application version credentials during application version creation. * Added more guidance to create container log storage from the deployment container logs section. * Added more explanation to the application version port creation modal to help users better understand the process. **Fixed â** * Unexpected behavior on the deployment details page when using the back button. *** ### 2024.02.01 **New âš** * View the current caching status of your application versions on their details page. * Terminate multiple deployments directly from the deployment list page. **Fixed â** * Bug where the deployment details page chart, logs, and container logs were not loading correctly in some cases. * Smaller bugs and UI improvements across the dashboard. *** ### 2024.01.23 **New âš** * The modal to create policies on the fleet management page is now showing the available locations to deploy your servers. * You can now duplicate an existing application version from the dashboard, including the ports and environment variables. * You will now see at a glance on the dashboard homepage if you have any deployment in error. * The application version creation page is now showing your available images if you use the Edgegap Container Registry. **Improvements đȘ** * Colors standardization for a better experience on both light and dark mode. * Modal standardization, they will now be using the same format across the dashboard to improve the user experience. * Standardized the registry access request email to be more in line with the other emails sent by the dashboard. **Fixed â** * Bug where you could not update the port of an application version. Note that you still cannot update a port when one or more deployment are running. * Fix a typo in the pull command on the Edgegap Container Registry page.View Release Notes 2023
### 2023.12.13 **New âš** * The invoice will now include a summary of the egress and vCPU usage (grouped by size) for the month. * We will send a notification to your dashboard notification center when there's a deployment we can't cache due to misconfiguration. **Improvements đȘ** * Improved the homepage "Average Deployment Time" statistic to reflect the last 24 hours of deployments instead of the current live deployments. * You can now update your application and version names directly from the dashboard. * Minor UI tweaks to the dashboard for consistency and clarity. **Fixed â** * Resolved a bug that caused padding issues with the "Recent Deployment" chart when resizing the homepage. *** ### 2023.12.05 **New âš** * We've added JSON snippets on multiple object creation within the dashboard to help you integrate faster with our API. * A button to delete your deployment within the deployment list to help you manage your deployments faster. * Added a button to create deployment from the deployment list. You will be able to select a specific application version. **Improvements đȘ** * Added more locations to deploy your applications. * You can now click on your application version name to access the application version details page quicker from the deployment details page. * Added a new call to action on many pages displaying a list of objects. The call to action will be displayed when the list is empty. * The deployment and session modals have received some UI tweaks to be more consistent with the rest of the dashboard. It also displays a button to create a new application version if you don't have any. **Fixed â** * Fixed a small bug where the organization name was not displayed correctly on the dashboard navbar. * Fixed some weird loading behavior on the dashboard login and account creation. * Fixed a bug where sometimes the dashboard was displaying two different pages at the same time. * Fixed a bug where some pages on the dashboard were scrollable when they shouldn't be. *** ### 2023.11.29 **New âš** * Button to delete your artifacts from the container registry on the new dashboard. * Create an account with your Google or GitHub account on the new dashboard. **Improvements đȘ** * Optimization with the caching to prevent our system from automatically turning off the cache option on an invalid application version repository and image configuration. * Insights on the new dashboard when your application version container image validation fails. *** ### 2023.11.14 **New âš** * Container registry access requests now get auto-approved after successful validation. **Improvements đȘ** * Minor tweaks on the new dashboard. * Various backend optimizations to continuously improve the experience when deploying your game servers. **Fixed â** * Bug preventing the editing of registry username or token on the dashboard. * Bug causing relay sessions to end up in unintended locations or fail without clear reasons. * Bug in the API where application version names could be empty. *** ### 2023.10.25 We are back with another monumental release đ, and this time we are filling in the missing pieces to provide you with a holistic dashboard experience. Your patience and feedback have been invaluable, and we are thrilled to unveil the newly incorporated features. These additions are designed to empower you with more control and insight over your orchestration processes. Letâs dive into whatâs new! **New âš** * **Matchmaker Integration:** Optimize player experiences with our enhanced matchmaking capabilities now available right from the dashboard. Tailor matchmaking processes with configurable rulesets to meet the unique needs of your player base. * **Sessions Management:** Monitor and manage your sessions directly from the dashboard, providing you with real-time insights into player interactions. Leverage robust filtering options to sift through session data effortlessly, making deployment management a breeze. * **Smart Fleets:** Manage your fleets more intelligently with the new UI integrations, ensuring optimal resource allocation and performance. Gain a clear view of your fleet's status and performance with real-time metrics and interactive graphs. **Coming Soon đ** * **OneClick Plugin:** With just a click, deploy your game servers directly from Unity and Unreal game engines using our OneClick plugin. This integration aims to streamline the process. * **2F Auth & SSO Integration:** Enhance your security posture with Two-Factor Authentication and Single Sign-On capabilities, coming soon to the dashboard. * **And More:** Stay tuned for more updates as we continually strive to refine and expand our offerings based on your feedback. We are dedicated to providing you with a powerful, user-friendly dashboard, and these updates mark a significant stride towards that goal. Your continuous feedback is a cornerstone of our development process, and we eagerly await your thoughts on these new features. As always, thank you for your trust and partnership. Happy deploying! *** ### 2023.09.26 This release introduces a new UI interface for our Container Registry Connector and adds invoice management to your user settings. We're also excited to preview upcoming features: Smart Fleets and Sessions will soon be accessible via the UI. **New âš** * **Container Registry Connector:** Now available in the new dashboard. Offers a privately managed container repository with enhanced security, connection scans, and more. * **Invoices in User Settings:** Users can now manage and view their invoices directly from their settings. **Coming Soon đ** * **Smart Fleets:** Manage your fleets more intelligently, soon to be available in the UI. * **Sessions:** Monitor and manage your sessions directly from the UI, coming soon. *** ### 2023.08.23 đ **We're thrilled to announce the release of the completely revamped Dashboard!** It's been a while since our last release notes, and we want to take a moment to explain why. Our team has been working tirelessly on this major overhaul, focusing on delivering a set of groundbreaking features and improvements. This extended development period has allowed us to ensure that every aspect of the new dashboard meets our high standards of quality and innovation. This marks the beginning of a new journey as we fine-tune and add awesome features. We've poured our hearts and minds into this project, and we're eager to share the outcome that will undoubtedly elevate your orchestration management experience. **Major Enhancements** **Enhancing Speed, Control, and Insight đ** * **Lightning-Fast Experience:** The new dashboard has been completely restructured with a cutting-edge framework, bringing you a lightning-fast user experience. This pivotal upgrade considerably reduces loading times, helping you manage your Deployments and Applications with unprecedented efficiency. * **Advanced Sorting and Filtering Options:** Enjoy greater control and flexibility with our advanced sorting and filtering options for your Deployments and Applications. This optimized functionality will allow you to pinpoint exactly what you need, freeing up more time to focus on improving your applications. * **Real-Time Metrics and Graphs:** The console now integrates real-time metrics and interactive graphs, providing a clear view of the status and performance of your Deployments and Applications. These powerful tools will assist in your decision-making and development. * **Deployment History:** We're introducing the ability to sort and filter past deployments, providing you with a streamlined way to navigate through your deployment history. This feature will empower you to find the information you need quickly and efficiently. **Distributed P2P Relays đŒ** We're introducing Distributed Relays, an innovative distributed peer-to-peer relay network. This exciting feature raises the bar by enhancing application performance and network reliability. While the relay system itself will function regardless of the console via the API, the metrics and graphs associated with it are exclusive to the new Console. **Endpoint Storage đïž** Your container logs are now securely stored in remote S3 buckets, ensuring that logs that would previously be deleted are now saved. This robust and scalable solution enhances log management and accessibility. **Revamp to Organization and Billing đŒ** Managing your organizations and billing has never been easier. For users who upgraded in the old dashboard, you'll be pleased to know that you are grandfathered into that membership. However, switching to the new billing system could potentially lower your costs, providing an opportunity for savings. Contact our support team to transfer applications between organizations, and enjoy a more transparent and user-friendly billing experience. **Coming Soon** **New Features and Enhancements đź** * **Matchmaker**: Enhanced matchmaking capabilities for optimal player experiences. * **Container Registry**: A privately managed container repository that works much like standard public container registries, but with the added benefit of increased security, vulnerability scans, and other goodies! * **Smart Fleets**: Previously only available through the API, now accessible through the UI. * **Sessions**: Previously only available through the API, now accessible through the UI. * **2F Auth & SSO**: Increased security with two-factor authentication and single sign-on. We're continuously working on new features and improvements to provide you with the best possible experience. Stay tuned for more updates and exciting announcements in the near future! Your feedback is vital to our ongoing development, and we encourage you to share your thoughts and suggestions with us. đĄ Thank you for your continued support and partnership. Happy deploying! đ The Edgegap Team *** ### 2023.05.16 **New âš** * You can now add and remove tags to your deployment using the API. Additionally, you have the option to tag from within your deployment's container. It was previously only possible to tag from the dashboard and at the start of the deployment request. To learn more about this new feature, please refer to [this documentation](https://github.com/edgegap/docs-gitbook/blob/main/docs/deployment/tags/README.md). * You now have access to more robust filtering options for sessions and relay sessions, which function in a similar manner to the deployments filter. **Improvements đȘ** * Added new locations to deploy your applications. **Fixed â** * A correction has been made to address a mismatch in the locations. Certain locations were erroneously identified as "United States" instead of the accurate designation "United States of America." *** ### 2023.04.18 **New âš** * A feedback tool is available on almost all pages of the documentation. You can now tell us whether the information you just read was helpful or not. * We are excited to announce a new way to deploy on the edge with Edgegap distributed relays. With this update, you can now deploy relay sessions across multiple locations in our infrastructure, providing you with all the benefits of the Edgegap solution, including low latency, scalability, and easy integration. To learn more about this new feature, please refer to [this documentation](https://github.com/edgegap/docs-gitbook/blob/main/docs/distributed-relay-manager/README.md). **Improvements đȘ** * Deployments and sessions that are in an error status will be automatically deleted after a certain period of time. Currently, this is set to occur after 24 hours. Deployments or sessions in error do not have any live games or applications running, so users will not be disconnected from any server. *** ### 2023.03.07 **Improvements đȘ** * We have increased the maximum termination grace period from 180 seconds to 3600 seconds, allowing more time for post-delete processes to complete. Please note that this extended time period will be billed, even if the deployment is in a terminating state, as compute resources are still in use during this time. **Fixed â** * Bug in which the "Contact Us" button on the login page was not functioning properly, instead redirecting users back to the login page. * Bug where, when specifying container logs storage during application version creation through the API, the storage was associated but not activated by default. As a result, users had to manually activate it using the dashboard form. *** ### 2023.01.17 **New âš** * Documentation has been restructured. We aim to make integration and search for core components of the Edgegap solution easier. **Fixed â** * Bug with the Container Registry page on the dashboard where you couldn't see your images if you previously pushed the same tag twice. * The `kind` in the `session_config` key of the body of an application version creation response with the API will now be `Seat` instead of `seat` to be consistent with the parameter needed for the creation.View Release Notes 2022
### 2022.12.06 **New âš** * Organization Admins now have access to the approximate cost for the month on the billing page. **Improvements đȘ** * API Documentation has been updated with relevant titles for all the routes. * Added more locations to deploy your applications. * Our documentation for the Unity plugin has been updated according to the last version. **Fixed â** * Bug where the deployment details page was sometimes returning a 500. *** ### 2022.11.21 **New âš** * You can now override your Dockerfile *ENTRYPOINT* and *CMD* by adding commands and arguments in your application version or deployment. [link](https://github.com/edgegap/docs-gitbook/blob/main/docs/application/command-override/README.md) * Added more environment variables with your port information. It is now easier to retrieve the data without parsing a JSON string. [link](https://github.com/edgegap/docs-gitbook/blob/main/docs/deployment/injected-variables/README.md) **Improvements đȘ** * Added more locations to deploy your applications. **Fixed â** * Bug where ports were not shown correctly on the "Save as New" application version page. *** ### 2022.11.08 **New âš** * Notifications on the dashboard are now available to give users feedback and visibility of the system status. Notifications will be gradually added over the following months. **Improvements đȘ** * Improved look of the documentation homepage. * Images from the dashboard have been updated in the documentation. * Added more locations to deploy your applications. *** ### 2022.10.24 **New âš** * New location beacons that can be used to ping locations within our network to improve your matchmaking and deployment strategies. [link](https://github.com/edgegap/docs-gitbook/blob/main/docs/deployment/locations/beacons/README.md) * Bulk delete is now available from the dashboard. * 1:1 Port mapping is now available for legacy game servers or games that don't support NAT punching. [link](https://github.com/edgegap/docs-gitbook/blob/main/docs/application/one-to-one-port-mapping/README.md) * Port mapping and IP of your deployment are now accessible as environment variables from your deployed container. * Added multiple popular netcode samples and documentation to ease integration. **Fixed â** * A rare occurrence of error when accessing application version pages on the dashboard. *** ### 2022.10.11 **New âš** * Linking endpoint storage to an application version to store your logs will now be available from the API. * All admins of an organization will now be able to see its invoices. **Improvements đȘ** * Added more locations to deploy your applications. **Fixed â** * Fix the dashboard UI on the email management page. *** ### 2022.09.27 **New âš** * The billing invoice will now only contain a summary of your resource usage. You can still view a full detailed invoice from the Edgegap dashboard. **Improvements đȘ** * UI updates of the dashboard to improve the first-time user experience and application creation. * Added more locations to deploy your applications. **Fixed â** * Minor bug fixes and improvements. *** ### 2022.08.30 **New âš** * API route to get geolocation information about an IP or a list of IPs. link * The termination grace period is now customizable within the settings of an app version. Increasing it lets you gracefully terminate your application before the container is fully killed. * Best practices CICD guide to help integrate Edgegap in your development pipelines. [link](https://github.com/edgegap/docs-gitbook/blob/main/docs/tools-and-integrations/cicd-integration/README.md) **Improvements đȘ** * Added information parsing buttons in the Container Registry section for easier manipulation of registry commands. **Fixed â** * Bug where Container Registry was throwing irrelevant error message in the dashboard when application count tier limit was reached. *** ### 2022.08.16 **New âš** * Bulk delete for deployments and sessions. **Improvements đȘ** * More locations added in different parts of the world. * Deployment created by the Fleet manager will be automatically tagged with the fleet and policy name. **Fixed â** * Bug where fleet's policy with coordinates without decimal wasn't working. *** ### 2022.08.02 **New âš** * Added a default configuration when creating a new Fleet in the Fleet Manager. * Deployment storage is now available for small files (5Mb limit). **Improvements đȘ** * Dashboard UI tweaks for consistency. **Fixed â** * Bug where app version ports were not showing on the app version page. *** ### 2022.07.19 **New âš** * Fleet manager: the Deployment Scaler has been removed and replaced by the Fleet Manager. You can now create your fleets, policies, and filters which will automatically scale your Sessions at specific sites according to your configuration. [Documentation](https://github.com/edgegap/docs-gitbook/blob/main/docs/deployment/session/fleet-manager/fleet/README.md) * You can now check out Edgegap's services uptime here:View Release Notes 2021
### 2021.12.08 **New âš** * Sessions selectors for better management between session and deployment ([link](https://github.com/edgegap/docs-gitbook/blob/main/docs/deployment/session/selectors/README.md)). **Improvements đȘ** * Platform registration is now protected by reCAPTCHA. * Added more Flex Locations. **Fixed â** * Logging issue spamming an error while an application was caching. *** ### 2021.11.23 **New âš** * System will automatically disable the cache on unused app versions ([link](https://github.com/edgegap/docs-gitbook/blob/main/docs/application/version/README.md#optional-fields)). * Free swag available once registered on the platform. * Session automatic cleaner. No more need to manually delete unlinked sessions ([link](https://github.com/edgegap/docs-gitbook/blob/main/docs/deployment/session/more-in-depth/README.md#empty-time-to-live)). **Improvements đȘ** * Tier management got more simple with more insights when you need to downgrade or upgrade your tier. * You can now choose to connect automatically in your organization instead of switching each time you log in. * When switching in organization view, you will stay on the page you were on. * Organization owners can now set admins that can invite people to your organization. * Deployments logs will now indicate if you need to increase your minimal time to deploy or activate caching in case of deployment in an error state. **Fixed â** * Bug where you were unable to edit env containing "\n" for app versions and matchmakers. * Bug where JSON snippet tool in app creation form page wasn't displaying anything. Also improved its content to reflect the API validations. * Correction of some location information. *** ### 2021.11.02 **New âš** * You can now test an application deployment faster with our one-click application creation. * Access logs of a crashed container directly from the deployment page. * Upgrade HTTP and Websocket connections to HTTPS and WSS with the flip of a switch. **Improvements đȘ** * Application ports now support naming for easier retrieval. * Simplified application creation form for easier understanding. Advanced settings are still available. * We now have a C# tutorial for OpenMatch integration. * More location are available with advanced setting. **Fixed â** * Unusual caching behavior. *** ### 2021.10.05 **New âš** * Self-serve, You can now easily register and get some deployments going. However, we will always be here to help. * The sidebar showes all the new supported tech staks @ Edgegap. * Integration with a payment processor, you will have the option to pay your Edgegap Invoices in Arbitrium directly. * We integrate support with Intercom support directly on your dashboard. * Edgegap Wallet. **Improvements đȘ** * We added new edges sites with more features. * With one click, you can see the amount of credit remaining in your Edgegap wallet. **Fixed â** * Added a longer timeout in ASD. * Minor cosmetic changes. *** ### 2021.08.18 **New âš** * Ship your logs to S3 * We added a new feature that allows you to store your container logs automatically to S3 type storage. You can follow our doc to enable it on your apps. [link](https://github.com/edgegap/docs-gitbook/blob/main/docs/deployment/endpoint-storage/save-container-logs/README.md). **Improvements đȘ** * Arbitrium Open Match * Have a look at our new feature in the Matchmaker UI that is helping you troubleshoot your deployment now with Container logs. * Session-based deployment * We added more ways of doing Session-based deployment to ease your work. * The âCreate Deploymentâ Button Allow to send a Session instance for Session-Based Application **Fixed â** * Various minor bugfix and enhancements in the decision-making process. * Various updates and hardening were done on the edge computing infrastructure. * Arbitrium Webhook feature will return if the Deployment is in Error in early steps of the process. *** ### 2021.06.18 **New âš** * Arbitrium Open Match * You can now create your Matchmaker directly in the Arbitrium Dashboard. You can follow the documentation under the Arbitrium Open Match. * SDK generator in Dashboard * Increased integration between your game server and Arbitrium, you can now generate the SDK from our Dashboard. * Protection of your deployment is automatically done. * If enabled in your application configuration, Arbitrium will protect your deployment. It will be reached ONLY from IP that you allowed. * Organization support in Dashboard. * We have the support of Organizations built into your Dashboard. Invite your coworker to the Organization, then hop in and out to leverage the same account. * Deployment context in the container * We added more information in your container. When you need to have scripts in your container to display information on the location, see the documentation to get more information on this feature. * Session-based deployment * We support matches that players are getting in and out of at any given time. We will add the players in the session that is in the best location for your players. * The horizontal Deployment Session tool will make sure you always have sessions ready to onboard new players. **Improvements đȘ** * New steps when terminating a deployment * We have a new Step when stopping a deployment, Ready -> Terminating -> Terminated. * SSO in Arbitrium * We support using Okta as the Single Sign-On on all Edgegap tools. * Dashboard Tags * You can see all tags assigned to your application deployment in your deployment list. **Fixed â** * When starting new processes in your container, the display of your CPU/RAM metrics was not rendered correctly in the Dashboard. * When only one access point available, an empty IP string, the deployment was not processed correctly. *** ### 2021.04.30 **New âš** * We support Tier management by clients. * New Awesome landing page with essential stats to Studio about your deployments. * Security to the Dashboard login process. **Improvements đȘ** * You can disable port validation from the app version page. * Add the flexibility to allow more time to deploy the application before cached on the Access Points. * Caching is done passively at the Edge level now. **Fixed â** * Fixed inconstancy in ping results * Fixed typos in documentation. *** ### 2021.04.15 **New âš** * Now supporting AWS Local Zone **Improvements đȘ** * Improvements made to the console logs, it's now reflecting more what a console should look like **Fixed â** * Fixed small memory leaks * Fixed small monitoring bug * Fixed handled-error showing as error in logs *** ### 2021.03.09 **New âš** * Added the option to deploy to a specific location without taking telemetry data into account. * Added a âlock deploymentâ option if you need to have a deployment remain active. As long as a deployment is locked, the deployment cannot be killed by any requests. * Added access to more information inside our BigData repository directly from the Dashboard. * Added support for returning information to your matchmaker using a webhook. * Added the ability to create tags on your deployments to identify them more easily. **Improvements đȘ** * Improvements made to the DDOS detection for game servers. * Improvements on how we handle traffic coming into our Arbitrium platform to make it faster and more secure. * Improved the Documentation. **Fixed â** * Fixing minor bugs for stability in the backend.| Lyra Sample (Unreal Engine) |
| Top-Down Sample (Unreal Engine) |
| Single Page App Sample (NuxtJS) |
| MVC Web App Sample (Ruby on Rails) |
Game Does Not Exist (32758)
* Photon rooms require the player to be connecting to the Photon Cloud region where the deployment is located. Deploying from dashboard uses a randomized player IP.
* You may need to find the deployment's location on the map, and configure your game client in Assets / Photon / Fusion / Resources / PhotonAppSettings.asset with the matching [Photon Cloud region](https://doc.photonengine.com/fusion/current/manual/connection-and-matchmaking/regions#photon-cloud-for-gaming).
* Edgegap [deploys as close to the player as possible](https://docs.edgegap.com/learn/orchestration/deployments#id-1.-server-score-strategy-best-practice) when using our [plugins](https://docs.edgegap.com/unity/developer-tools) or [API](https://docs.edgegap.com/docs/api/dedicated-servers) so in production, setting Photon Cloud region is not required.
using System;
using System.Collections;
using System.Collections.Generic;
using Unity.BossRoom.ConnectionManagement;
using UnityEngine;
namespace Unity.Multiplayer.Samples.BossRoom
{
public class EdgegapServerStarter : MonoBehaviour
{
public string portMapName = "gameport";
// Start is called before the first frame update
void Start()
{
if (Application.isBatchMode)
{
ConnectionManager connectionManager = GameObject.Find("ConnectionManager").GetComponent<ConnectionManager>();
string internalPortAsStr = Environment.GetEnvironmentVariable($"ARBITRIUM_PORT_{portMapName.ToUpper()}_INTERNAL");
if (internalPortAsStr == null || !ushort.TryParse(internalPortAsStr, out ushort port))
{
throw new Exception($"Could not find port mapping, make sure your app version port name matches with \"{portMapName}\"");
}
connectionManager.StartHostIp("SERVER", "0.0.0.0", port);
}
}
}
}
116 public override async Task SetupHostConnectionAsync()
117 {
118 //SetConnectionPayload(GetPlayerId(), m_PlayerName); // Need to set connection payload for host as well, as host is a client too
119 var utp = (UnityTransport)m_ConnectionManager.NetworkManager.NetworkConfig.NetworkTransport;
120 utp.SetConnectionData(m_Ipaddress, m_Port);
121 }
66 async void StartHost()
67 {
...
72 // NGO's StartHost launches everything
-- //if (!m_ConnectionManager.NetworkManager.StartHost())
73 if (!m_ConnectionManager.NetworkManager.StartServer())
74 {
75 StartHostFailed();
76 }
...
112 public override void OnNetworkSpawn()
113 {
...
125 m_ServerCharacter.IsStealthy.OnValueChanged += OnStealthyChanged;
126 m_ServerCharacter.MovementStatus.OnValueChanged += OnMovementStatusChanged;
127 //OnMovementStatusChanged(MovementStatus.Normal, m_ServerCharacter.MovementStatus.Value);
...
148 ConnectStatus GetConnectStatus(ConnectionPayload connectionPayload)
149 {
...
155 //if (connectionPayload.isDebug != Debug.isDebugBuild)
156 //{
157 // return ConnectStatus.IncompatibleBuildType;
158 //}
...
