Manage Your Server - Revision history

Gilles: updated path to files

2023-09-22T17:29:24Z

updated path to files

← Older revision		Revision as of 17:29, 22 September 2023
Line 82:		Line 82:
	- io.portainer.accesscontrol.public		- io.portainer.accesscontrol.public
	volumes:		volumes:
	- /root/staging/admin:/server/Unitystation_Data/StreamingAssets/~~admin~~		- /root/staging/admin:/server/Unitystation_Data/StreamingAssets/Config/Admin
	</syntaxhighlight>under the '''volumes''' key, at line 17, you can see how we are mounting the admin folder.		</syntaxhighlight>under the '''volumes''' key, at line 17, you can see how we are mounting the admin folder.

Line 94:		Line 94:
	'''Type:''' folder		'''Type:''' folder

	'''Path in container:''' /server/Unitystation_Data/StreamingAssets/~~admin~~		'''Path in container:''' /server/Unitystation_Data/StreamingAssets/Config/Admin


Line 125:		Line 125:
	'''Type:''' file		'''Type:''' file

	'''Path in container:''' /server/Unitystation_Data/StreamingAssets/maps.json		'''Path in container:''' /server/Unitystation_Data/StreamingAssets/Config/maps.json


Line 141:		Line 141:
	'''Type:''' file		'''Type:''' file

	'''Path in container:''' /server/Unitystation_Data/StreamingAssets/wordfilter.txt		'''Path in container:''' /server/Unitystation_Data/StreamingAssets/Config/Admin/wordfilter.txt

	If there are certain words you'd prefer to keep out of your game's chat, just add them to this file, one word per line. Once you enable the AutoMod feature and word filter in the '[[Manage Your Server#Auto Mod Word Filter File\|automodconfig.json]]' file, these words will be automatically censored.		If there are certain words you'd prefer to keep out of your game's chat, just add them to this file, one word per line. Once you enable the AutoMod feature and word filter in the '[[Manage Your Server#Auto Mod Word Filter File\|automodconfig.json]]' file, these words will be automatically censored.
Line 148:		Line 148:
	'''Type:''' file		'''Type:''' file

	'''Path in container:''' /server/Unitystation_Data/StreamingAssets/~~config~~/gameConfig.json		'''Path in container:''' /server/Unitystation_Data/StreamingAssets/Config/gameConfig.json


Line 263:		Line 263:
	'''Type:''' file		'''Type:''' file

	'''Path in container:''' /server/Unitystation_Data/StreamingAssets/~~config~~/serverDesc.txt		'''Path in container:''' /server/Unitystation_Data/StreamingAssets/Config/serverDesc.txt

	[[File:Server info motd.png\|left\|frameless\|457x457px]]		[[File:Server info motd.png\|left\|frameless\|457x457px]]
