Edgegap

https://docs.edgegap.com
Admin
Edgegap is a multiplayer game server hosting and orchestration platform that deploys game servers...
Tokens:161,259
Snippets:1,525
Trust Score:9.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### Query Documentation Example

Source: https://docs.edgegap.com/docs/tools-and-integrations/container/external-registries/aws-ecr

Demonstrates how to query the documentation dynamically using an HTTP GET request with the 'ask' query parameter. Replace '<question>' with your specific query.

```http
GET https://docs.edgegap.com/docs/tools-and-integrations/container/external-registries/aws-ecr.md?ask=<question>
```

--------------------------------

### Run Nuxt.js Development Server

Source: https://docs.edgegap.com/docs/sample-projects/nuxt-on-edgegap

Verify your Nuxt.js installation by starting the development server.

```bash
C:\Users\JohnDoe\Documents\demo-nuxt-edgegap> yarn dev
```

--------------------------------

### Check Ruby Installation

Source: https://docs.edgegap.com/docs/sample-projects/ruby-on-rails

Verify that Ruby is installed correctly on your system.

```bash
ruby -v
```

--------------------------------

### Matchmaking Simple Example

Source: https://docs.edgegap.com/docs/api/integration

A basic example demonstrating matchmaking integration. This snippet is suitable for straightforward matchmaking needs.

```json
{
  "matchmakerId": "your-matchmaker-id",
  "region": "us-east-1",
  "players": [
    {
      "playerId": "player1",
      "skill": 100
    },
    {
      "playerId": "player2",
      "skill": 100
    }
  ]
}
```

--------------------------------

### Check Rails Installation

Source: https://docs.edgegap.com/docs/sample-projects/ruby-on-rails

Confirm that the Rails framework has been installed successfully.

```bash
rails -v
```

--------------------------------

### Start Rails Server (Windows)

Source: https://docs.edgegap.com/docs/sample-projects/ruby-on-rails

Start the Ruby on Rails development server on a Windows system.

```sh
ruby bin/rails server
```

--------------------------------

### Server Browser Example

Source: https://docs.edgegap.com/docs/api/integration

Example for interacting with the server browser. This snippet is used to find available game servers.

```json
{
  "region": "us-east-1",
  "filter": {
    "gameMode": "deathmatch",
    "maxPlayers": 4
  }
}
```

--------------------------------

### Start SSH Service in Entrypoint

Source: https://docs.edgegap.com/docs/tools-and-integrations/container/ssh

Starts the SSH service when the container begins its execution.

```shell
service ssh start
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.edgegap.com/docs/endpoint-storage/save-container-logs

To get more information or clarification, perform an HTTP GET request to the documentation URL with an 'ask' query parameter containing your question.

```http
GET https://docs.edgegap.com/docs/endpoint-storage/save-container-logs.md?ask=<question>
```

--------------------------------

### Start Rails Server (Linux)

Source: https://docs.edgegap.com/docs/sample-projects/ruby-on-rails

Start the Ruby on Rails development server on a Linux system.

```sh
rails server
```

--------------------------------

### Matchmaking Advanced Example

Source: https://docs.edgegap.com/docs/api/integration

An advanced example for matchmaking, offering more configuration options. Use this for complex matchmaking requirements.

```json
{
  "matchmakerId": "your-matchmaker-id",
  "region": "us-east-1",
  "players": [
    {
      "playerId": "player1",
      "skill": 100,
      "attributes": {
        "ping": 50,
        "language": "en"
      }
    },
    {
      "playerId": "player2",
      "skill": 100,
      "attributes": {
        "ping": 60,
        "language": "en"
      }
    }
  ],
  "maxWaitTime": 300,
  "minPlayers": 2,
  "maxPlayers": 4
}
```

--------------------------------

### Query Documentation via HTTP GET Request

Source: https://docs.edgegap.com/docs/tools-and-integrations/container/external-registries/gitlab-registry

To get more information not explicitly on the page, make an HTTP GET request to the documentation URL with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.edgegap.com/docs/tools-and-integrations/container/external-registries/gitlab-registry.md?ask=<question>
```

--------------------------------

### Query Documentation with HTTP GET

Source: https://docs.edgegap.com/learn/server-browser

Perform an HTTP GET request on the current page URL with the 'ask' query parameter to get dynamic information. The question should be specific and in natural language.

```http
GET https://docs.edgegap.com/learn/server-browser.md?ask=<question>
```

--------------------------------

### Example Game Client Ping Measurements

Source: https://docs.edgegap.com/learn/matchmaking/matchmaker-in-depth

Provides an example of ping measurements in milliseconds from different regions, used for ping optimization in matchmaking.

```json
{
  "Chicago": 224.4,
  "Frankfurt": 23.2,
  "Tokyo": 167.4
}
```

