# Edgegap Docs

## EN

- [Getting Started](https://docs.edgegap.com/getting-started.md): Deploy and scale multiplayer game servers on Edgegap. Start with Unreal, Unity, or Godot and get your first dedicated server online in minutes.
- [Unreal Engine - Getting Started](https://docs.edgegap.com/unreal-engine.md): Deploy your first Unreal Engine dedicated server on Edgegap. A hands-on guide covering build, upload, and global deployment for multiplayer games.
- [More Build Methods](https://docs.edgegap.com/unreal-engine/more-build-methods.md): Alternative ways to build an Unreal Engine dedicated server for Edgegap, for teams that need more control than the plugin workflow offers.
- [Developer Tools](https://docs.edgegap.com/unreal-engine/developer-tools.md): Edgegap developer tools for Unreal Engine, built for fast iteration and frequent deployment of your multiplayer game servers.
- [Unity - Getting Started](https://docs.edgegap.com/unity.md): Deploy your first Unity dedicated server on Edgegap. A hands-on guide covering build, upload, and global deployment for multiplayer games.
- [Matchmaking](https://docs.edgegap.com/unity/matchmaking.md): Add matchmaking to your Unity game with Edgegap's optional starter-kit SDK, ready to extend and customize as your multiplayer project grows.
- [Server Browser](https://docs.edgegap.com/unity/server-browser.md): Add a server browser to your Unity game with Edgegap's optional starter-kit SDK, letting players find and join live sessions from a list.
- [Developer Tools](https://docs.edgegap.com/unity/developer-tools.md): Edgegap developer tools for Unity, built for fast iteration and frequent deployment of your multiplayer game servers.
- [Godot - Getting Started](https://docs.edgegap.com/godot.md): Deploy your first Godot dedicated server on Edgegap. A hands-on guide covering build, upload, and global deployment for multiplayer games.
- [Orchestration](https://docs.edgegap.com/learn/orchestration.md): Structure applications, versions, and deployments on Edgegap so your multiplayer game scales cleanly from first test to global launch.
- [Apps and Versions](https://docs.edgegap.com/learn/orchestration/application-and-versions.md): How Edgegap applications and versions work, with best practices for versioning game server builds and separating environments.
- [Deployments](https://docs.edgegap.com/learn/orchestration/deployments.md): Understand the Edgegap deployment lifecycle: how game server instances start, run, scale, and stop, plus best practices for managing them.
- [Player Sessions](https://docs.edgegap.com/learn/orchestration/player-sessions.md): Discover session orchestration concepts and key differences between Lobby, Group, Session, and Social Hub. Learn how to use your Lobby with Edgegap.
- [Private Fleets](https://docs.edgegap.com/learn/orchestration/private-fleets.md): Reserve monthly standby capacity on Edgegap with private fleets, explore cost-efficient options for games with stable player base.
- [Persistence](https://docs.edgegap.com/learn/orchestration/persistence.md): Run persistent game worlds on Edgegap with always-on 24/7 deployments backed by private fleets.
- [Ping Beacons](https://docs.edgegap.com/learn/orchestration/ping-beacons.md): Use Edgegap ping beacons to measure real player latency and avoid matching players into distant regions.
- [Matchmaking](https://docs.edgegap.com/learn/matchmaking.md)
- [In-Depth Look](https://docs.edgegap.com/learn/matchmaking/matchmaker-in-depth.md)
- [Server Browser](https://docs.edgegap.com/learn/server-browser.md): Set up Edgegap's Server Browser so players can discover and join persistent game servers in the nearest region, or pick from an in-game list UI.
- [Advanced Features](https://docs.edgegap.com/learn/advanced-features.md): Advanced Edgegap features for teams ready to go further: container registries, managed clusters, and region-specific deployment options.
- [Container Registry](https://docs.edgegap.com/learn/advanced-features/edgegap-container-registry.md): Store your game server container images in Edgegap's free built-in registry, ready to deploy across the global edge network.
- [Managed Clusters](https://docs.edgegap.com/learn/advanced-features/managed-clusters.md): Run custom backend services on Edgegap managed clusters, with a quick start for integrating your own infrastructure.
- [China Gateway](https://docs.edgegap.com/learn/advanced-features/china-gateway.md): Deploy game servers in China through Edgegap's China Gateway, which covers the regulatory and country-specific compliance requirements.
- [Relays (P2P)](https://docs.edgegap.com/learn/distributed-relay.md): Connect players peer-to-peer through Edgegap's distributed relay network, cutting latency without running dedicated game servers.
- [Game Integration](https://docs.edgegap.com/learn/distributed-relay/relay-edgegap-api.md): Integrate Edgegap relays into your game using the API, including how a custom lobby service fits into the relay session flow.
- [Transport Samples](https://docs.edgegap.com/learn/distributed-relay/relay-transport-samples.md): Sample transports for Edgegap relays, showing how to create a relay session once matchmaking or a lobby has grouped your players.
- [Release Notes](https://docs.edgegap.com/docs/release-notes.md)
- [Archive](https://docs.edgegap.com/docs/release-notes/archive.md): Archived Edgegap release notes covering earlier SDK versions and platform updates.
- [MCP Integration](https://docs.edgegap.com/docs/mcp-integration.md): Connect AI coding agents to Edgegap through MCP servers, exposing a troubleshooting toolkit for your game server deployments.
- [API Reference](https://docs.edgegap.com/docs/api.md): Edgegap HTTP API reference for managing applications, versions, deployments, and relays programmatically.
- [Dedicated Servers](https://docs.edgegap.com/docs/api/dedicated-servers.md): HTTP API reference for creating, querying, and stopping Edgegap dedicated server deployments, including rate limits and request examples.
- [Versioning](https://docs.edgegap.com/docs/api/versioning.md): API endpoints for creating Edgegap applications and versions, used to group game server builds and separate environments.
- [Integration](https://docs.edgegap.com/docs/api/integration.md): Session Orchestration service APIs at Edgegap, private API for each matchmaker and server browser instance is managed separately from Edgegap API.
- [Relays](https://docs.edgegap.com/docs/api/relays.md): API endpoints for creating and managing Edgegap relay sessions that carry peer-to-peer multiplayer traffic.
- [Deprecated](https://docs.edgegap.com/docs/api/deprecated.md): Deprecated Edgegap API endpoints, kept for reference alongside guidance on their current replacements.
- [Sample Projects](https://docs.edgegap.com/docs/sample-projects.md): Sample multiplayer projects for Unity, Unreal Engine, and Godot, each showing a working Edgegap deployment you can build on.
- [Unreal Engine](https://docs.edgegap.com/docs/sample-projects/unreal-engine.md): Unreal Engine sample projects demonstrating dedicated server hosting on Edgegap, from simple templates to full game samples.
- [Lyra Sample](https://docs.edgegap.com/docs/sample-projects/unreal-engine/lyra-sample.md): Host Epic's Lyra sample on Edgegap, walking through the build and deployment steps for an Unreal Engine dedicated server.
- [Top-Down Sample](https://docs.edgegap.com/docs/sample-projects/unreal-engine/top-down-sample.md): Deploy an Unreal Engine top-down sample as a dedicated server on Edgegap, a practical starting point for solo developers and small teams.
- [Unity](https://docs.edgegap.com/docs/sample-projects/unity-netcodes.md): Unity sample projects across popular netcodes including Mirror, FishNet, Photon Fusion, Netcode for GameObjects, and Purrnet, all on Edgegap.
- [Photon Fusion 2](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/photon-fusion-2-on-edgegap.md): Host a Unity Photon Fusion 2 game on Edgegap, following the Fusion 2 Asteroids sample from build through live deployment.
- [Unity NGO](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/unity-netcode-on-edgegap.md): Host a Unity Netcode for GameObjects project on Edgegap, following the NGO Boss Room sample from build through live deployment.
- [Mirror Pong](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/mirror-pong.md): Host a Unity Mirror multiplayer game on Edgegap, using the Mirror Pong sample to walk through build, containerization, and deployment.
- [Purrnet Incremental](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/purrnet-incremental.md): Host a Unity Purrnet game on Edgegap, using the Purrnet Incremental sample to walk through build and deployment.
- [Fishnet](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/fishnet-on-edgegap.md): Host a Unity FishNet game on Edgegap, using the FishNet HashGrid sample to walk through build and deployment.
- [Mirror Tanks](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/mirror-on-edgegap.md): Create a headless Unity game server on Edgegap for a project using Mirror as its networking solution.
- [Photon Fusion 1](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/photon-fusion-on-edgegap.md): Create a headless Unity game server on Edgegap for a project using Photon Fusion as its networking solution.
- [Photon Bolt](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/photon-bolt-on-arbitrium.md): Create a headless Unity game server on Edgegap for a project using Photon Bolt as its networking solution.
- [Mirror WebGL](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/mirror-on-edgegap-websocket.md): Use Mirror's WebSocket transport to run a Unity WebGL multiplayer game on Edgegap game servers.
- [Fishnet WebGL](https://docs.edgegap.com/docs/sample-projects/unity-netcodes/fishnet-on-edgegap-webgl.md): Use FishNet's Bayou WebSocket transport to run a Unity WebGL multiplayer game on Edgegap game servers.
- [Godot](https://docs.edgegap.com/docs/sample-projects/godot.md): Godot sample projects showing how to run dedicated multiplayer game servers on Edgegap.
- [Netfox Forest Brawl](https://docs.edgegap.com/docs/sample-projects/godot/netfox-forest-brawl.md): Host a Godot multiplayer game on Edgegap using techniques from the Netfox Forest Brawl sample.
- [NuxtJS](https://docs.edgegap.com/docs/sample-projects/nuxt-on-edgegap.md): Deploy a Nuxt web application to Edgegap and serve it close to your users from the global edge network.
- [Ruby On Rails](https://docs.edgegap.com/docs/sample-projects/ruby-on-rails.md): Deploy a Ruby on Rails application to Edgegap and serve it close to your users from the global edge network.
- [Tools & Integrations](https://docs.edgegap.com/docs/tools-and-integrations.md): Integrate Edgegap with Docker, external registries, matchmakers, and platforms including Epic Online Services, Nakama, PlayFab, and Unity Gaming Services.
- [Docker & Containers](https://docs.edgegap.com/docs/tools-and-integrations/docker.md): Why Edgegap runs game servers in containers, and how to get Docker set up before building your first server image.
- [External Registries](https://docs.edgegap.com/docs/tools-and-integrations/docker/external-registries.md): Connect an external container registry to Edgegap, including Docker Hub, AWS ECR, Google Container Registry, and GitLab.
- [Docker Hub](https://docs.edgegap.com/docs/tools-and-integrations/docker/external-registries/docker-hub.md): Connect a Docker Hub registry to Edgegap, including how to generate the access token Edgegap needs to pull your image.
- [AWS ECR](https://docs.edgegap.com/docs/tools-and-integrations/docker/external-registries/aws-ecr.md): Connect an AWS ECR registry to Edgegap, including the AWS CLI and Docker prerequisites you need in place first.
- [GCP GCR](https://docs.edgegap.com/docs/tools-and-integrations/docker/external-registries/gcp-gcr.md): Connect a Google Container Registry repository to Edgegap, including where to find your full repository name.
- [Gitlab registry](https://docs.edgegap.com/docs/tools-and-integrations/docker/external-registries/gitlab-registry.md): Connect a GitLab container registry to Edgegap, including how to generate the personal access token required.
- [Deploy from Nakama](https://docs.edgegap.com/docs/tools-and-integrations/deploy-from-nakama.md): Pair Nakama with Edgegap to deliver consistent online multiplayer experiences, from indie projects through AAA titles.
- [Deploy from UGS](https://docs.edgegap.com/docs/tools-and-integrations/deploy-from-ugs.md): Keep your Unity Gaming Services matchmaker and deploy the game servers to Edgegap, combining both platforms.
- [Deploy from Playfab](https://docs.edgegap.com/docs/tools-and-integrations/playfab-bridge.md): Keep your Playfab matchmaker and deploy your game servers to Edgegap, combining both platforms.
- [EOS Lobby Integration](https://docs.edgegap.com/docs/tools-and-integrations/unreal-eos-lobby-integration.md): Integrate Edgegap with Epic Online Services lobbies in an Unreal Engine project to place grouped players onto game servers.
- [Switch From Gamelift](https://docs.edgegap.com/docs/tools-and-integrations/gamelift-to-arbitrium.md): Migrate your game servers from AWS GameLift to Edgegap with a short set of steps to get you running quickly.
- [Switch From Multiplay](https://docs.edgegap.com/docs/tools-and-integrations/switch-from-multiplay.md): Migrate your multiplayer game from Unity Multiplay to Edgegap ahead of its end of life, without disrupting live players.
- [Switch from Hathora](https://docs.edgegap.com/docs/tools-and-integrations/switch-from-hathora.md): Migrate your multiplayer game from Hathora to Edgegap before shutdown, with a step-by-step path for moving game servers without downtime.
- [Endpoint Storage](https://docs.edgegap.com/docs/endpoint-storage.md): Register an S3 bucket with Edgegap Endpoint Storage to move logs from your deployments and your own long term storage.
- [How to Save Logs](https://docs.edgegap.com/docs/endpoint-storage/save-container-logs.md): Save game server container logs from Edgegap deployments to your own S3 bucket for later analysis.
- [Upload File to Deployment](https://docs.edgegap.com/docs/endpoint-storage/upload-files.md): Upload files from your S3 bucket into an Edgegap deployment, downloaded on demand when the game server starts.
- [DDoS Protection](https://docs.edgegap.com/docs/ddos-protection.md): How Edgegap's distributed edge network absorbs and prevents DDoS attacks against your multiplayer game servers, with no extra configuration.
- [Glossary](https://docs.edgegap.com/docs/glossary.md): Definitions of core Edgegap concepts including applications, versions, deployments, and fleets, as used across these docs.
- [SLA Terms](https://docs.edgegap.com/docs/sla-terms.md): Edgegap service level agreement terms and the support Edgegap provides across your game's lifecycle.