> For the complete documentation index, see [llms.txt](https://docs.edgegap.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.edgegap.com/docs.edgegap.com-fr/learn/server-browser.md).

# Server Browser

Commencez rapidement avec Server Browser et explorez des scénarios d'exemple pour divers genres.

Server Browser est un service géré pour [Déploiements](/docs.edgegap.com-fr/learn/orchestration/deployments.md#match-bound) et [Persistants](/docs.edgegap.com-fr/learn/orchestration/persistance.md) serveurs :

* **aider les joueurs à rechercher et à rejoindre les serveurs appropriés** en fonction de la capacité, de la latence ou des paramètres de jeu ;
* **préchauffer les nouveaux serveurs** afin de servir des audiences mondiales à grande échelle et d'éviter des files d'attente frustrantes ;
* **simplifier les opérations serveur** notamment les mises à jour, les redémarrages, la persistance, le meshing, et plus encore.

{% hint style="success" %}
Vous cherchez à faire correspondre les joueurs selon des règles strictes, sans leur permettre de choisir un serveur ? Envisagez [Matchmaking](/docs.edgegap.com-fr/learn/matchmaking.md).
{% endhint %}

## ✔️ Préparation

### Fonctions et flux

<figure><img src="/files/95fe1d252b52c4a91d58b828c15b5f2a2160329f" alt=""><figcaption><p>Server Browser : flux et hiérarchie</p></figcaption></figure>

Server Browser offre deux fonctionnalités principales :

[#start-browsing](#start-browsing "mention") avec les clients de jeu pour :

* Découvrir et trouver des instances de serveur appropriées, voir les emplacements et réserver la capacité disponible.
* Réserver des places dans un emplacement d'instance, récupérer les détails de connexion et se connecter aux serveurs.
* Authentifier les connexions des joueurs dans les déploiements à l'aide de [Identité fédérée](#user-content-fn-1)[^1].
* Mettre à jour la capacité disponible et/ou les métadonnées des emplacements d'instance afin de modifier les critères de découverte.

[#automated-scaling](#automated-scaling "mention") (facultatif) avec les politiques de mise à l'échelle pour :

* Surveiller les instances de serveur, les emplacements et la capacité disponibles - par région et/ou selon d'autres critères.
* Déployer des serveurs pour augmenter la capacité grâce au préchauffage ou à la mise à l'échelle juste-à-temps.
* Automatiser les opérations avec des politiques spéciales pour les démos, les mises à jour, les tests, l'assurance qualité, les tournois, et plus encore.

{% hint style="info" %}
Après la publication, **votre navigateur de serveurs devra fonctionner 24 h/24 et 7 j/7** pour garantir que les joueurs du monde entier puissent rejoindre les serveurs.
{% endhint %}

## ▶️ Commencer la navigation

Découvrez le cycle de vie serveur/joueur et leurs responsabilités afin d'assurer une utilisation efficace des serveurs.

### Authentifier

Server Browser génère automatiquement deux types de jetons :

* **Jeton serveur** - requis pour [API serveur](#server-lifecycle) méthodes, peut être [injecté comme variable de version de l'application](/docs.edgegap.com-fr/learn/orchestration/application-and-versions.md#injected-variables).
  * Accorde l'accès à toutes les méthodes de l'API et est pratique pour les tests, le DevOps ou l'orchestration personnalisée.
* **Jeton client** - requis pour [API de surveillance et API de réservation de places](#player-lifecycle) utilisé par les clients de jeu.
  * Nous recommandons de stocker ce jeton dans un coffre-fort de secrets tiers afin de faciliter la rotation des jetons.

### Découvrir une instance

{% hint style="warning" %}
**Nouveau** [Déploiements](/docs.edgegap.com-fr/learn/orchestration/deployments.md) **doit créer une nouvelle instance** lorsqu'elle est initialisée pour suivre la capacité ajoutée.
{% endhint %}

{% hint style="info" %}
Voir [#automated-scaling](#automated-scaling "mention") pour en savoir plus sur les politiques de mise à l'échelle et lancer automatiquement les déploiements.
{% endhint %}

**Informations requises** pour chaque instance de serveur comprend :

* au moins un emplacement défini lors de l'initialisation de l'instance,
* les détails de connexion au serveur - URL, IP, informations de port et emplacement.

**Paramètres de métadonnées personnalisées facultatifs** pour filtrer, trier et parcourir les joueurs ; par exemple :

* informations d'emplacement - capacité d'équipe et métadonnées spécifiques à l'équipe (par ex. nom de l'équipe),
* nom et balises - libellés personnalisables, uniques, lisibles par l'humain et recherchables ;
* données de compatibilité - version du serveur ou versions client prises en charge ;
* qualificatifs de latence - identifiants de ville et de région, et [Balises Ping](/docs.edgegap.com-fr/learn/orchestration/ping-beacons.md) détails attribués ;
* paramètres de jeu - niveau/scène/carte, mode de jeu, difficulté, mods utilisés ;
* tout autre paramètre personnalisé pour aider les joueurs à filtrer et à trouver un serveur approprié.

{% hint style="info" %}
Les paramètres de métadonnées ci-dessus ne sont que des exemples ; vous pouvez définir autant de paramètres que nécessaire.
{% endhint %}

{% hint style="success" %}
Pour sérialiser des objets imbriqués, essayez d'encoder leur chemin d'accès dans la clé comme `"object.child.property"`.
{% endhint %}

Les serveurs peuvent **mettre à jour les métadonnées de l'instance ou de l'emplacement à tout moment** pour modifier leurs critères de découvrabilité. Lors de la mise à jour des métadonnées, toutes les clés indexées doivent être fournies avec des valeurs valides (même si elles ne sont pas modifiées).

**Les instances de serveur doivent envoyer périodiquement un battement de cœur de maintien en vie** pour vérifier leur disponibilité continue et empêcher les joueurs de rejoindre des serveurs plantés ou hors ligne. L'absence de battement de cœur pendant la période d'expiration configurée supprimera automatiquement l'instance et toute réservation de place en attente.

{% hint style="info" %}
Voir [Persistance](/docs.edgegap.com-fr/learn/orchestration/persistance.md) pour gérer l'état persistant du monde et [Applications et versions](/docs.edgegap.com-fr/learn/orchestration/application-and-versions.md#active-caching) pour des déploiements plus rapides.
{% endhint %}

### Allouer la capacité

La capacité de l'instance et de l'emplacement peut être allouée de deux façons, utilisées individuellement ou combinées :

* [#auto-assigned-reservation](#auto-assigned-reservation "mention") pour choisir un serveur lancé avec une politique de mise à l'échelle spécifique,
* [#search-and-browse](#search-and-browse "mention") pour permettre au joueur de définir des filtres et de parcourir des serveurs appropriés parmi lesquels choisir.

{% hint style="success" %}
Nous recommandons de commencer par [#auto-assigned-reservation](#auto-assigned-reservation "mention") comme option la plus simple.
{% endhint %}

#### Réservation attribuée automatiquement

{% hint style="info" %}
Implémentez cette fonctionnalité si vous souhaitez **choisir automatiquement un serveur**, en fonction de la capacité régionale.
{% endhint %}

Les joueurs peuvent créer une réservation attribuée automatiquement, en ne fournissant que les identifiants des joueurs et le nom d'une politique de mise à l'échelle. Server Browser trouvera automatiquement une instance avec un emplacement offrant une capacité de participation suffisante et réservera des places, en répondant immédiatement avec les détails de connexion de l'instance.

S'il n'existe aucun emplacement d'instance approprié pour cette réservation, la réponse :

* **le code d'état indique si la politique est en train d'augmenter la capacité** et davantage de capacité sera ajoutée,
* **en-tête `Retry-After`  indique la période d'attente (en secondes) avant une nouvelle tentative**, si une nouvelle tentative est possible.

Une fois la réservation terminée, vous pouvez passer à [#connect-to-server](#connect-to-server "mention").

#### Rechercher et parcourir

{% hint style="info" %}
Implémentez cette fonctionnalité si vous souhaitez **afficher aux utilisateurs une liste de serveurs et permettre des réservations personnalisées**.
{% endhint %}

Les joueurs peuvent lister des instances de serveur et [parcourir les résultats par pages](#pagination) pour trouver un serveur qu'ils aimeraient rejoindre.

Les instances et les emplacements peuvent être filtrés et triés avec des paramètres intégrés ou [des métadonnées indexées](#configuration):

<table><thead><tr><th width="400">Propriété</th><th width="140">Type de données</th><th width="105">Instance</th><th width="105">Emplacement</th></tr></thead><tbody><tr><td><code>request_id</code></td><td><code>chaîne</code></td><td>✅</td><td>❌</td></tr><tr><td><code>total_joinable_seats</code>, <code>total_available_seats</code></td><td><code>entier</code></td><td>✅</td><td>❌</td></tr><tr><td><code>name</code></td><td><code>chaîne</code></td><td>❌</td><td>✅</td></tr><tr><td><code>available_seats</code>, <code>reserved_seats</code></td><td><code>entier</code></td><td>❌</td><td>✅</td></tr><tr><td><code>created_at</code>, <code>updated_at</code></td><td><code>chaîne</code></td><td>✅</td><td>✅</td></tr><tr><td><code>metadata.{index}</code> (personnalisé)</td><td><code>chaîne</code>, <code>entier</code>, <code>flottant</code>, <code>booléen</code></td><td>✅</td><td>✅</td></tr></tbody></table>

Les opérateurs de filtrage disponibles dépendent du type de données de la propriété filtrée :

<table><thead><tr><th width="125">Paramètre</th><th width="135">Opérateurs</th><th>Filtre d'exemple (basé sur l'exemple simple)</th></tr></thead><tbody><tr><td><code>chaîne</code></td><td><p><a data-footnote-ref href="#user-content-fn-2"><code>eq</code></a>  ou <a data-footnote-ref href="#user-content-fn-3"><code>ne</code></a> ou </p><p><a data-footnote-ref href="#user-content-fn-4"><code>lt</code></a>  ou <a data-footnote-ref href="#user-content-fn-5"><code>le</code></a> ou </p><p><a data-footnote-ref href="#user-content-fn-6"><code>gt</code></a>  ou <a data-footnote-ref href="#user-content-fn-7"><code>ge</code></a>  ou<br><code>contient</code></p></td><td><pre><code>?$filter=metadata.custom_name contains 'my game'
and metadata.server_version le '1.1.0'
and metadata.server_version ge '1.0.0'
&#x26;$order=metadata.custom_name asc
</code></pre></td></tr><tr><td><code>entier</code>, <code>flottant</code></td><td><p><a data-footnote-ref href="#user-content-fn-2"><code>eq</code></a>  ou <a data-footnote-ref href="#user-content-fn-3"><code>ne</code></a> ou </p><p><a data-footnote-ref href="#user-content-fn-4"><code>lt</code></a>  ou <a data-footnote-ref href="#user-content-fn-5"><code>le</code></a> ou </p><p><a data-footnote-ref href="#user-content-fn-6"><code>gt</code></a>  ou <a data-footnote-ref href="#user-content-fn-7"><code>ge</code></a>  </p></td><td><pre><code>?$filter=metadata.xp_multiplier gt 1.0
&#x26;$order=metadata.xp_multiplier desc
</code></pre></td></tr><tr><td><code>booléen</code></td><td><a data-footnote-ref href="#user-content-fn-2"><code>eq</code></a>  ou <a data-footnote-ref href="#user-content-fn-3"><code>ne</code></a></td><td><pre><code>?$filter=metadata.allows_new_connections eq true
</code></pre></td></tr></tbody></table>

{% hint style="success" %}
Filtrez les métadonnées des régions et/ou des villes pour réduire la sélection avant de mesurer la latence des serveurs.
{% endhint %}

{% hint style="info" %}
Découvrez le fonctionnement basé sur un curseur [#pagination](#pagination "mention") pour permettre aux utilisateurs de récupérer davantage de résultats.
{% endhint %}

#### Réserver des places

Avant de rejoindre un serveur, une réservation de place est requise pour garantir que l'instance offre une capacité disponible suffisante. Les réservations peuvent inclure un groupe de joueurs ou une personne seule.

Identité fédérée : les joueurs doivent fournir un identifiant unique de joueur tiers dans leur réservation. En envoyant le même identifiant une fois qu'ils [#connect-to-server](#connect-to-server "mention") auront permis au serveur de vérifier leur identité.

Une fois qu'une réservation est effectuée avec succès ([200 OK](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/200)) les joueurs doivent tenter de se connecter immédiatement. En attente **les réservations expirent après 30 secondes (configurable) sauf confirmation** par votre serveur.

**Les réservations dépassant la capacité de places joignables de l'emplacement seront automatiquement rejetées** ([409 Conflict](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/409)). Les places joignables sont toutes les places disponibles qui n'ont pas encore été réservées par d'autres joueurs.

{% hint style="info" %}
Le serveur peut forcer la modification de la capacité de n'importe quel emplacement, ajouter, supprimer ou mettre à jour n'importe quels emplacements. **Toutes les réservations pour un emplacement donné seront supprimées si des réservations en attente dépassent la nouvelle capacité disponible de l'emplacement.**
{% endhint %}

### Se connecter au serveur

Une fois qu'un joueur a trouvé une instance appropriée, il **récupère les détails de connexion requis depuis** (URL ou IP, [Port externe](/docs.edgegap.com-fr/learn/orchestration/application-and-versions.md#port-mapping)). Dès que la réservation de place est effectuée, **les joueurs peuvent se connecter au serveur de jeu de votre déploiement et transmettre leur identifiant de joueur**.

{% tabs %}
{% tab title="Unreal Engine" %}
Pour **se connecter depuis PIE (éditeur)** pendant le développement et les tests, appuyez sur la touche tilde `~`  et tapez `open {URL}:{port}` et attendez que votre éditeur charge la carte.

{% hint style="success" %}
En cas d'échec de connexion ou d'écran noir, consultez notre [guide de dépannage](/docs.edgegap.com-fr/unreal-engine.md#troubleshooting-and-faq-1).
{% endhint %}
{% endtab %}

{% tab title="Unity" %}
Pour **connectez votre éditeur Unity** ou **client de jeu** à votre déploiement cloud, saisissez :

* **Déploiement** **URL** pointant vers l'IP du serveur, généralement dans le `NetworkManager`  composant.
* **Port externe** mappé vers le [port d'écoute interne du serveur](https://docs.edgegap.com/learn/advanced-features/application-and-versions#port-mapping), généralement dans un composant Transport.

{% hint style="success" %}
En cas de délai de connexion dépassé ou d'autres problèmes, consultez notre [guide de dépannage](/docs.edgegap.com-fr/unity.md#troubleshooting-and-faq-4).
{% endhint %}
{% endtab %}
{% endtabs %}

Pour authentifier de nouvelles connexions, **votre serveur doit envoyer une confirmation de réservation en bloc** avec tous les identifiants des nouveaux joueurs, en recevant les informations dans la réponse de confirmation :

* affectation des réservations de joueurs acceptées à leur emplacement préféré,
* affectation des réservations de joueurs expirées à leur emplacement préféré,
* une liste d'identifiants de joueurs inconnus.

Votre **serveur peut décider comment traiter chaque groupe de joueurs** et s'il faut autoriser ou expulser/bannir les utilisateurs expirés ou rejetés. Chacun des **emplacements de l'instance doit être mis à jour immédiatement avec le nouveau nombre de places disponibles** afin de garantir que les réservations futures ne dépasseront pas la capacité de l'emplacement.

### Abandonner le serveur

Lorsque les joueurs quittent la partie, votre serveur doit augmenter la capacité de places disponibles pour l'emplacement attribué.

{% hint style="success" %}
Si la conception de votre jeu autorise une période de reconnexion, votre serveur peut attendre avant de mettre à jour les emplacements.
{% endhint %}

En savoir plus sur [Persistance](/docs.edgegap.com-fr/learn/orchestration/persistance.md#recovery-objectives) pour éviter des retours arrière persistants frustrants du serveur.

## 🚀 Mise à l'échelle automatique

Server Browser est compatible avec plusieurs méthodes différentes de mise à l'échelle automatique :

* **méthode de préchauffage** - démarrer les serveurs uniquement avec des politiques de mise à l'échelle Server Browser,
* **méthode juste-à-temps** - démarrer via [Matchmaking](/docs.edgegap.com-fr/learn/matchmaking.md) et [remplir avec Server Browser](#allocate-capacity),
* **autoscaler personnalisé** - démarrer via un backend de jeu personnalisé et [remplir avec Server Browser](#allocate-capacity).

Le guide suivant se concentrera sur **le préchauffage avec des politiques de mise à l'échelle** comme méthode principale.

{% hint style="success" %}
Découvrez comment arrêter les déploiements dans [Unreal Engine](/docs.edgegap.com-fr/unreal-engine.md#stop-deployments), [Unity](/docs.edgegap.com-fr/unity.md#stop-deployments), ou [avec l'API](/docs.edgegap.com-fr/docs/api/serveurs-dedies.md#delete-v1-self-stop-request_id-access_point_id) pour gérer le cycle de vie de manière fiable.
{% endhint %}

### Surveiller la capacité

Les politiques de mise à l'échelle actualisent en continu la liste de vos instances de serveur (déploiements découverts), en se répétant toutes les [`monitoring_interval`](#user-content-fn-8)[^8] . Chaque politique nécessite un filtre utilisant la même [syntaxe de filtrage](#search-and-browse) que celle utilisée par les joueurs lorsqu'ils recherchent des instances - par région, capacité ou autres critères.

Votre [`minimum_active_instances`](#user-content-fn-9)[^9]  montant peut être considéré soit comme une :

* **capacité fixe** de déploiements que vous souhaitez maintenir en fonctionnement en permanence,
* **veille préchauffée** tampon de déploiement pour masquer les délais d'initialisation.

#### Capacité fixe

Conservez un nombre fixe de serveurs actifs pour les jeux avec [Persistance](/docs.edgegap.com-fr/learn/orchestration/persistance.md), en particulier lorsque ces jeux offrent aux joueurs la possibilité de provisionner [Persistance](/docs.edgegap.com-fr/learn/orchestration/persistance.md#community-servers).

Ce type de configuration de politique est également parfois utilisé pour l'assurance qualité, les tournois, les alphas fermées, les démos d'éditeur ou d'autres types d'événements et d'opérations à capacité limitée.

{% hint style="info" %}
Une politique de mise à l'échelle vous aide à redémarrer et à recycler automatiquement les serveurs plantés à la volée.
{% endhint %}

#### Veille préchauffée

Démarrez les serveurs avant la demande des joueurs si :

* vous lancez une grande sortie et vous attendez un afflux rapide de joueurs sur une courte période,
* ou l'initialisation du serveur nécessite plus de 30 secondes ([sans compter le temps de déploiement](#user-content-fn-10)[^10]),
* ou le jeu met en œuvre des stratégies de maillage nécessitant des dépendances réseau en couches ou circulaires.

### Déployer des serveurs

De nouveaux déploiements seront lancés automatiquement lorsque la quantité d'instances de serveur surveillées*s* tombe en dessous du minimum configuré d'instances actives. Tous les déploiements sont demandés immédiatement et réessayés indéfiniment à chaque intervalle de surveillance après [`deployment_registration_period`](#user-content-fn-8)[^8]  écoulé.

{% hint style="warning" %}
Vérifiez que les nouveaux déploiements [effectuent l'auto-découverte et créent des instances](#discover-instance) correspondant correctement à votre filtre de politique, sinon **votre politique peut boucler indéfiniment et créer de grandes quantités de déploiements inutilisés**!&#x20;
{% endhint %}

Les politiques lancent les déploiements avec [Flottes privées](/docs.edgegap.com-fr/learn/orchestration/flottes-privees.md) (avec Overflow to Cloud) ou directement vers Cloud.

Les paramètres disponibles incluent ([voir la spécification de l'API](/docs.edgegap.com-fr/docs/api/serveurs-dedies.md#private-fleets)):

* [**application et version**](/docs.edgegap.com-fr/learn/orchestration/application-and-versions.md) - version de build, ressources et autres paramètres d'orchestration,
* **utilisateurs** - un seul ensemble de coordonnées géographiques pour le [placement du serveur](/docs.edgegap.com-fr/learn/orchestration/deployments.md#regional-standby),
* [**identifiants d'hôtes privés**](/docs.edgegap.com-fr/learn/orchestration/flottes-privees.md) - laisser vide pour le cloud, ou spécifier des hôtes dans la région souhaitée,
* [**balises**](/docs.edgegap.com-fr/learn/orchestration/deployments.md#dashboard-monitoring) - baliser avec le nom de la politique pour retrouver plus tard les déploiements lancés avec cette politique,
* [**variables d'environnement**](/docs.edgegap.com-fr/learn/orchestration/deployments.md#custom-variables) - transmettre des paramètres personnalisés et des secrets aux serveurs,
* [**webhooks**](/docs.edgegap.com-fr/learn/orchestration/deployments.md#webhooks-and-postbacks) - notifier votre backend de jeu (ou votre matchmaker) des événements du cycle de vie des déploiements,
* [**exiger des emplacements mis en cache**](/docs.edgegap.com-fr/learn/orchestration/application-and-versions.md#active-caching) - si vous préférez des déploiements plus rapides uniquement dans des emplacements mis en cache.

### Exemples de politiques

Testez et modifiez chacune de ces politiques selon vos besoins. La plupart des jeux utiliseront plusieurs politiques.

{% tabs %}
{% tab title="🍀 Pool QA" %}
Une politique simple pour maintenir en permanence un serveur déployé pour les tests.

<pre class="language-json" data-title=""><code class="lang-json">{
  "name": "sb-qa-pool",
<strong>  <a data-footnote-ref href="#user-content-fn-11">"filter"</a>: "metadata.policy_name eq 'sb-qa-pool'",
</strong>  "deployment_request": {
    "private_host_ids": [],
    "application": <a data-footnote-ref href="#user-content-fn-12">"my-game-server"</a>,
    "version": <a data-footnote-ref href="#user-content-fn-13">"2024.01.30-16.23.00-UTC"</a>,
    "users": [
      {
        "user_type": "geo_coordinates",
        "<a data-footnote-ref href="#user-content-fn-14">données utilisateur</a>": {
<strong>          "latitude": 41.881832,
</strong><strong>          "longitude": -87.623177
</strong>        }
      }
    ],
<strong>    "tags": ["sb-qa-pool"],
</strong>    "environment_variables": [
      {
<strong>        "key": "SB_SCALING_POLICY_NAME",
</strong><strong>        "value": "sb-qa-pool",
</strong>        "is_hidden": false
      }
    ]
  },
<strong>  "minimum_active_instances": 1
</strong>}
</code></pre>

{% endtab %}

{% tab title="🌡️ Préchauffage" %}
Lancez 10 déploiements avant la mise en production en anticipation de la demande. À copier pour chaque région.

<pre class="language-json" data-title=""><code class="lang-json">{
  "name": "sb-v1.0.0-chicago",
<strong>  <a data-footnote-ref href="#user-content-fn-15">"filter"</a>: "total_joinable_seats gt 0 and metadata.policy_name eq 'sb-v1.0.0-chicago'",
</strong>  "deployment_request": {
    "private_host_ids": [],
    "application": <a data-footnote-ref href="#user-content-fn-12">"my-game-server"</a>,
    "version": <a data-footnote-ref href="#user-content-fn-13">"2024.01.30-16.23.00-UTC"</a>,
    "users": [
      {
        "user_type": "geo_coordinates",
        "<a data-footnote-ref href="#user-content-fn-14">données utilisateur</a>": {
<strong>          "latitude": 41.881832,
</strong><strong>          "longitude": -87.623177
</strong>        }
      }
    ],
<strong>    "tags": ["sb-v1.0.0-chicago"],
</strong>    "environment_variables": [
      {
<strong>        "key": "SB_SCALING_POLICY_NAME",
</strong><strong>        "value": "sb-v1.0.0-chicago",
</strong>        "is_hidden": false
      }
    ]
  },
<strong>  <a data-footnote-ref href="#user-content-fn-16">"minimum_active_instances"</a>: 10
</strong>}
</code></pre>

{% endtab %}

{% tab title="🔒 MMO" %}
Chaque région ajoute des déploiements lorsque la capacité disponible passe sous un seuil.

<pre class="language-json" data-title=""><code class="lang-json">{
<strong>  "name": "sb-mmo-chicago",
</strong><strong>  <a data-footnote-ref href="#user-content-fn-17">"filter"</a>: "total_joinable_seats gt 5 and metadata.policy_name eq 'sb-mmo-chicago'",
</strong>  "deployment_request": {
<strong>    <a data-footnote-ref href="#user-content-fn-18">"private_host_ids"</a>: ["alpha-north-america-95fab093"],
</strong>    "application": <a data-footnote-ref href="#user-content-fn-12">"my-game-server"</a>,
    "version": <a data-footnote-ref href="#user-content-fn-13">"2024.01.30-16.23.00-UTC"</a>,
    "users": [
      {
        "user_type": "geo_coordinates",
        "<a data-footnote-ref href="#user-content-fn-14">données utilisateur</a>": {
<strong>          "latitude": 41.881832,
</strong><strong>          "longitude": -87.623177
</strong>        }
      }
    ],
<strong>    "tags": ["sb-mmo-chicago"],
</strong>    "environment_variables": [
      {
<strong>        "key": "SB_SCALING_POLICY_NAME",
</strong><strong>        "value": "sb-mmo-chicago",
</strong>        "is_hidden": false
      }
    ],
<strong>    <a data-footnote-ref href="#user-content-fn-19">"webhook_on_terminated"</a>: {
</strong>      "url": "https://my-webhook.com"
    }
  },
<strong>  "minimum_active_instances": 3
</strong>}
</code></pre>

{% endtab %}

{% tab title="🔑 Communauté" %}
Une politique par propriétaire de serveur, avec un mot de passe personnalisé utilisé pour l'authentification du serveur.

<pre class="language-json" data-title=""><code class="lang-json">{
<strong>  "name": "sb-owner-jnjnc8mid",
</strong><strong>  <a data-footnote-ref href="#user-content-fn-20">"filter"</a>: "metadata.policy_name eq 'sb-owner-jnjnc8mid'",
</strong>  "deployment_request": {
<strong>    <a data-footnote-ref href="#user-content-fn-18">"private_host_ids"</a>: ["alpha-north-america-95fab093"],
</strong>    "application": <a data-footnote-ref href="#user-content-fn-12">"my-game-server"</a>,
    "version": <a data-footnote-ref href="#user-content-fn-13">"2024.01.30-16.23.00-UTC"</a>,
    "users": [
      {
        "user_type": "geo_coordinates",
        "<a data-footnote-ref href="#user-content-fn-14">données utilisateur</a>": {
<strong>          "latitude": 41.881832,
</strong><strong>          "longitude": -87.623177
</strong>        }
      }
    ],
<strong>    "tags": ["community", "sb-owner-jnjnc8mid"],
</strong>    "environment_variables": [
      {
<strong>        "key": "SB_SCALING_POLICY_NAME",
</strong><strong>        "value": "sb-owner-jnjnc8mid",
</strong>        "is_hidden": false
      },
      {
<strong>        "key": "SB_SERVER_PASSWORD",
</strong><strong>        "value": "password1234",
</strong>        "is_hidden": false
      }
    ],
<strong>    <a data-footnote-ref href="#user-content-fn-21">"webhook_on_ready"</a>: {
</strong>      "url": "https://my-webhook.com"
    },
<strong>    <a data-footnote-ref href="#user-content-fn-22">"webhook_on_error"</a>: {
</strong>      "url": "https://my-webhook.com"
    },
<strong>    <a data-footnote-ref href="#user-content-fn-19">"webhook_on_terminated"</a>: {
</strong>      "url": "https://my-webhook.com"
    }
  },
  "minimum_active_instances": 1
}
</code></pre>

{% endtab %}

{% tab title="❄️ Groupe maillé" %}
Une politique par groupe de serveurs. Le backend du jeu démarre un nœud principal, qui crée des réplicas. Chaque nœud lit l'identifiant du groupe maillé injecté et recherche d'autres nœuds avec lesquels se mettre en réseau.

<pre class="language-json" data-title=""><code class="lang-json">{
<strong>  "name": "sb-meshgroup-pqyt8sxcb",
</strong><strong>  <a data-footnote-ref href="#user-content-fn-11">"filter"</a>: "metadata.policy_name eq 'sb-meshgroup-pqyt8sxcb'",
</strong>  "deployment_request": {
    "private_host_ids": [],
    "application": <a data-footnote-ref href="#user-content-fn-12">"my-game-server"</a>,
    "version": <a data-footnote-ref href="#user-content-fn-13">"2024.01.30-16.23.00-UTC"</a>,
    "users": [
      {
        "user_type": "geo_coordinates",
        "<a data-footnote-ref href="#user-content-fn-14">données utilisateur</a>": {
<strong>          "latitude": 41.881832,
</strong><strong>          "longitude": -87.623177
</strong>        }
      }
    ],
<strong>    "tags": ["sb-meshgroup-pqyt8sxcb"],
</strong>    "environment_variables": [
      {
<strong>        "key": "SB_SCALING_POLICY_NAME",
</strong><strong>        "value": "sb-meshgroup-pqyt8sxcb",
</strong>        "is_hidden": false
      },
      {
<strong>        "key": "SB_MESH_GROUP_ID",
</strong><strong>        "value": "pqyt8sxcb",
</strong>        "is_hidden": false
      }
    ],
<strong>    <a data-footnote-ref href="#user-content-fn-21">"webhook_on_ready"</a>: {
</strong>      "url": "https://my-webhook.com"
    },
<strong>    <a data-footnote-ref href="#user-content-fn-23">"webhook_on_terminated"</a>: {
</strong>      "url": "https://my-webhook.com"
    }
  },
<strong>  <a data-footnote-ref href="#user-content-fn-24">"minimum_active_instances"</a>: 9
</strong>}
</code></pre>

{% endtab %}
{% endtabs %}

## ⚙️ Configuration

L'API Server Browser est générée à partir d'une configuration JSON spécifiée lorsque vous créez un nouveau Server Browser (ou lors d'un redémarrage rapide). Vous pouvez définir l'expiration des serveurs et des emplacements, ainsi que des métadonnées personnalisées :

{% tabs %}
{% tab title="🍀 Exemple simple" %}

<pre class="language-json" data-title="sb-simple-example-v1-0-0.json"><code class="lang-json">{
	"version": "1.0.0",
	"server_instances": {
		"expiration_period": "1m",
		"<a data-footnote-ref href="#user-content-fn-25">indices</a>": {
			"policy_name": "string",
			"name": "string"
		}
	},
	"server_instance_slots": {
		"<a data-footnote-ref href="#user-content-fn-25">indices</a>": {}
	},
	"seat_reservations": {
		"expiration_period": "30s"
	},
	"scaling_policies": {
		"monitoring_interval": "10s",
		"deployment_registration_period": "1m"
	}
}
</code></pre>

{% endtab %}

{% tab title="🎈 Jeux sociaux" %}

<pre class="language-json" data-title="sb-social-example-v1-0-0.json"><code class="lang-json">{
	"version": "1.0.0",
	"server_instances": {
		"expiration_period": "15s",
		"<a data-footnote-ref href="#user-content-fn-25">indices</a>": {
			"policy_name": "string",
			"name": "string",
			"third_party_id": "string",
			"level": "string",
			"mode": "string",
			"difficulty": "string",
			"seed": "string",
			"max_players": "int",
			"app_version": "string",
			"location.city": "string"
		}
	},
	"server_instance_slots": {
		"<a data-footnote-ref href="#user-content-fn-25">indices</a>": {
			"third_party_id": "string",
			"max_players": "int",
			"avg_latency": "int",
			"player_ids": "string"
		}
	},
	"seat_reservations": {
		"expiration_period": "30s"
	},
	"scaling_policies": {
		"monitoring_interval": "10s",
		"deployment_registration_period": "30s"
	}
}
</code></pre>

{% endtab %}

{% tab title="🤝 Jeux coopératifs" %}

<pre class="language-json" data-title="sb-cooperative-example-v1-0-0.json"><code class="lang-json">{
	"version": "1.0.0",
	"server_instances": {
		"expiration_period": "15s",
		"<a data-footnote-ref href="#user-content-fn-25">indices</a>": {
			"policy_name": "string",
			"name": "string",
			"third_party_id": "string",
			"level": "string",
			"mode": "string",
			"difficulty": "string",
			"avg_rank": "int",
			"max_players": "int",
			"app_version": "string",
			"tags": "string",
			"match_id": "string",
			"location.city": "string"
		}
	},
	"server_instance_slots": {
		"<a data-footnote-ref href="#user-content-fn-25">indices</a>": {
			"third_party_id": "string",
			"max_players": "int",
			"player_ids": "string"
		}
	},
	"seat_reservations": {
		"expiration_period": "30s"
	},
	"scaling_policies": {
		"monitoring_interval": "10s",
		"deployment_registration_period": "30s"
	}
}
</code></pre>

{% endtab %}

{% tab title="⚔️ Jeux compétitifs" %}

<pre class="language-json" data-title="sb-competitive-example-v1-0-0.json"><code class="lang-json">{
	"version": "1.0.0",
	"server_instances": {
		"expiration_period": "15s",
		"<a data-footnote-ref href="#user-content-fn-25">indices</a>": {
			"policy_name": "string",
			"name": "string",
			"third_party_id": "string",
			"avg_rank": "int",
			"max_players": "int",
			"is_ranked": "bool",
			"app_version": "string",
			"cpu_frequency": "int",
			"match_id": "string",
			"location.city": "string"
		}
	},
	"server_instance_slots": {
		"<a data-footnote-ref href="#user-content-fn-25">indices</a>": {
			"third_party_id": "string",
			"max_players": "int",
			"avg_rank": "int",
			"avg_latency": "int"
		}
	},
	"seat_reservations": {
		"expiration_period": "30s"
	},
	"scaling_policies": {
		"monitoring_interval": "10s",
		"deployment_registration_period": "15s"
	}
}
</code></pre>

{% endtab %}
{% endtabs %}

{% hint style="info" %}
Pour des performances optimales, évitez de spécifier des indices pour les métadonnées qui ne sont pas utilisées pour le filtrage ou le tri. Les paramètres non indexés peuvent toujours être définis et lus avec les méthodes API de détails de l'instance de serveur ou de l'emplacement, voir [#api](#api "mention").
{% endhint %}

## ☁️ Cluster d'hébergement

Server Browser est hébergé et géré de manière pratique 24 h/24, 7 j/7 par Edgegap.

Choisissez l'option d'hébergement la mieux adaptée à votre objectif :

### Niveaux de cluster privé

Passez à un cluster privé en un clic pour bénéficier d'un hébergement hautement disponible, maintenu par l'équipe d'Edgegap, avec une assistance en direct 24 h/24, 7 j/7 pour les jeux publiés.

Les besoins en ressources de votre instance dépendront des facteurs suivants :

* **nombre de joueurs** - plus de joueurs entraînent davantage de requêtes API,
* **nombre de requêtes par joueur** - des tentatives plus rapides augmentent la charge du service et consomment des ressources,
* **nombre de serveurs** - plus de serveurs entraînent davantage de données stockées et davantage de requêtes API,
* **logique de repli des nouvelles tentatives côté client** - le fait de réessayer avec un backoff à délai aléatoire aide à répartir les pics de trafic,
* **durée moyenne d'une partie** - des sessions plus courtes nécessitent des interactions plus fréquentes avec Server Browser.

## 📗 API

**Envisagez d'utiliser notre SDK pour** [**Unreal Engine**](/docs.edgegap.com-fr/unreal-engine/developer-tools.md) **ou** [**Unity**](/docs.edgegap.com-fr/unity/server-browser.md) **pour démarrer rapidement avec des exemples prédéfinis.**

Les clients de jeu et les serveurs dédiés envoient des requêtes API tout au long de leur cycle de vie à Server Browser.

{% file src="/files/0fce12b37adb35699c68e3e0f5ee8cbc7d4a6d0e" %}

Importez la spécification de l'API dans [Scalar API Web Client](https://client.scalar.com/workspace/default/request/default) ou [Swagger Editor](https://editor.swagger.io/) pour examiner les détails.

### Pagination

**Server Browser fournit une pagination par curseur pour récupérer progressivement les données filtrées dans un ordre précis.** Cette approche nécessite d'envoyer un curseur (point de départ) et une taille de page (nombre d'éléments de réponse) chaque fois que l'on récupère davantage de résultats, contrairement à la pagination traditionnelle par limite et décalage.

{% hint style="info" %}
Associée à notre système propriétaire d'indexation de base de données développé pour les métadonnées des serveurs de jeu, la pagination par curseur offre une expérience utilisateur rapide, cohérente et flexible pour filtrer des données très dynamiques.
{% endhint %}

Notre objectif est que les utilisateurs trouvent un serveur adapté sur la première page. Pour une meilleure expérience, nous recommandons d'afficher les résultats mis en cache des pages précédentes et de rafraîchir les résultats uniquement lorsque l'utilisateur clique sur Rechercher.

## 🔖 Journal des modifications

{% hint style="info" %}
**La dernière version de Server Browser est `1.0.0`** . Surveillez [les mises à jour et les annonces](/docs.edgegap.com-fr/docs/release-notes.md).
{% endhint %}

[^1]: identifiants de joueurs tiers

[^2]: égal à

[^3]: différent de

[^4]: inférieur à

[^5]: inférieur ou égal à

[^6]: supérieur à

[^7]: supérieur ou égal à

[^8]: voir Configuration

[^9]: voir Exemples de politiques

[^10]: utilisez la mise en cache active pour réduire facilement les temps de déploiement

[^11]: * capacité fixe
    * suppose que les instances fournissent le nom de la politique dans les métadonnées à partir de la variable injectée

[^12]: remplacez par le nom de votre propre application

[^13]: remplacez par la version de votre propre application

[^14]: coordonnées de Chicago

[^15]: * se déploie lorsque moins de 10 instances rejoignables sont trouvées
    * suppose que les instances fournissent le nom de la politique dans les métadonnées à partir de la variable injectée

[^16]: nous attendons au moins 10 déploiements dans la région de Chicago

[^17]: * se déploie lorsque moins de 3 instances avec 5 sièges rejoignables ou moins sont trouvées
    * suppose que les instances fournissent le nom de la politique dans les métadonnées à partir de la variable injectée

[^18]: privilégier la flotte privée si la capacité est disponible

[^19]: notifier le backend du jeu lorsque le serveur redémarre

[^20]: * ne surveille pas la capacité
    * suppose que les instances fournissent le nom de la politique dans les métadonnées à partir de la variable injectée

[^21]: notifier le backend du jeu lorsqu'il est prêt

[^22]: notifier le backend du jeu lorsque le déploiement échoue

[^23]: notifier le backend du jeu lorsqu'il est arrêté

[^24]: grille 3x3 = 9 serveurs par monde

[^25]: les indices contiennent vos paramètres de métadonnées personnalisées utilisés pour le filtrage ou le tri


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