--------------------------------

### Agent Instructions: Querying Documentation

Source: https://docs.edgegap.com/docs/tools-and-integrations/container/good-practices

Demonstrates how to query the documentation dynamically by performing an HTTP GET request to the page URL with an 'ask' query parameter.

```http
GET https://docs.edgegap.com/docs/tools-and-integrations/container/good-practices.md?ask=<question>

```

--------------------------------

### Matchmaking Custom Lobby Example

Source: https://docs.edgegap.com/docs/api/integration

Example for creating custom lobbies during matchmaking. This allows for specific lobby configurations.

```json
{
  "matchmakerId": "your-matchmaker-id",
  "region": "us-east-1",
  "players": [
    {
      "playerId": "player1",
      "skill": 100
    },
    {
      "playerId": "player2",
      "skill": 100
    }
  ],
  "lobby": {
    "maxPlayers": 8,
    "gameMode": "capture-the-flag"
  }
}
```

--------------------------------

### Initialize Edgegap Server Starter

Source: https://docs.edgegap.com/docs/sample-projects/unity-netcodes/unity-netcode-on-edgegap

This script is added to the MainMenu scene to handle server initialization. It retrieves the port from environment variables and starts the host connection.

```csharp
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);
            }
        }
    }
}
```

--------------------------------

### Nakama values.yaml Configuration

Source: https://docs.edgegap.com/learn/advanced-features/managed-clusters

Example configuration for Nakama deployment, setting the environment to production.

```yaml
isProductionEnvironment: true
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.edgegap.com/learn

Perform an HTTP GET request on a documentation URL with the `ask` query parameter to get direct answers and relevant excerpts. The question should be specific and self-contained.

```HTTP
GET https://docs.edgegap.com/learn.md?ask=<question>
```

--------------------------------

### Query Documentation with ASK parameter

Source: https://docs.edgegap.com/docs/tools-and-integrations/container/ssh

Demonstrates how to perform an HTTP GET request to a documentation page with an 'ask' query parameter to retrieve specific information.

```http
GET https://docs.edgegap.com/docs/tools-and-integrations/container/ssh.md?ask=<question>
```

--------------------------------

### Install Rails Gem

Source: https://docs.edgegap.com/docs/sample-projects/ruby-on-rails

Install the Rails framework using the RubyGems package manager.

```bash
gem install rails
```

--------------------------------

### Backfill Example (Backfill Showcase)

Source: https://docs.edgegap.com/learn/matchmaking

This JSON snippet shows how to initiate a backfill process by specifying the profile name and providing assignment attributes. The attributes include request details, server IP, and port information, which are crucial for connecting new players to an existing game session.

```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"

```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.edgegap.com/docs/tools-and-integrations/container/external-registries/docker-hub

To get additional information not present on the page, perform an HTTP GET request to the documentation URL with an 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.edgegap.com/docs/tools-and-integrations/container/external-registries/docker-hub.md?ask=<question>
```

--------------------------------

### Dockerfile for Mirror Server

Source: https://docs.edgegap.com/docs/sample-projects/unity-netcodes/mirror-on-edgegap

This Dockerfile sets up an Ubuntu environment for a Unity Mirror game server. It installs necessary dependencies, exposes game ports, copies server files, and defines the entrypoint script. Remember to replace '[GAME PORT]' with your actual game port.

```dockerfile
FROM ubuntu:bionic
MAINTAINER <author_detail>

ARG debian_frontend=noninteractive
ARG docker_version=17.06.0-ce

RUN apt-get update && \
    apt-get install -y libglu1 xvfb libxcursor1 ca-certificates && \
    apt-get clean && \
    update-ca-certificates

EXPOSE 3389/TCP
EXPOSE [GAME PORT]/TCP
EXPOSE [GAME PORT]/UDP

COPY linux_server/ /root/linux_server/
COPY boot.sh /boot.sh

WORKDIR /root/
ENTRYPOINT ["/bin/bash", "/boot.sh"]
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.edgegap.com/docs/api/dedicated-servers

Perform an HTTP GET request to the current page URL with the 'ask' query parameter to dynamically query the documentation. Use this when the answer is not explicitly present, for clarification, or to retrieve related sections.

```http
GET https://docs.edgegap.com/docs/api/dedicated-servers.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.edgegap.com/docs/sample-projects/unreal-engine/top-down-sample

Perform an HTTP GET request on the current page URL with the `ask` query parameter to query documentation dynamically. The question should be specific, self-contained, and written in natural language.

```http
GET https://docs.edgegap.com/docs/sample-projects/unreal-engine/top-down-sample.md?ask=<question>
```

--------------------------------

### Install Nuxt.js Dependencies

Source: https://docs.edgegap.com/docs/sample-projects/nuxt-on-edgegap

