How to Install Terraria tModLoader on Your Synology NAS

How to Install Terraria tModLoader on Your Synology NAS

Terraria is a 2D action-adventure, open-world sandbox / platformer in which the player controls a single character in a pre-generated world. Dig, Fight, and Build your way through the world of player-created mods on Terraria with tModLoader – this DLC makes modding Terraria a reality! In this step by step guide I will show you how to install the Terraria tModLoader Server on your Synology NAS using Docker & Portainer.

  • STEP 1

Please Support My work by Making a Donation.

  • STEP 2

⚠️Note: It’s Mandatory to have the original Terraria game installed on your PC.

  • STEP 3

⚠️Note: It’s Mandatory to have tModLoader installed on your PC.

  • STEP 4

Install Text Editor via Synology “Package Center”. If you already have Text Editor installed on your Synology NAS, skip this STEP.

Synology Install Text Editor 2023

  • STEP 5

Install Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

  • STEP 6

Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it terrariaworlds. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Terraria tModLoader Server Synology NAS Set up 1

  • STEP 7

Download (click on the blue link below) then upload the enabled.json file below in the terraria-tmodloader folder that you have previously created at STEP 6. Follow the instructions in the image below. 🔒Note: Support my work to unlock the password. You can use this password to download any file on mariushosting forever!

👉🏻enabled.json

Terraria tModLoader Server Synology NAS Set up 2

  • STEP 8

Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.

1 Synology Portainer Add Stack

  • STEP 9

In the Name field type in tmodloader. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

version: "3.9"
services:
  terraria-tmodloader-server:
    image: hexlo/terraria-tmodloader-server:latest
    container_name: Terraria-tModLoader
    hostname: terraria-tmodloader-server
    stdin_open: true
    tty: true
    mem_limit: 6g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    ports:
      - 7782:7777
    volumes:
      - /volume1/docker/terraria-tmodloader:/root/.local/share/Terraria/ModLoader/Worlds/:rw
      - /volume1/docker/terraria-tmodloader/enabled.json:/root/.local/share/Terraria/ModLoader/Mods/enabled.json:ro
    environment:
      world: /root/.local/share/Terraria/ModLoader/Worlds/MyModWorld.wld
      autocreate: 3       # 1(small), 2(medium), 3(large)
      difficulty: 0       # 0(normal), 1(expert), 2(master), 3(journey)
      secure: 1           # 1(no cheats), 0(cheats allowed)
      language: en/US     # or en/US or de/DE
      maxplayers: 8
      worldname: MyModWorld
      password: mariushosting
      motd: Welcome to mariushosting Terraria tModLoader server!
    restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value for language. Examples: en_US for English, de_DE for German, fr_FR for French etc. (Select your current Default Language from this list.)
Note: Before you paste the code above in the Web editor area below, change the value for worldname. Choose a name for your world. MyModWorld is an example of a World name.
Note: Before you paste the code above in the Web editor area below, change the value for password. Type in your own password. mariushosting is an example for a password.
Note: Before you paste the code above in the Web editor area below, change the value for motd. Type in your own welcome message to the World Server. Welcome to mariushosting Terraria tModLoader server! is an example for a welcome message.

Terraria tModLoader Server Synology NAS Set up 3

  • STEP 10

Scroll down on the page until you see a button named Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.

Terraria tModLoader Server Synology NAS Set up 4

  • STEP 11

If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“.

Terraria tModLoader Server Synology NAS Set up 5

  • STEP 12

Go back to STEP 1 or you will deal with karma 🙂

  • STEP 13

Wait approximately 5 minutes until the world server is completely installed.

  • STEP 14

Open your Terraria tModLoader game (STEP 3) on your computer. Click Multiplayer. Follow the instructions in the image below.

Terraria tModLoader Server Synology NAS Set up 6

  • STEP 15

Click Join via IP. Follow the instructions in the image below.

Terraria tModLoader Server Synology NAS Set up 7

  • STEP 16

Type in your own NAS IP. Follow the instructions in the image below.

Terraria tModLoader Server Synology NAS Set up 8

  • STEP 17

Type in 7782 as the Server Port. Follow the instructions in the image below.

Terraria tModLoader Server Synology NAS Set up 9

  • STEP 18

Type in the server Password that you have previously created at STEP 9. Follow the instructions in the image below.

Terraria tModLoader Server Synology NAS Set up 10

  • STEP 19

Wait until your Mod is loaded. Follow the instructions in the image below.

Terraria tModLoader Server Synology NAS Set up 11

  • STEP 20

Your own Terraria tModLoader Game Server at a glance!

Terraria tModLoader Server Synology NAS Set up 12

  • STEP 21

To enable or disable mods on the server, modify the enabled.json file in File Station with the names of the mods (the exact names as below). Some mods may clash with each others, especially big content mods. Mods include: AlchemistNPC, AlchemistNPClite, BossChecklist, CalamityMod, CalamityMusicMod, ExtensibleInventory, Fargowiltas, FargowiltasSouls, FargowiltasSoulsDLC, MagicStorageExtra, RecipeBrowser, SpiritMod, TerrariaOverhaul, ThoriumMod, Tremor, WingSlot, WMITF.
Note: To be able to edit the enabled.json file, you will need Text Editor installed on your Synology NAS as per the instructions at STEP 4.
Note: After you edit and save the enabled.json file, it’s mandatory to restart the Terraria-tModLoader container to apply the changes.

Terraria tModLoader Server Synology NAS Set up 13

Enjoy Terraria tModLoader Server!

Note: Can I run Docker on my Synology NAS? See the supported models.
Note: Find out how to update the Terraria tModLoader container with the latest image.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.

This post was updated on Sunday / June 25th, 2023 at 1:20 AM