Host a Server - Revision history

Gilles: Marked this version for translation

2024-05-05T03:07:46Z

Marked this version for translation

Gilles at 03:07, 5 May 2024

2024-05-05T03:07:09Z

← Older revision		Revision as of 03:07, 5 May 2024
Line 1:		Line 1:
			<Languages />
			<translate>
	So you want to host a Unitystation server? That's awesome! Let me guide you through the process step-by-step in this article. There are several options for hosting your server, so make sure to jump to the section that best fits your situation.'''[[Category:Technical Guides]]'''		So you want to host a Unitystation server? That's awesome! Let me guide you through the process step-by-step in this article. There are several options for hosting your server, so make sure to jump to the section that best fits your situation.'''[[Category:Technical Guides]]'''

Line 88:		Line 90:

	Now you possibly want to further manage your server, change config files, add admins, etc. Please refer to [[Manage Your Server\|the following page to read more about it]].		Now you possibly want to further manage your server, change config files, add admins, etc. Please refer to [[Manage Your Server\|the following page to read more about it]].
			</translate>

Gilles: replaced develop with stable tag for example server config

2023-06-16T01:58:31Z

replaced develop with stable tag for example server config

← Older revision		Revision as of 01:58, 16 June 2023
Line 38:		Line 38:
	services:		services:
	unitystation:		unitystation:
	image: unitystation/unitystation:~~develop~~		image: unitystation/unitystation:stable
	ports:		ports:
	- 7777:7777/udp		- 7777:7777/udp
Line 53:		Line 53:
	</syntaxhighlight>Don't let it intimidate you, we will explain now what matters the most in there.		</syntaxhighlight>Don't let it intimidate you, we will explain now what matters the most in there.

	'''image''' key determines what version of the game will be used. You can replace '''~~develop~~''' with a build number if you want to use a specific version or leave it as '''~~develop~~''' to be on the latest available version, on par with our [[Staging Servers]]. Find all the versions we have published so far on our [https://hub.docker.com/repository/docker/unitystation/unitystation/general Docker Hub page]		'''image''' key determines what version of the game will be used. You can replace '''stable''' with a build number if you want to use a specific version or leave it as '''stable''' to be on the latest available version. If you want to be on the absolute latest version, on par with our [[Staging Servers]], you can use '''develop''' instead. Find all the versions we have published so far on our [https://hub.docker.com/repository/docker/unitystation/unitystation/general Docker Hub page]

Gilles: removed work in progress template

2023-06-03T08:57:25Z

removed work in progress template

← Older revision		Revision as of 08:57, 3 June 2023
Line 1:		Line 1:
	~~{{Work In Progress}}~~

	So you want to host a Unitystation server? That's awesome! Let me guide you through the process step-by-step in this article. There are several options for hosting your server, so make sure to jump to the section that best fits your situation.'''[[Category:Technical Guides]]'''		So you want to host a Unitystation server? That's awesome! Let me guide you through the process step-by-step in this article. There are several options for hosting your server, so make sure to jump to the section that best fits your situation.'''[[Category:Technical Guides]]'''

Gilles: adds link to page with more information about managing your server

2023-06-03T06:56:08Z

adds link to page with more information about managing your server

← Older revision		Revision as of 06:56, 3 June 2023
Line 85:		Line 85:
	[[File:Host a server 1 4.png\|center]]		[[File:Host a server 1 4.png\|center]]
	Pretty convenient, isn't it?		Pretty convenient, isn't it?

			====== Further managing your server ======
			At this point, you should have a running server and be able to join it. If you experience any issue, don't hesitate to ask on our discord help or developer channel.

			Now you possibly want to further manage your server, change config files, add admins, etc. Please refer to [[Manage Your Server\|the following page to read more about it]].

Gilles: added hub related environmental variables and its description

2023-06-03T06:48:46Z

added hub related environmental variables and its description

← Older revision		Revision as of 06:48, 3 June 2023
Line 47:		Line 47:
	environment:		environment:
	SERVER_NAME: Unitystation - EU02 Staging		SERVER_NAME: Unitystation - EU02 Staging
			HUB_USERNAME: YOUR_USERNAME
			HUB_PASSWORD: YOUR_PASSWORD
	labels:		labels:
	- io.portainer.accesscontrol.public		- io.portainer.accesscontrol.public
Line 55:		Line 57:
	'''image''' key determines what version of the game will be used. You can replace '''develop''' with a build number if you want to use a specific version or leave it as '''develop''' to be on the latest available version, on par with our [[Staging Servers]]. Find all the versions we have published so far on our [https://hub.docker.com/repository/docker/unitystation/unitystation/general Docker Hub page]		'''image''' key determines what version of the game will be used. You can replace '''develop''' with a build number if you want to use a specific version or leave it as '''develop''' to be on the latest available version, on par with our [[Staging Servers]]. Find all the versions we have published so far on our [https://hub.docker.com/repository/docker/unitystation/unitystation/general Docker Hub page]

	~~'''SERVER_NAME''' environment variable is how your server will be displayed in the server list~~ ([[Host a Server#Appearing in the Server List\|see above to read about it]])
			if you do have hub credentials provided by [[User:Gilles\|Gilles]] over Discord ([[Host a Server#Appearing in the Server List\|see above to read about it]]), you can set the following environmental variables in your docker-.compose file:

			'''SERVER_NAME''' is how your server will be displayed in the server list.

			'''HUB_USERNAME''' you provided while interviewed to be whitelisted on Discord.

			'''HUB_PASSWORD''' is the token you got back in the same interview.

	'''labels''' key is to give Portainer control over this container. Learn about Portainer in the next optional step.		'''labels''' key is to give Portainer control over this container. Learn about Portainer in the next optional step.

Gilles at 19:34, 5 March 2023

2023-03-05T19:34:43Z

← Older revision		Revision as of 19:34, 5 March 2023
Line 69:		Line 69:
	docker compose down		docker compose down
	</syntaxhighlight>Pretty simple, isn't it?		</syntaxhighlight>Pretty simple, isn't it?

			====== Installing Portainer ======
			Portainer is another container that will host a web interface to manage your containers. From here you can easily start, stop, update your Unitystation servers just by clicking buttons.

			To install Portainer, read their [https://docs.portainer.io/start/install-ce/server/docker/linux official guide]. By the end, you will have a graphical interface that looks like this:
			[[File:Host a server 1 4.png\|center]]
			Pretty convenient, isn't it?

Gilles at 18:49, 5 March 2023

2023-03-05T18:49:58Z

@@ Line 13: / Line 13: @@
 After the port forwarding is done, just follow these steps:
-====== I. Run [[StationHub Launcher]] ======
+====== Run [[StationHub Launcher]] ======
 [[File:Host server 1 1.png|center]]
-====== II. Go to Installations tab ======
+====== Go to Installations tab ======
 From here you can run any version of the game you have downloaded without joining a server. If your installations tab is empty, try joining a server first to get their version of the game or manually find the version you want from our CDN following this pattern: '''<nowiki>https://unitystationfile.b-cdn.net/UnityStationDevelop/{PLATFORM}/{VERSION</nowiki> NUMBER}.zip''' where {'''PLATFORM'''} can be one of "'''linuxserver'''", "'''StandaloneLinux64'''", "'''StandaloneOSX'''" or "'''StandaloneWindows64'''". We apologize for any inconvenience caused by the current distribution method, but we plan to improve it for servers in the future.