Run this command in your application directory to install project dependencies using Yarn.

```bash
C:\Users\JohnDoe\Documents\demo-nuxt-edgegap> yarn
```

--------------------------------

### Example Server Policy Configuration

Source: https://docs.edgegap.com/learn/server-browser

Defines a standard server policy with essential keys like server name, password, and webhook notifications for ready and error states.

```json
{
  "name": "sb-owner-jnjnc8mid",
  "filter": "metadata.policy_name eq 'sb-owner-jnjnc8mid'",
  "deployment_request": {
    "private_host_ids": [],
    "application": "my-game-server",
    "version": "2024.01.30-16.23.00-UTC",
    "users": [
      {
        "user_type": "geo_coordinates",
        "user_data": {
          "latitude": 41.881832,
          "longitude": -87.623177
        }
      }
    ],
    "tags": ["sb-owner-jnjnc8mid"],
    "environment_variables": [
      {
        "key": "SB_POLICY_NAME",
        "value": "sb-owner-jnjnc8mid",
        "is_hidden": false
      },
      {
        "key": "SB_SERVER_PASSWORD",
        "value": "password1234",
        "is_hidden": false
      }
    ],
    "webhook_on_ready": {
      "url": "https://my-webhook.com"
    },
    "webhook_on_error": {
      "url": "https://my-webhook.com"
    },
    "webhook_on_terminated": {
      "url": "https://my-webhook.com"
    }
  },
  "minimum_active_instances": 1
}
```

--------------------------------

### Matchmaking Competitive Games Example

Source: https://docs.edgegap.com/docs/api/integration

An example tailored for competitive gaming matchmaking. It includes parameters relevant to competitive play.

```json
{
  "matchmakerId": "your-matchmaker-id",
  "region": "us-east-1",
  "players": [
    {
      "playerId": "player1",
      "skill": 1200,
      "rank": "gold"
    },
    {
      "playerId": "player2",
      "skill": 1150,
      "rank": "gold"
    }
  ],
  "teamBalancing": true
}
```

--------------------------------

### Query Documentation Index

Source: https://docs.edgegap.com/docs/sample-projects/mirror-on-edgegap

Perform an HTTP GET request to the documentation index with an 'ask' parameter to get a direct answer to a question and relevant excerpts.

```http
GET https://docs.edgegap.com/docs/sample-projects/unity-netcodes/mirror-on-edgegap.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.edgegap.com/docs/api/deprecated

To get additional information not directly present on a page, perform an HTTP GET request with the `ask` query parameter. The question should be specific and self-contained.

```http
GET https://docs.edgegap.com/docs/api/deprecated.md?ask=<question>
```

--------------------------------

### Query Documentation with 'ask' Parameter

Source: https://docs.edgegap.com/docs/tools-and-integrations/playfab-bridge

Demonstrates how to dynamically query documentation by appending an 'ask' parameter with a natural language question to the page URL via an HTTP GET request.

```http
GET https://docs.edgegap.com/docs/tools-and-integrations/playfab-bridge.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.edgegap.com/docs/sla-terms

Perform an HTTP GET request to query documentation dynamically. Include a specific, self-contained question in natural language using the 'ask' query parameter. The response will provide a direct answer with relevant excerpts and sources.

```http
GET https://docs.edgegap.com/docs/sla-terms.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.edgegap.com/docs/sample-projects/unity-netcodes/mirror-on-edgegap-websocket

Perform an HTTP GET request on the current page URL with the `ask` query parameter to get additional information not directly available on the page. The question should be specific and in natural language.

```bash
GET https://docs.edgegap.com/docs/sample-projects/unity-netcodes/mirror-on-edgegap-websocket.md?ask=<question>
```

--------------------------------

### Query Documentation Index

Source: https://docs.edgegap.com/docs/distributed-relay-manager

Perform an HTTP GET request to the documentation index with the 'ask' parameter to get a direct answer to a question. The question should be specific and self-contained.

```http
GET https://docs.edgegap.com/learn/distributed-relay.md?ask=<question>
```

--------------------------------

### Matchmaking Social Games Example

Source: https://docs.edgegap.com/docs/api/integration

An example for matchmaking in social games. Prioritizes connecting players for a casual experience.

```json
{
  "matchmakerId": "your-matchmaker-id",
  "region": "us-east-1",
  "players": [
    {
      "playerId": "player1"
    },
    {
      "playerId": "player2"
    }
  ],
  "social": true
}
```

--------------------------------

### Boot script for Unity Server

Source: https://docs.edgegap.com/docs/sample-projects/unity-netcodes/mirror-on-edgegap

This script is executed when the Docker container starts. It uses xvfb-run to launch the Unity dedicated server in headless mode. Replace '[YOUR GAME]' with the name of your generated Unity executable file.

```bash
xvfb-run --auto-servernum --server-args='-screen 0 640X480X24:32' /root/build/[YOUR GAME].x86_64 -batchmode -nographics
```

--------------------------------

### Dockerfile for Unity Game Server

Source: https://docs.edgegap.com/docs/sample-projects/unity-netcodes/mirror-on-edgegap-websocket

This Dockerfile sets up an Ubuntu environment for a Unity game server build. It installs necessary dependencies, exposes the game port, copies the server build and boot script, and defines the entry point.

```docker
FROM ubuntu:bionic
MAINTAINER <author_detail>

