# Edgegap

In this simple guide, we'll go through how you get started hosting your dedicated server(s) with Edgegap in PurrNet. Luckily, this is very easy!

### Preparation

{% hint style="success" %}
You will need to have [an Edegap account](https://app.edgegap.com/auth/register) to properly follow this guide
{% endhint %}

{% hint style="success" %}
Using your account make sure to have [your token](https://app.edgegap.com/user-settings?tab=tokens) at hand
{% endhint %}

### Getting Started

First, start by getting setup and logged in to [Edgegap](https://app.edgegap.com/) so you can access the dashboard. And after this, have a brief look at [their own documentation](https://docs.edgegap.com/), to get setup with their Unity editor tool.

{% embed url="<https://youtu.be/Df6y4bV7V3k>" %}

### Installing Edgegap in Unity

Go your your top toolbar: `Tools > PurrNet > Addon Library` and click `Install` on the `Edgegap` addon. This will automatically import the tool into your project!

{% hint style="warning" %}
**You must have** [**Git installed**](https://git-scm.com/downloads) on your system for Unity to fetch packages via git URLs.
{% endhint %}

<figure><img src="https://3317286851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsgxJN58uttGJCEXbBIwp%2Fuploads%2Fgit-blob-e8146d9d0ff3a81cc9f84cc112bc641029cc1188%2FScreenshot%202025-10-14%20213647.png?alt=media" alt=""><figcaption></figcaption></figure>

To help you get started we have setup a menu item that allows you to verify all the required dependencies and also help guide you to properly install them or remind you to open required tools.

<figure><img src="https://3317286851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsgxJN58uttGJCEXbBIwp%2Fuploads%2Fgit-blob-70668af7bca010aa2f7eec835d1896bba72b6dd6%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

But to give you a summary you need these tools:

* [Docker ](https://www.docker.com/products/docker-desktop/)(Desktop or CLI)
  * Even after installed you need to make sure it is open when you want to upload a new server build
* Install Unity Linux Build Support through UnityHub

For more details checkout [Edegap's documentation](https://app.gitbook.com/u/2sVib8J3vKeGKmdmCC8sZomnEdi1).

### Setting up PurrNet

When Edgegap is properly installed a little box will show up for supported transport that let's you toggle on or off the auto configuration of these transports.

<figure><img src="https://3317286851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsgxJN58uttGJCEXbBIwp%2Fuploads%2Fgit-blob-f5619bd6b5fb5e20113cb306ca39672283915aa6%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

The auto configuration will detect when inside an Edgegap environment automatically and use environment variables to automatically setup the correct ports and even SSL settings on your behalf. The client still needs to properly configure these but you can rest assured that the server is handled.

In case you have multiple of the same protocol for one server you might want to disable this and manually handle your setup accordingly.

### Deploying the server

There are a few steps required to reach from nothing to a deployed server.

1. Unity Linux Build
2. Containerize The Build Files
   1. This is why you need docker installed, if you are not familiar with docker you can think of this step almost like zipping your project. I'm making a huge disservice to the technology behind the scenes but you don't need those details and can always learn more for yourself.
3. Upload container to Edgegap
4. Deploy your application!

Feel free to checkout [Edgegap's documentation](https://docs.edgegap.com/learn/unity-games/getting-started-with-servers) for proper detailed step by step on this but we will give you a quick getting started guide here too.

#### Speed running first server

First, you want to open Edgegap's editor window.

<div align="left"><figure><img src="https://3317286851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsgxJN58uttGJCEXbBIwp%2Fuploads%2Fgit-blob-3711bfbd57c2af3d23af24ee7aacbbc0932da77e%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure></div>

Then fill in your token:

<figure><img src="https://3317286851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsgxJN58uttGJCEXbBIwp%2Fuploads%2Fgit-blob-5fcf854538c3af216c76d16231f9586b62c962f9%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

Once your token is setup and validated we can proceed to step 2 (building your server). All you have to do is press the `Build Server` button. This is just like a normal Unity build so make sure you have your scene list properly setup. The build target will be a Linux dedicated server which is why you had to install the extra modules.

<figure><img src="https://3317286851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsgxJN58uttGJCEXbBIwp%2Fuploads%2Fgit-blob-b55b9d70bb8bf408ab1f1174a775b814a4f6d57c%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

With the build done we need to containerize it. This is where docker comes into play, it is essentially packaging your build in a way that Edgegap can work with it. Just press `Containerize with Docker`.

<figure><img src="https://3317286851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsgxJN58uttGJCEXbBIwp%2Fuploads%2Fgit-blob-6392c6eeeb46d0b6bcfd73fc201ca7f4ca54e5b8%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

We will skip step 4, you can use it to locally run the container you just created to test the server locally (even if your operating system isn't Linux).

In step 5 you need to choose your target application, a server image name (this can be whatever you want) and finally just press the `Upload image and Create app version` button.

<figure><img src="https://3317286851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsgxJN58uttGJCEXbBIwp%2Fuploads%2Fgit-blob-290a18c6bf17ae48e5f2eb691a94f0c499ff1077%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

Once it finishes you can either `Deploy to Cloud` from the website dashboard or from step 6.

<figure><img src="https://3317286851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsgxJN58uttGJCEXbBIwp%2Fuploads%2Fgit-blob-94e907e5284424f4921f7cbd09356d96b3af7561%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

Every container you upload will have a version, by default it's the date that it was built at which you can use to select the latest.

Once you have an application that is deployed you can try to connect from your editor or a client build.\
On the website's dashboard you can manually find the information required to connect:

<figure><img src="https://3317286851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsgxJN58uttGJCEXbBIwp%2Fuploads%2Fgit-blob-0609fed0a0d48fd3d637dca799e313cc6dfbe7de%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

You would use the \`Host\` as your address and \`External\` port as your client port.\
Here is an example of a correct setup inside Unity (notice `Server Port` and `Address`):

<figure><img src="https://3317286851-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsgxJN58uttGJCEXbBIwp%2Fuploads%2Fgit-blob-c30da498065c34591b249c587f4906f44f093c01%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

### Easy as that!

Now you know how to get a server up and running and connect to it!\
You can expand on this by using their [matchmaking service](https://docs.edgegap.com/learn/matchmaking/getting-started) to automatically create matches for your users.