Hosting a Godot Server on a Linux Server With HTTPS

In this guide, we will walk you through the process of hosting a Godot server on a Linux server. This will allow you to run multiplayer games and interactive applications powered by the Godot game engine.

Prerequisites

Before we start, make sure you have the following prerequisites:

• A Linux server (you can use popular cloud providers like AWS, DigitalOcean, or a VPS)
• Basic knowledge of working with a Linux terminal
• A domain name that you want to associate with your server (e.g., example.xyz)

Step 1: Export Your Godot Server

First, export your Godot server project to a Linux-compatible .pck file.

Step 2: Upload the .pck File

Transfer the .pck file to your Linux server. You can use Filezilla or any other file transfer method you are comfortable with.

Step 3: Download Godot Server

Download the correct version of Godot server binary for Linux :

curl -O -L https://github.com/godotengine/godot/releases/download/3.5.1-stable/Godot_v3.5.1-stable_linux_server.64.zip

Step 4: Install Unzip

If you don’t have unzip installed, you can do so with:

sudo apt install unzip

Step 5: Unzip Godot Server

Unzip the downloaded Godot server:

unzip Godot_v3.5.1-stable_linux_server.64.zip

Step 6: Run Godot Server

Test your Godot server using the .pck file and check if it’s running:

./Godot_v3.5.1-stable_linux_server.64 --main-pack linux.pck

Step 7: Install Nginx

Install the Nginx web server on your Linux server:

sudo apt install nginx

Step 8: Configure Nginx

Create a symbolic link to your Nginx site configuration:

ln -s /etc/nginx/sites-available/example.xyz /etc/nginx/sites-enabled/

Step 9: Edit Nginx Configuration

Edit your Nginx site configuration file:

-Check your port first-

nano /etc/nginx/sites-available/example.xyz

server {
    listen 80;
    server_name example.xyz;  # Replace with your domain or server IP

    location / {
        default_type text/html;
        return 200 'Hello Gamers!';
    }

    location /game {
        proxy_pass http://localhost:8080/;  # Redirect requests to your application
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }

}

Ensure that your Nginx configuration points to your Godot server.

Step 10: Test Nginx Configuration

Check your Nginx configuration for syntax errors:

sudo nginx -t

Step 11: Reload Nginx

Reload Nginx to apply the new configuration:

sudo systemctl reload nginx

Step 12: Install Certbot

Install Certbot and the Nginx plugin for Let’s Encrypt:

sudo apt install certbot python3-certbot-nginx

Step 13: Obtain SSL Certificate

Obtain an SSL certificate for your domain (replace example.xyz with your domain):

sudo certbot --nginx -d example.xyz

Your Godot server should now be up and running securely with HTTPS.

Step 14: Test Your Godot Server with WebSocket Tester (Using the “Pie Socket” Extension)

To confirm that your Godot server is working as expected, you can use a WebSocket testing tool like the “Pie Socket” extension in your browser. Follow these steps:

1. Open your web browser (Google Chrome recommended).
2. Install the “Pie Socket” extension if you haven’t already. You can find this extension in the Chrome Web Store.
3. Launch the “Pie Socket” extension from your browser’s toolbar or extensions menu.
4. In the “Pie Socket” extension, enter the WebSocket URL for your Godot server. This URL will typically be in the format wss://example.xyz/game.
5. Click the “Connect” button within the extension.
6. You can send WebSocket messages and receive responses to verify that your server is handling WebSocket connections correctly. This step allows you to test the functionality of your Godot server in real-time.