Manage Your Server
This page assumes your are running a dedicated server running on a Docker container. If that isn't the case and don't know what you are doing, please refer to Host a Server page.
Mounting Config Files
Think of running an application in a Docker container like having a small computer within your actual computer. This little computer is programmed to run the game application and it has a 'memory freeze' function. This means that when you switch it off and then on again, it goes back to the way it was when you first set it up, like nothing ever changed. So, if you want to make sure that certain files keep their changes even after you've switched off this mini-computer, you need to perform an action called 'mounting'.
'Mounting' is like creating a special link between a file or a folder on your actual computer and the same file or folder inside the mini-computer. This link ensures that every time the mini-computer needs to use that file or folder, it uses the one on your actual computer instead. This way, any changes you make to that file or folder are kept safe, even when you turn off the mini-computer.
If you followed the Host a Server guide step by step, by this point you already did your first mount! Let's take a look again at the docker-compose file:
version: "3.7"
services:
unitystation:
image: unitystation/unitystation:develop
ports:
- 7777:7777/udp
- 7777:7777/tcp
- 7778:7778/tcp
environment:
SERVER_NAME: Unitystation - EU02 Staging
HUB_USERNAME: YOUR_USERNAME
HUB_PASSWORD: YOUR_PASSWORD
labels:
- io.portainer.accesscontrol.public
volumes:
- /root/staging/admin:/server/Unitystation_Data/StreamingAssets/admin
under the volumes key, at line 17, you can see how we are mounting the admin folder.
Here's how it works: write the path on your actual computer, add a colon (:), and then write the path inside the mini-computer. Make sure to follow this format each time you want to mount a file or folder. And, don't forget to check that the file or folder you want to mount exists on your real computer before you start the server!
In the next sections, we'll introduce you to a few files that could be useful to mount. It's all up to you! You can choose to mount some of them, all of them, or none at all. Enjoy customizing your server to suit your needs!
The "admin" Folder
Type: folder
Path in container: /server/Unitystation_Data/StreamingAssets/admin
This folder contains a lot of files related to moderation of the game. All files inside the folder are generated every time you run the game and they aren't found, so it is safe to mount an empty folder.
| Filename | Description |
|---|---|
| admin.txt | Here you write the UUID of the players you want to have admin power (see Adding Admins section) |
| automodconfig.json | Here you can enable or disable some auto mod features, such as spam prevention. |
| jobBanlist.json | This file isn't meant to be edited manually, although you can do it if you assume the risks. This file will persist job bans applied by admins during the game. |
| mentors.txt | Similar to admins.txt, you add UUIDs here to make those players mentors. Mentors have their own mentor chat and can help players with their gameplay questions. |
| permissions.toml | This file currently doesn't work. It is a WIP integration of a new more flexible permissions system that will replace admins.txt and mentors.txt |
| whitelist.txt | This file works the same as admins.txt and mentors.txt, but only the player's UUID you add here are going to be able to join your server. |
Maps Rotation File
Type: file
Path in container: /server/Unitystation_Data/StreamingAssets/maps.json
This file lets you choose which maps you want to rotate through during gameplay and how many players need to be playing for them to become available. Here's a sample of what the file's contents might look like, so you can customize your own:
{
"lowPopMaps":["MiniStation", "FallStation", "SquareStation"],
"medPopMaps":["MiniStation", "FallStation", "SquareStation", "OutpostStation"],
"highPopMaps": ["OutpostStation", "BoxStationV1"],
"medPopMinLimit":25,
"highPopMinLimit": 40
}
The map names here correspond to the scene options available in the game build you're using. If you've customized the build and added your own map, you can include it in this rotation. Just remember to use the file name of your map, minus the .unity extension.
Auto Mod Word Filter File
Type: file
Path in container: /server/Unitystation_Data/StreamingAssets/wordfilter.txt
You can add words, one per line, to this file if you want to censor them using the AutoMod feature and word filter enabled in automodconfig.json