ARG DEBIAN_FRONTEND=noninteractive
ARG docker_version=17.06.0-ce

RUN 
    apt-get update && 
    apt-get install -y libglu1 xvfb libxcursor1 ca-certificates && 
    update-ca-certificates && 
    apt-get clean

EXPOSE 7778/TCP

COPY linux_server/  /root/linux_server/
COPY boot.sh        /boot.sh

WORKDIR /root/
ENTRYPOINT ["/bin/bash", "/boot.sh"]
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.edgegap.com/llms-full.txt

Use this method to ask specific questions about the documentation. The response includes direct answers and relevant excerpts.

```http
GET https://docs.edgegap.com/unity.md?ask=<question>
```

--------------------------------

### Install OpenSSH on Ubuntu Dockerfile

Source: https://docs.edgegap.com/docs/tools-and-integrations/container/ssh

Installs OpenSSH server and sudo, creates a user with sudo privileges, sets a password, and exposes port 22 for Ubuntu-based containers.

```dockerfile
RUN apt-get update
RUN apt-get install openssh-server sudo -y

RUN useradd -rm -d /home/ubuntu -s /bin/bash -g root -G sudo -u 1000
RUN echo 'tester:$ecureP@ss' | chpasswd

EXPOSE 22
```

--------------------------------

### Install Nginx Ingress Controller

Source: https://docs.edgegap.com/learn/advanced-features/managed-clusters

Install the nginx ingress controller to manage external access to services within your cluster.

```bash
helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
helm upgrade --install ingress-nginx ingress-nginx/ingress-nginx \
  --namespace ingress-nginx --create-namespace
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.edgegap.com/docs/ddos-protection

Perform an HTTP GET request to query the documentation dynamically. Use the 'ask' query parameter with a specific, self-contained question in natural language to get direct answers and relevant excerpts.

```http
GET https://docs.edgegap.com/docs/ddos-protection.md?ask=<question>
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.edgegap.com/learn/distributed-relay/relay-transport-samples

Demonstrates how to query the documentation dynamically by appending an 'ask' query parameter to the page URL. This is useful for retrieving specific information not explicitly present on the page.

```http
GET https://docs.edgegap.com/learn/distributed-relay/relay-transport-samples.md?ask=<question>
```

--------------------------------

### Query Documentation via GET Request

Source: https://docs.edgegap.com/learn/advanced-features/application-and-versions

Use this endpoint to ask specific questions about the documentation. The response includes direct answers and relevant excerpts.

```http
GET https://docs.edgegap.com/learn/orchestration/application-and-versions.md?ask=<question>
```

--------------------------------

### Start PlayFab Connection Attempt

Source: https://docs.edgegap.com/docs/tools-and-integrations/playfab-bridge

Initiates a connection attempt to a game server using data retrieved from PlayFab. Parses server address and port, then attempts to connect.

