TShock — Terraria server

[tachy]

Hey everyone !

I've packaged TShock for Cloudron. TShock is a Terraria server. It adds user/group management, anti-cheat, protected regions, a SQLite database, and a full REST API on top of the vanilla Terraria dedicated server.

TShock source: https://github.com/Pryaxis/TShock
Package: https://github.com/EliottGoye/cloudron-tshock

Installation

Clone and install :

git clone https://github.com/EliottGoye/cloudron-tshock
cd tshock-cloudron
cloudron install -p GAME_PORT=7777

How it works

• Game port (TCP) — exposed via tcpPorts, configurable at install time. Point your Terraria client at your-cloudron-ip:GAME_PORT.
• REST API (port 7878) — served through the standard Cloudron HTTPS proxy at your app domain. The health check uses /v2/server/status.
• Persistent data in /app/data/:
  • tshock/ — config, SQLite database, logs, backups
  • worlds/ — world files
  • plugins/ — drop .dll plugin files here and restart to load them

On first start a world is auto-created (large size) and a superadmin REST token is written to /app/data/rest-api-credentials.txt. Retrieve it with cloudron exec.

First-time admin setup: check the app logs for the /setup <token> line, connect with a Terraria client, and run /setup <token> in chat.

Notes

• Tested with TShock 6.1 / Terraria 1.4.5.6 / Cloudron 9.2.0
• Memory limit set to 2 GB (world generation is hungry, afterward 1 GB is fine)
• TERRARIA_PASSWORD env var can be set to require a server password
• The image uses ghcr.io/pryaxis/tshock with a pined version
• I should connect Renovate to auto update the image and build a CloudronVersions.json, but I might be too lazy for that

Feedback welcome!

[james]

Hello @tachy
If you want to make this a community app you will have to add / generate the CloudronVersions.json.
See https://docs.cloudron.io/packaging/publishing.
With that, we can also add your app to the list https://forum.cloudron.io/topic/15172/community-apps

[tachy]

Done ! Pushed to image to GitHub registry and generated the config file.
I had to build the image twice with cloudron build and docker build/push then I could cloudron versions add AND change the path to the image in the CloudronVersions.json to use the image in the GitHub registry.

Have I missed something, or could it be easier to use a different Docker registry ?

Here is the CloudronVersions.json : https://raw.githubusercontent.com/EliottGoye/cloudron-tshock/refs/heads/main/CloudronVersions.json

[james]

Hello @tachy
Thank you.
I have updated the list with your community app.

[User123456]

Not working on Cloudron demo

[james]

Hello @user123456
I think that message in the browser is actually a working message.
If I understood this app correctly, you need to follow the first steps:

First start:

Check the logs to get the /setup code
Connect to the Terraria server and run /setup <code>
Your REST superadmin token is in /app/data/rest-api-credentials.txt

I have no terraria server, so I can't validate that.
Did you do this?

[User123456]

@james I just saw that the app someone has installed, I did not and did not want to try it and it did not work or I understand the principle behind it not I assumed that there is a webgui.

[tachy]

I'm the one who deployed to the demo instance to test if the image/manifest could be pulled from an instance without credentials.
And yes, the HTTP endpoint returns a 404 because it's a REST API.
You can fetch the server status even without a token :

curl https://terraria.demo.cloudron.io/v2/server/status
{
  "status": "200",
  "name": "",
  "serverversion": "v1.4.5.6",
  "tshockversion": "6.1.0.0",
  "port": 7777,
  "playercount": 0,
  "maxplayers": 16,
  "world": "World",
  "uptime": "0.02:02:19",
  "serverpassword": false
}