@@ Line 22: / Line 22: @@
 [[File:Host server 1 2.png|center|asdsd]]
-====== III. Once inside the game ======
+====== Once inside the game ======
 Simply click on '''HOST''' and that's it! Yeah, really! Now you just need to give your friends your '''public IP''' and make them launch the game following steps I to II but choose  '''JOIN''' instead in the third step and fill in the given '''public IP''' and the 7777 port.
 [[File:Host server 1 3.png|center]]

Gilles at 17:52, 5 March 2023

2023-03-05T17:52:50Z

← Older revision		Revision as of 17:52, 5 March 2023
Line 17:		Line 17:

	====== II. Go to Installations tab ======		====== II. Go to Installations tab ======
	From here you can run any version of the game you have downloaded without joining a server. If your installations tab is empty, try joining a server first to get their version of the game or manually find the version you want from our CDN following this pattern: '''<nowiki>https://unitystationfile.b-cdn.net/UnityStationDevelop/{PLATFORM}/{VERSION</nowiki> NUMBER}.zip''' where {'''PLATFORM'''} can be one of "'''linuxserver'''", "'''StandaloneLinux64'''", "'''StandaloneOSX'''" or "'''StandaloneWindows64'''". We ~~will improve~~ the ~~way~~ we ~~distribute the game~~ for servers in the future~~, sorry for the inconvenience~~.		From here you can run any version of the game you have downloaded without joining a server. If your installations tab is empty, try joining a server first to get their version of the game or manually find the version you want from our CDN following this pattern: '''<nowiki>https://unitystationfile.b-cdn.net/UnityStationDevelop/{PLATFORM}/{VERSION</nowiki> NUMBER}.zip''' where {'''PLATFORM'''} can be one of "'''linuxserver'''", "'''StandaloneLinux64'''", "'''StandaloneOSX'''" or "'''StandaloneWindows64'''". We apologize for any inconvenience caused by the current distribution method, but we plan to improve it for servers in the future.

	Click on '''Launch''' on the selected version of the game.		Click on '''Launch''' on the selected version of the game.