```csharp
bool gotConnectionInfo = false;

var requestJson = new JSON();
requestJson.Add("Keys", new List<string> { _matchID });

_requestData = new StringContent(requestJson.CreateString(), Encoding.UTF8, TypeHeaderValue);

while (!gotConnectionInfo)
{
    _request = await _playfabHttpClient.PostAsync($"https://{TitleID}.playfabapi.com/Client/GetUserData", _requestData);
    _response = await _request.Content.ReadAsStringAsync();

    if (_request.IsSuccessStatusCode)
    {
        var responseJson = JSON.ParseString(_response);
        var dataObject = responseJson.GetJSON("data").GetJSON("Data");

        if (dataObject.Count > 0)
        {
            gotConnectionInfo = true;
            string connectionInfo = dataObject.GetJSON(_matchID).GetString("Value");
            string serverAddress = connectionInfo.Split(':')[0];

            if (ushort.TryParse(connectionInfo.Split(':')[1], out ushort serverPort))
            {
                InstanceFinder.TransportManager.Transport.SetPort(serverPort);
                InstanceFinder.TransportManager.Transport.SetClientAddress(serverAddress);
                Debug.Log($"Connecting To Server Using Port {serverPort} And IP {serverAddress}");
                InstanceFinder.ClientManager.StartConnection();
            }
            else
            {
                OnUpdateButton?.Invoke(true);
                OnStatusUpdate?.Invoke($"Error While Parsing Server Port Value", true);
            }
        }
        else
        {
            OnStatusUpdate?.Invoke("No Connection Data Found, Retrying In 10 Seconds...", false);
            await Task.Delay(10000);
        }
    }
    else
    {
        gotConnectionInfo = true;
        OnUpdateButton?.Invoke(true);
        OnStatusUpdate?.Invoke($"Could Not Get Player Data, Error {(int)_request.StatusCode} With Message: 
{_response}", true);
    }
}
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.edgegap.com/learn/distributed-relay/relay-edgegap-api

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. The question should be specific and self-contained.

```http
GET https://docs.edgegap.com/learn/distributed-relay/relay-edgegap-api.md?ask=<question>
```

--------------------------------

### Install OpenSSH on Alpine Dockerfile

Source: https://docs.edgegap.com/docs/tools-and-integrations/container/ssh

Installs OpenSSH and bash, enables root login, sets a password, and exposes port 22 for Alpine-based containers.

```dockerfile
RUN apk --update add --no-cache openssh bash
RUN sed -i s/#PermitRootLogin.*/PermitRootLogin\ yes/ /etc/ssh/sshd_config
RUN echo "tester:$ecureP@ss" | chpasswd

EXPOSE 22
```

--------------------------------

### Query Documentation Index

Source: https://docs.edgegap.com/learn/advanced-features/deployments

Perform an HTTP GET request to the documentation index with the 'ask' parameter to get a direct answer to a specific question, along with relevant excerpts and sources.

```http
GET https://docs.edgegap.com/learn/orchestration/deployments.md?ask=<question>
```

--------------------------------

### Install Edgegap Unity SDK via Git URL

Source: https://docs.edgegap.com/unity/developer-tools

Use this Git URL to add the Edgegap Unity SDK to your project through the Unity Package Manager. Ensure you have Git installed.

```bash
https://github.com/edgegap/edgegap-unity-sdk.git
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.edgegap.com/docs/sample-projects/unity-netcodes/photon-fusion-on-edgegap

Use this method to ask questions about the documentation when information is not explicitly present. The question should be specific and self-contained.

```http
GET https://docs.edgegap.com/docs/sample-projects/unity-netcodes/photon-fusion-on-edgegap.md?ask=<question>
```

--------------------------------

### Backfill Configuration Example

Source: https://docs.edgegap.com/learn/matchmaking

This JSON configuration defines a matchmaking profile named 'backfill-example' that utilizes backfill functionality. It specifies ticket expiration, group inactivity periods, and matchmaking rules including match size and latency.

```json
{
  "version": "3.2.2",
  "inspect": true,
  "max_deployment_retry_count": 3,
  "profiles": {
    "backfill-example": {
      "ticket_expiration_period": "30s",
      "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": {}
      }
    }
  }
}
```

--------------------------------

### Ask a Question via GET Request

Source: https://docs.edgegap.com/api

Use this method to query the documentation index for specific information. The question should be self-contained and in natural language.

```http
GET https://docs.edgegap.com/docs/api.md?ask=<question>
```

--------------------------------

### Start Server Initialization Timeout

Source: https://docs.edgegap.com/docs/sample-projects/unity-netcodes/mirror-on-edgegap

Initiates a coroutine to wait for session list retrieval before starting individual session timeout checks. Ensures all sessions are accounted for.

```csharp
private IEnumerator StartServerInitSessionsTimeout()
    {
        while (listInProgress)
        {
            Debug.Log($"Waiting to retrieve session list...");
            yield return new WaitForSeconds(0.1f);
        }

        foreach (string sessionId in currentDeploymentSessions)
        {
            StartCoroutine(WaitForConnectionTimeout(sessionId));
        }
    }
```

--------------------------------

### GCP GCR JSON Key File Example

Source: https://docs.edgegap.com/docs/tools-and-integrations/container/external-registries/gcp-gcr

This is an example of the JSON key file generated for a GCP service account. Ensure your service account has the necessary permissions to manage your container registry.

```json
{
  "type": "service_account",
  "project_id": "project-name",
  "private_key_id": "12345abcdef12345",
  "private_key": "-----BEGIN PRIVATE KEY-----\n[...]
-----END PRIVATE KEY-----\n",
  "client_email": "example@project-name.iam.gserviceaccount.com",
  "client_id": "1234567890",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "token_uri": "https://oauth2.googleapis.com/token",
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/example%40project-name.iam.gserviceaccount.com"
}
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.edgegap.com/docs/tools-and-integrations/deploy-from-nakama

Perform an HTTP GET request to query documentation dynamically with the `ask` query parameter. Use this when the answer is not explicitly present, you need clarification, or want to retrieve related documentation.

```bash
GET https://docs.edgegap.com/docs/tools-and-integrations/deploy-from-nakama.md?ask=<question>
```

--------------------------------

### Query Documentation with 'ask' Parameter

Source: https://docs.edgegap.com/docs/tools-and-integrations/switch-from-multiplay

To get additional information not present on the current page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.edgegap.com/docs/tools-and-integrations/switch-from-multiplay.md?ask=<question>
```

