4. Docker Setup

If you have any trouble following the guide. Please send us a message in Discord we are more than happy to help you out!

4.1 Requirements and prerequisites

• GIT installed in your system;
• GIT LFS installed in your system;
• Docker and Docker-Compose installed in your system;
• Broadband internet connection;
• Router with the ability to port forward;
• Min. 2 GB RAM;
• Min. 64-bit Windows 10 Operating System.

4.2 System Setup

4.2.1 Post-Installing Docker

After installation, restart your computer if necessary. Then open the Docker Dashboard by right-clicking the docker icon on the bottom right of your screen, or open Docker using your start menu. Depending on your OS and/or updates you may be asked to install "WSL 2". Make sure you do this as well.

4.3 Setting up the container

4.3.1 Choosing a location on your computer/server

It is recommended to place the server in your documents or on your desktop for ease of access.

Open Windows Explorer where you would like to place the server and right click somewhere. Click the option "Git Bash Here".

This will open a command line in the location you right-clicked. From here, execute the commands in the next chapters.

4.3.2 Downloading the container

Downloading the container can be done by either using git (recommended), or by clicking the green code button on this page and using the Download ZIP option on the Docker Image Github.

To download the container configuration using git, use the command below:

git clone https://github.com/Uuvana-Studios/longvinter-docker-server.git

When the clone is finished, enter the directory the git command created:

cd longvinter-docker-server

4.3.3 Creating the data directory

In order to keep game progress between container restarts a data directory needs to be created. Create this directory in the same directory as the docker-compose.yaml file. Use the following commands to create the directory and set the appropriate rights.

mkdir data

4.3.4 Configuring the server settings

The server settings can be changed by opening the docker-compose.yaml file. Use either Notepad or a more advanced text editor such as Notepad++. Do not open the configuration using WordPad or Word! Settings that may be changed are shown below:

With the default values above, the environment part of the docker-compose.yaml file should look like this:

  environment:
    CFG_SERVER_NAME: "Unnamed Island"
    CFG_MAX_PLAYERS: "32"
    CFG_SERVER_MOTD: "Welcome to Longvinter Island!"
    CFG_PASSWORD: ""
    CFG_COMMUNITY_WEBSITE: "www.longvinter.com"
    CFG_ADMIN_STEAM_ID: ""
    CFG_ENABLE_PVP: "true"
    CFG_GAME_PORT: "7777"
    CFG_QUERY_PORT: "27016"

4.3.5 Changing the port numbers

In order to run the server with different port numbers than the default ports 7777 and 27016, the new port numbers have to be edited in two places in the docker-compose.yaml file.

  ports:
    - "7777:7777"
    - "27016:27016"

  environment:
    CFG_GAME_PORT: "7777"
    CFG_QUERY_PORT: "27016"

4.4 Starting the container

When the setup and configuration is done, the container is ready to be started. Open the command line and navigate to the directory (using the cd command) that contains the Dockerfile, docker-compose.yaml and run.sh files.

Start the container using the following command:

docker-compose up -d

This command will do the following:

1. Build the container image (if not present)
2. Create the container
3. Start the container
4. Run the included startup script (run.sh) inside the container
   1. Clone or update the longvinter-linux-server repository
   2. Create or update the Game.ini file with the settings provided in the docker-compose.yaml file
5. Start the Longvinter server

4.5 Stopping the container

To stop the container, run the command below. Note that this removes the container from Docker, but the save data will be saved in the data directory and will be loaded when the server is started again next time.

docker-compose down

4.6 Updating the container

When a new version of the container is released, make sure to update the files using git pull, or manually update the files by downloading the code as ZIP from Github. Run the command below to build the new container image and restart the container.

docker-compose up -d --build

4.7 Updating the Longvinter server

Updating the Longvinter server is as easy as restarting the container:

docker-compose restart

4.8 Running multiple Longvinter containers on one Docker server

Running multiple Longvinter containers on one Docker server is very easy. Follow the Setting up the container steps again, but this time set up the server to use a different directory for the new server.

git clone https://github.com/Uuvana-Studios/longvinter-docker-server.git new-name-here

4.9 Open Ports

You also need to open ports on your home router to allow traffic go through. This process is greatly different from what type of router you have. It is recommended to look in the manual provided by the manufacturer or contact your ISP for instructions.

• For Steam open: 27015 & 27016 (TCP and UDP)
• For Unreal Engine open: 7777 (UDP Only)

In some cases, opening the ports in your home router is not enough. In that case you usually also need to allow the ports in your software firewall. Windows has a built-in firewall, but some antivirus packages also include a firewall feature. For changing the settings on your antivirus firewall, look for instructions online or contact the developer directly.

4.9.1 Setting ports rules on Windows Firewall

In order to open the ports in the included Windows Firewall, follow the steps below:

1. Open the Start Menu and search for "Windows Defender Firewall with Advanced Security", or the equivalent in your language.

2. Right-click the Inbound Rules option on the left side and choose New Rule...

3. In the window that opens, select the Port option and click Next.

4. Next, enter the port that you wish to forward, select the correct protocol (TCP or UDP) and click Next.

5. Make sure "Allow the connection" is selected and click Next.

6. Make sure all options are selected and click Next.

7. Give the firewall rule a recognizable name (Such as Longvinter [port]) and click Finish.

Make sure to repeat steps 2-7 for each port that needs to be openend in the firewall.