Line 285:		Line 285:
	'''Type:''' file		'''Type:''' file

	'''Path in container:''' /server/Unitystation_Data/StreamingAssets/~~config~~/serverRules.txt		'''Path in container:''' /server/Unitystation_Data/StreamingAssets/Config/serverRules.txt

	This file works exactly the same as the server description file, but for the rules tab. You can also use [http://digitalnativestudios.com/textmeshpro/docs/rich-text/ TextMeshPro tags] here.		This file works exactly the same as the server description file, but for the rules tab. You can also use [http://digitalnativestudios.com/textmeshpro/docs/rich-text/ TextMeshPro tags] here.
	[[Category:Technical Guides]]		[[Category:Technical Guides]]

Gilles: replaced develop tag with stable for the example server configuration

2023-06-16T01:59:24Z

replaced develop tag with stable for the example server configuration

← Older revision		Revision as of 01:59, 16 June 2023
Line 70:		Line 70:
	services:		services:
	unitystation:		unitystation:
	image: unitystation/unitystation:~~develop~~		image: unitystation/unitystation:stable
	ports:		ports:
	- 7777:7777/udp		- 7777:7777/udp

Gilles: added category

2023-06-03T08:56:11Z

added category

← Older revision		Revision as of 08:56, 3 June 2023
Line 288:		Line 288:

	This file works exactly the same as the server description file, but for the rules tab. You can also use [http://digitalnativestudios.com/textmeshpro/docs/rich-text/ TextMeshPro tags] here.		This file works exactly the same as the server description file, but for the rules tab. You can also use [http://digitalnativestudios.com/textmeshpro/docs/rich-text/ TextMeshPro tags] here.
			[[Category:Technical Guides]]

Gilles: corrected images

2023-06-03T08:54:46Z

corrected images

← Older revision		Revision as of 08:54, 3 June 2023
Line 8:		Line 8:
	</syntaxhighlight>Docker compose always pulls the latest version of the container image before running the application.		</syntaxhighlight>Docker compose always pulls the latest version of the container image before running the application.

	If you prefer a visual way and managed to install Portainer, as explained in our [[Host a Server\|Host a Server guide]], you can simply click on the container and press the '''"Recreate"''' button.		If you prefer a visual way and managed to install Portainer, as explained in our [[Host a Server\|Host a Server guide]], you can simply click on the container and press the '''"Recreate"''' button

			.
	[[File:Recreate button.png\|frameless\|749x749px]]		[[File:Recreate button.png\|frameless\|749x749px]]

	Then toggle '''"Re-pull image"'''		Then toggle '''"Re-pull image"'''

Gilles: added section about updating the server version

2023-06-03T08:54:06Z

added section about updating the server version

← Older revision		Revision as of 08:54, 3 June 2023
Line 1:		Line 1:
	~~{{Work In Progress}}~~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\|Host a Server page.]]		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\|Host a Server page.]]

			== Updating The Server Version ==
			Since you are running a Docker container, assuming you are using '''"develop"''' as the tag, all you have to do to update to latest version of "develop" is just recreating the container.

			If you are doing it manually, just use the command <syntaxhighlight lang="bash">
			docker compose up
			</syntaxhighlight>Docker compose always pulls the latest version of the container image before running the application.

			If you prefer a visual way and managed to install Portainer, as explained in our [[Host a Server\|Host a Server guide]], you can simply click on the container and press the '''"Recreate"''' button.
			[[File:Recreate button.png\|frameless\|749x749px]]
			Then toggle '''"Re-pull image"'''

			[[File:Repull.png\|frameless\|429x429px]]


			It is possible to automate server updates by using a container like [https://containrrr.dev/watchtower/ Watchtower]. Please refer to their documentation for installation steps, just remember to change the poll interval, since by default Watchtower checks for new version every 24 hours.

	== Environmental Variables ==		== Environmental Variables ==

Gilles: added environmental variables for server configuration

2023-06-03T08:41:38Z

added environmental variables for server configuration

@@ Line 1: / Line 1: @@
 {{Work In Progress}}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|Host a Server page.]]
 == Mounting Config Files ==
@@ Line 200: / Line 240: @@
 |If the avergage FPS of the server are this amount or lower, the server will auto restart when the round ends.
 |}

Gilles: added game config file guide

2023-06-03T08:10:45Z

added game config file guide

@@ Line 27: / Line 27: @@
 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!
@@ Line 82: / Line 84: @@
 '''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
+	"PreRoundTime": 120,

Gilles: first iteration of the config files tutorial

2023-06-03T07:44:56Z

first iteration of the config files tutorial

New page

{{Work In Progress}}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|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|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:<syntaxhighlight lang="yaml" line="1" start="1">
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
</syntaxhighlight>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.
{| class="wikitable"
|+These are the files you can find inside the 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:<syntaxhighlight lang="json" line="1">
{
"lowPopMaps":["MiniStation", "FallStation", "SquareStation"],
"medPopMaps":["MiniStation", "FallStation", "SquareStation", "OutpostStation"],
"highPopMaps": ["OutpostStation", "BoxStationV1"],
"medPopMinLimit":25,
"highPopMinLimit": 40
}
</syntaxhighlight>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