--------------------------------

### Query Documentation Index

Source: https://docs.edgegap.com/docs/container/edgegap-container-registry

Use this GET request to query the documentation index with a specific question. The response will include a direct answer and relevant excerpts.

```http
GET https://docs.edgegap.com/learn/advanced-features/edgegap-container-registry.md?ask=<question>
```

--------------------------------

### Perform HTTP GET Request to Query Documentation

Source: https://docs.edgegap.com/learn/orchestration/persistence

Use this method to ask questions about the documentation. The question should be specific and self-contained. The response includes a direct answer and source excerpts.

```http
GET https://docs.edgegap.com/learn/orchestration/persistence.md?ask=<question>
```

--------------------------------

### Simple Server Browser Configuration

Source: https://docs.edgegap.com/learn/server-browser

A basic JSON configuration for the Server Browser API. Use this for simple setups.

```json
{
	"version": "1.0.0",
	"server_instances": {
		"expiration_period": "1m",
		"indices": {
			"policy_name": "string",
			"name": "string"
		}
	},
	"server_instance_slots": {
		"indices": {}
	},
	"seat_reservations": {
		"expiration_period": "30s"
	},
	"scaling_policies": {
		"monitoring_interval": "10s",
		"deployment_registration_period": "1m"
	}
}
```

--------------------------------

### Execute Docker Build Script with Version

Source: https://docs.edgegap.com/docs/tools-and-integrations/container/good-practices

Example of how to execute the docker-build.sh script, passing a specific version number as an argument. This is typically done from a CI/CD pipeline or manually.

```bash
# From your CI/CD Pipeline or manually

./docker-build.sh 2021.01.29.1234

```

--------------------------------

### Simple Example Matchmaker Configuration

Source: https://docs.edgegap.com/learn/matchmaking

This JSON configuration defines a basic matchmaker profile. Ensure the 'application.name' and 'application.version' fields accurately reflect your game's deployment settings. This configuration includes settings for ticket expiration, group inactivity, and matchmaking rules based on player count and latency.

```json
{
  "version": "3.2.2",
  "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": "<a data-footnote-ref href=\"#user-content-fn-1\">my-game-server</a>",
        "version": "<a data-footnote-ref href=\"#user-content-fn-2\">2024.01.30-16.23.00-UTC</a>"
      },
      "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": {}
      }
    }
  }
}
```

--------------------------------

### Ask a Question via GET Request

Source: https://docs.edgegap.com/docs/deployment

Use this method to query the documentation index by appending an 'ask' parameter to the URL. The question should be specific and self-contained. The response includes a direct answer and relevant excerpts.

```http
GET https://docs.edgegap.com/docs/release-notes.md?ask=<question>
```

--------------------------------

### Ask a Question via Documentation Index

Source: https://docs.edgegap.com/learn/unreal-engine-games/developer-tools

Use this GET request to query the documentation index with a natural language question. The response includes direct answers and relevant excerpts.

```http
GET https://docs.edgegap.com/unreal-engine/developer-tools.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.edgegap.com/learn/advanced-features/china-gateway

Use this method to dynamically query the documentation. Include a specific, self-contained question in natural language as the value for the 'ask' query parameter.

```http
GET https://docs.edgegap.com/learn/advanced-features/china-gateway.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.edgegap.com/docs/sample-projects/unity-netcodes/unity-netcode-on-edgegap

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query documentation. The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

```http
GET https://docs.edgegap.com/docs/sample-projects/unity-netcodes/unity-netcode-on-edgegap.md?ask=<question>
```

--------------------------------

### Querying Documentation

Source: https://docs.edgegap.com/docs/api

You can dynamically query this documentation by performing an HTTP GET request with the `ask` query parameter.

```APIDOC
# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.edgegap.com/docs/api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
```

--------------------------------

### Generate Controller and View (Windows)

Source: https://docs.edgegap.com/docs/sample-projects/ruby-on-rails

Generate a controller and its associated view for the 'HelloWorld' resource on Windows, skipping route generation.

```bash
ruby bin/rails generate controller HelloWorld index --skip-routes
```

--------------------------------

### Matchmaker Configuration Example

Source: https://docs.edgegap.com/learn/matchmaking/matchmaker-in-depth

This JSON defines the core matchmaking rules and attributes, including team size, latency preferences, and selected game modes. It serves as a base configuration for a matchmaking profile.