Gilles at 17:49, 5 March 2023

2023-03-05T17:49:18Z

← Older revision		Revision as of 17:49, 5 March 2023
Line 9:		Line 9:
	Good news, it's pretty easy to set up! The Unitystation client doubles as a server, so you can host and play using a single instance of the game on your own computer.		Good news, it's pretty easy to set up! The Unitystation client doubles as a server, so you can host and play using a single instance of the game on your own computer.

	To do this, you'll need to make sure you've opened ~~ports~~ on your router to allow incoming connections~~, just like with any other game~~. The specific steps to achieve this depend on your router brand, among other factors, so you'll need to do some googling. Try searching for "Portforwarding [YOUR ROUTER BRAND]" to get started.		To do this, you'll need to make sure you've opened '''7777''' port on your router to allow incoming connections. The specific steps to achieve this depend on your router brand, among other factors, so you'll need to do some googling. Try searching for "Portforwarding [YOUR ROUTER BRAND]" to get started.

	After the port forwarding is done, just follow these steps:		After the port forwarding is done, just follow these steps:

	====== Run [[StationHub Launcher]] ======		====== I. Run [[StationHub Launcher]] ======
	[[File:Host server 1 1.png\|center]]		[[File:Host server 1 1.png\|center]]

	====== Go to Installations tab ======		====== II. Go to Installations tab ======
	From here you can run any version of the game you have downloaded without joining a server. If your installations tab is empty, try joining a server first to get their version of the game or manually find the version you want from our CDN following this pattern: '''<nowiki>https://unitystationfile.b-cdn.net/UnityStationDevelop/{PLATFORM}/{VERSION</nowiki> NUMBER}.zip''' where {PLATFORM} can be one of "linuxserver", "StandaloneLinux64", "StandaloneOSX" or "StandaloneWindows64". We will improve the way we distribute the game for servers in the future, sorry for the inconvenience.		From here you can run any version of the game you have downloaded without joining a server. If your installations tab is empty, try joining a server first to get their version of the game or manually find the version you want from our CDN following this pattern: '''<nowiki>https://unitystationfile.b-cdn.net/UnityStationDevelop/{PLATFORM}/{VERSION</nowiki> NUMBER}.zip''' where {'''PLATFORM'''} can be one of "'''linuxserver'''", "'''StandaloneLinux64'''", "'''StandaloneOSX'''" or "'''StandaloneWindows64'''". We will improve the way we distribute the game for servers in the future, sorry for the inconvenience.

			Click on '''Launch''' on the selected version of the game.
	[[File:Host server 1 2.png\|center\|asdsd]]		[[File:Host server 1 2.png\|center\|asdsd]]

			====== III. Once inside the game ======
			Simply click on '''HOST''' and that's it! Yeah, really! Now you just need to give your friends your '''public IP''' and make them launch the game following steps I to II but choose '''JOIN''' instead in the third step and fill in the given '''public IP''' and the 7777 port.
			[[File:Host server 1 3.png\|center]]