Skip to content
This repository has been archived by the owner on Nov 3, 2024. It is now read-only.

Latest commit

 

History

History
291 lines (228 loc) · 8.19 KB

HOSTING.md

File metadata and controls

291 lines (228 loc) · 8.19 KB
Raw

Hosting your own survev server

Looking to host your own survev server to mess around or play against friends? This is the place for you.

Prerequisites

Before diving into the setup instructions, make sure you have the correct tools for the job. Hosting a dedicated survev server requires two things:

  • SSH access to a VPS (or some other form of dedicated hosting)
  • The ability to open ports on said machine

You can find cheap VPS hosts at Ionos, A2 Hosting, or Vultr.

NOTE: I am not endorsing or recommending any of the following hosts, they are just a few I have found people to use.

If you accept the risk, you can host a dedicated server on your home network. However, you will need to port forward the necessary ports via your router for others to access your server. Do not do this unless you understand what you are doing. Previous Linux knowledge required.

Setup

This tutorial is written assuming you are using Ubuntu 20.04. Follow accordingly based on the distribution you are using.

Logging into the machine

If you bought a VPS (or other form of hosting) from a hosting company, then these credentials should be accessible via their dashboard. Typically, they will consist of three things:

  • IP: The IP of your server.
  • Username The username (usually root), to log in with.
  • Password: The password to log in with.

Optionally, if your VPS provides SSH access on a different port, that will also be listed.

Open a terminal (Command Prompt for Windows) and write the following command:

ssh username@host

replacing username and host with your username and host.

If you have a custom SSH port (not 22), then use this instead:

ssh username@host -p port

additionally replacing port with the custom SSH port provided.

After writing this command, hit enter. You will be prompted for a password.

For security reasons, you cannot view your password as you type it. Type in the password, and hit enter.

If you see a notice notifying you of the machine you have just logged into, congratulations! You have succesfully SSH'd into your server.

Dependencies

Survev requires a few dependencies:

If you are logged in as root, start by making sure sudo is installed:

apt -y install sudo

Then install git and nginx with the following command.

sudo apt -y install git nginx

To install Node.js, install the appropriate package from your distro, or for Ubuntu:

curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash - &&\
sudo apt-get install -y nodejs

And finally, install pnpm:

npm i -g pnpm

Building source

Next, move into /opt, clone the repository and traverse into it:

cd /opt
git clone https://github.com/leia-uwu/survev.git
cd survev

Install the necessary dependencies:

pnpm install

Its recommended that you generate an API key for the game server to connect to the API server

If you are only hosting a game server for a different region, you need to get the central API server key

Generate a secure API key from terminal:

openssl rand -base64 32

Configure server:

nano survev-config.json

And populate it with the following content:

{
    "apiKey": "API_KEY_GOES_HERE",
    "gameServer": {
        "apiServerUrl": "API_SERVER_URL"
    },
    "regions": {
        "REGION_ID": {
            "https": true,
            "address": "GAME_SERVER_IP_OR_DOMAIN",
            "l10n": "SERVER_NAME_TRANSLATION"
        }
    },
    "thisRegion": "THIS_REGION_ID"
}

API_SERVER_URL should be replaced with the full address (including port and https) of the API Server.

REGION_ID should be replaced with the id of the region (example na for north america).

GAME_SERVER_IP_OR_DOMAIN should be the domain or ip of the region game server .

SERVER_NAME_TRANSLATION should be the translation for the server name to display in the client (example: index-north-america for North America). Avaliable translations by default are: index-local, index-north-america, index-europe, index-asia, index-south-america, index-korea

THIS_REGION_ID should be replaced with the region ID this game server is hosting

Example config file:

{
    "apiKey": "j0wo7RY0pYgD6W2mEy2wLa7VE4olUPD1r2hZma8FU6o=",
    "gameServer": {
        "apiServerUrl": "https://survev.io"
    },
    "regions": {
        "na": {
            "https": true,
            "address": "na.survev.io:8001",
            "l10n": "index-north-america"
        },
        "eu": {
            "https": true,
            "address": "eu.survev.io:8001",
            "l10n": "index-europe"
        }
    },
    "thisRegion": "na"
}

Save the file using Ctrl + X, and press Y to confirm the file name.

to see more configuration options, see the file server/src/config.ts

Build the client & server:

pnpm -r build

Setting up NGINX

We will now setup NGINX to serve the client and API server. If you are only hosting a game server you can skip this.

Make sure the build directory has the proper permissions:

sudo chown -R www-data:www-data /opt/survev/client/dist

First, remove the default file:

sudo unlink /etc/nginx/sites-enabled/default
sudo rm /etc/nginx/sites-available/default

Create a new file:

nano /etc/nginx/sites-available/survev.conf

And populate it with the following content:

server {
    listen 80 default_server;
    listen [::]:80 default_server;

    server_name _;

    # Client build
    location / {
        root /opt/survev/client/dist;
    }

    # API server
    location /api {
        proxy_http_version 1.1;

        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-Host $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header Host $http_host;

        proxy_pass "http://127.0.0.1:8000";
    }

    # Team WebSocket server
    location /team_v2 {
        proxy_http_version 1.1;

        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-Host $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header Host $http_host;

        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "Upgrade";

        proxy_pass "http://127.0.0.1:8000";
        proxy_redirect off;
    }
}

Save the file using Ctrl + X, and press Y to confirm the file name.

To enable the configuration:

sudo ln -s /etc/nginx/sites-available/survev.conf /etc/nginx/sites-enabled/survev.conf
sudo systemctl restart nginx

Running the game and API server

Next, we will create systemd unit files for the Game and API server. which will ensure our application starts at boot and won't terminate if we end our SSH session: If you are only hosting a game server, skip the API server part.

sudo nano /etc/systemd/system/survev-game.service

And populate it with the following content:

[Unit]
Description=survev dedicated game server.

[Service]
Type=simple
WorkingDirectory=/opt/survev/server
ExecStart=/usr/bin/pnpm start:game
Restart=on-failure

[Install]
WantedBy=multi-user.target

Save the file using Ctrl + X, and press Y to confirm the file name.

Enable the unit:

sudo systemctl enable --now survev-game

Now do the same for the API server if applicable:

sudo nano /etc/systemd/system/survev-api.service

And populate it with the following content:

[Unit]
Description=survev dedicated API server.

[Service]
Type=simple
WorkingDirectory=/opt/survev/server
ExecStart=/usr/bin/pnpm start:api
Restart=on-failure

[Install]
WantedBy=multi-user.target

Save the file using Ctrl + X, and press Y to confirm the file name.

Enable the unit:

sudo systemctl enable --now survev-api

If you've done everything correctly, you should be able to access the server at http://youriphere (ex: http://1.1.1.1).