```json
{
  "version": "3.2.2",
  "inspect": true,
  "max_deployment_retry_count": 3,
  "profiles": {
    "my-profile": {
      "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": 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
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### Perform HTTP GET Request to Query Documentation

Source: https://docs.edgegap.com/learn/orchestration/ping-beacons

Use this method to dynamically query the documentation. The question should be specific, self-contained, and in natural language. The response will include a direct answer and relevant excerpts.

```http
GET https://docs.edgegap.com/learn/orchestration/ping-beacons.md?ask=<question>
```

--------------------------------

### Generate Controller and View (Linux)

Source: https://docs.edgegap.com/docs/sample-projects/ruby-on-rails

Generate a controller and its associated view for the 'HelloWorld' resource, skipping route generation as it's manually defined.

```bash
rails generate controller HelloWorld index --skip-routes
```

--------------------------------

### Perform HTTP GET Request to Query Documentation

Source: https://docs.edgegap.com/unreal-engine

Use this method to dynamically query the documentation when information is not explicitly present or requires clarification. The question should be specific and self-contained.

```http
GET https://docs.edgegap.com/unreal-engine.md?ask=<question>
```

--------------------------------

### boot.sh for Unity Game Server

Source: https://docs.edgegap.com/docs/sample-projects/unity-netcodes/mirror-on-edgegap-websocket

This script is used as the entry point for the Docker container. It utilizes xvfb to run the Unity game server in headless mode with a virtual framebuffer.

```bash
xvfb-run --auto-servernum --server-args='-screen 0 640x480x24:32' /root/linux_server/[YOUR GAME].x86_64 -batchmode -nographics
```

--------------------------------

### Backfill Assignment Example

Source: https://docs.edgegap.com/learn/matchmaking

This JSON object demonstrates a backfill assignment, including profile information, request details, port assignments, location data, and ticket information for players. It shows the structure of a successful host assignment for a backfill scenario.

```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"
  }
}
```

--------------------------------

### Ask a Question via HTTP GET

Source: https://docs.edgegap.com/docs/deployment/endpoint-storage

Use this method to query the documentation index for specific information. The question should be self-contained and in natural language. The response includes a direct answer and relevant excerpts.

```http
GET https://docs.edgegap.com/docs/endpoint-storage.md?ask=<question>
```

--------------------------------

### Docker build, login, tag, and push commands (Windows CMD)

Source: https://docs.edgegap.com/docs/sample-projects/unity-netcodes/mirror-on-edgegap

These commands are used to build the Docker image, log in to a container registry, tag the image for the registry, and push it. Ensure you replace placeholders like <IMAGE_NAME>, <IMAGE_VERSION>, '<REGISTRY_USERNAME>', and '<REGISTRY_URL>' with your specific details.

```cmd
# build the image
docker build . -t <IMAGE_NAME>:<IMAGE_VERSION>

# login, a prompt will ask the password
docker login -u <REGISTRY_USERNAME> <REGISTRY_URL>

# add another tag to your image corresponding to the registry
docker image tag <IMAGE_NAME>:<IMAGE_VERSION> <REGISTRY_URL>/<PROJECT_NAME>/<IMAGE_NAME>:<IMAGE_VERSION>

#push the image
docker push <REGISTRY_URL>/<PROJECT_NAME>/<IMAGE_NAME>:<IMAGE_VERSION>
```

--------------------------------

### Query Documentation API

Source: https://docs.edgegap.com/docs/endpoint-storage/upload-files

Perform an HTTP GET request to this endpoint with the 'ask' query parameter to dynamically query the documentation. This is useful for retrieving information not explicitly present on the current page or for clarification.

```http
GET https://docs.edgegap.com/docs/endpoint-storage/upload-files.md?ask=<question>
```

--------------------------------

### Install Cert-Manager Helm Chart

Source: https://docs.edgegap.com/learn/advanced-features/managed-clusters

Install cert-manager to manage TLS certificates for your cluster. This is required for HTTPS.

```bash
helm repo add jetstack https://charts.jetstack.io --force-update;
helm upgrade --install cert-manager jetstack/cert-manager \
  --namespace cert-manager --create-namespace \
  --version v1.16.1 --set crds.enabled=true;
```

--------------------------------

### Advanced Example Variables

Source: https://docs.edgegap.com/learn/matchmaking/matchmaker-in-depth

These environment variables are injected into your server deployment, providing details about the match, tickets, groups, and teams. They are stored as stringified JSONs and require parsing.

```shell
MM_MATCH_PROFILE=advanced-example
MM_EXPANSION=initial
MM_TICKET_IDS=["cusfn10msflc73beiik0","cusfn18msflc73beiil0"]
MM_TICKET_cusfn10msflc73beiik0={"id":"cusfn10msflc73beiik0","created_at":"2025-02-21T22:17:42.3886970Z","player_ip":"174.93.233.25","group_id":"b2080c27-19c9-4fb0-8fe7-4bf1e5d285d1","team_id":"cusfn1gmsflc73beiim0","attributes":{"beacons":{"Chicago":12.3,"LosAngeles":145.6,"Tokyo":233.2},"elo_rating":1337,"selected_game_mode":"quickplay","selected_map":["DustII","Airport","BankVault"],"backfill_group_size":["new","1"]}}
MM_TICKET_cusfn18msflc73beiil0={"id":"cusfn18msflc73beiil0","created_at":"2025-02-21T22:17:42.2548390Z","player_ip":"174.93.233.23","group_id":"015d4dc8-6c79-4b5c-bbc6-f309b9787c8f","team_id":"cusfn1gmsflc73beiim0","attributes":{"beacons":{"Chicago":87.3,"LosAngeles":32.4,"Tokyo":253.2},"elo_rating":1339,"selected_game_mode":"quickplay","selected_map":["Island","Airport"],"backfill_group_size":["new","1"]}}
MM_GROUPS={"b2080c27-19c9-4fb0-8fe7-4bf1e5d285d1":["cusfn10msflc73beiik0"],"015d4dc8-6c79-4b5c-bbc6-f309b9787c8f":["cusfn18msflc73beiil0"]}
MM_TEAMS={"cusfn1gmsflc73beiim0":["b2080c27-19c9-4fb0-8fe7-4bf1e5d285d1","015d4dc8-6c79-4b5c-bbc6-f309b9787c8f"]}
MM_MATCH_ID=advanced-example_initial-2025-02-21T22:17:43.3886970Z
MM_INTERSECTION={"selected_map":["Airport"],"backfill_group_size":["new","1"]}
MM_EQUALITY={"selected_game_mode":"quickplay"}
```

--------------------------------

### Example .dockerignore File for Server Builds

Source: https://docs.edgegap.com/unreal-engine

This .dockerignore file helps to exclude unnecessary compiled files, precompiled headers, dynamic and static libraries, executables, project files, precompiled assets, and build artifacts from the Docker image. It also includes specific rules to whitelist certain files like PakBlacklist text files and icon files within the Build directory, while excluding intermediate and saved directories.

```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-<BuildConfiguration>.txt files
!**/Build/*/ 
**/Build/*/**
!**/Build/*/PakBlacklist*.txt

# Don't ignore icon files in Build
!**/Build/**/*.ico

# Configuration files generated by the Editor
**/Saved/*
**/Intermediate/*
**/DerivedDataCache/*
**/Binaries/*
**/Build/*
**/Releases/*
**/Packaged/*
```

--------------------------------

### Initialize PlayFab Service on Client

Source: https://docs.edgegap.com/docs/tools-and-integrations/playfab-bridge

Initializes the PlayFab REST API service and removes player data when the client starts. Ensure PlayfabRestApiService is present in the scene.

```csharp
public class PlayerDataUpdateService : NetworkBehaviour
{
    private PlayfabRestApiService _playfabService;

    ... 

    public override void OnStartClient()
    {
        _playfabService = FindObjectOfType<PlayfabRestApiService>();
        _playfabService.RemovePlayerData();
    }
}
```

--------------------------------

### Example ARBITRIUM_DEPLOYMENT_LOCATION JSON

Source: https://docs.edgegap.com/learn/orchestration/deployments

This environment variable contains stringified JSON with detailed information about the deployment's location, including city, country, continent, administrative division, timezone, latitude, and longitude.

```json
ARBITRIUM_DEPLOYMENT_LOCATION="{
  "city": "Montreal",
  "country": "Canada",
  "continent": "North America",
  "administrative_division": "Quebec",
  "timezone": "Eastern Time",
  "latitude": 45.513707,
  "longitude": -73.619073
}"
```

--------------------------------

### Matchmaking Cooperative Games Example

Source: https://docs.edgegap.com/docs/api/integration

Example for matchmaking in cooperative games. Focuses on grouping players for a shared objective.

```json
{
  "matchmakerId": "your-matchmaker-id",
  "region": "us-east-1",
  "players": [
    {
      "playerId": "player1",
      "skill": 800
    },
    {
      "playerId": "player2",
      "skill": 850
    }
  ],
  "cooperative": true
}
```

--------------------------------

### Example ARBITRIUM_PORTS_MAPPING JSON

Source: https://docs.edgegap.com/learn/orchestration/deployments

This environment variable contains stringified JSON detailing the mapping of internal and external ports for the deployment, including their names, internal and external numbers, and protocols.

```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"
    }
  }
}"
```
Tokens:
Raw