Server on Linux - Revision history

Hikingpete: /* Docker */ Include information on running Eco Server with Docker Compose.

2025-04-07T20:39:32Z

Docker: Include information on running Eco Server with Docker Compose.

@@ Line 172: / Line 172: @@
 You will need to make sure that the Docker container is exposing the ports and map them to ports on the host that are open in the hosts firewall and router.
 ==Troubleshooting==
 ===Missing GDI library===

172.71.126.191: Undo revision 12825 (obvious typo) by 172.68.194.152 (talk)

2024-10-08T19:54:28Z

Undo revision 12825 (obvious typo) by 172.68.194.152 (talk)

← Older revision		Revision as of 21:54, 8 October 2024
Line 5:		Line 5:

	To install the required packages for Linux, use:<syntaxhighlight lang="bash">		To install the required packages for Linux, use:<syntaxhighlight lang="bash">
	./install.~~shdsad~~		./install.sh
	</syntaxhighlight>This will install the following packages:		</syntaxhighlight>This will install the following packages:
	* [https://www.mono-project.com/docs/gui/libgdiplus/ libgdiplus]		* [https://www.mono-project.com/docs/gui/libgdiplus/ libgdiplus]

172.68.194.152: /* Prerequisites */

2024-09-19T20:22:01Z

Prerequisites

← Older revision		Revision as of 22:22, 19 September 2024
Line 5:		Line 5:

	To install the required packages for Linux, use:<syntaxhighlight lang="bash">		To install the required packages for Linux, use:<syntaxhighlight lang="bash">
	./install.sh		./install.shdsad
	</syntaxhighlight>This will install the following packages:		</syntaxhighlight>This will install the following packages:
	* [https://www.mono-project.com/docs/gui/libgdiplus/ libgdiplus]		* [https://www.mono-project.com/docs/gui/libgdiplus/ libgdiplus]

StalEF at 06:26, 9 July 2024

2024-07-09T06:26:11Z

← Older revision		Revision as of 08:26, 9 July 2024
Line 11:		Line 11:
	* [https://www.gnu.org/software/libc/libc.html libc6-dev]		* [https://www.gnu.org/software/libc/libc.html libc6-dev]
	== Eco Dedicated Server files ==		== Eco Dedicated Server files ==
	There are two primary options for acquisition of the Eco dedicated server: getting it directly from ~~Strange Loop Games~~, or through Valve Software's Steam platform.		There are two primary options for acquisition of the Eco dedicated server: getting it directly from {{SLG}}, or through Valve Software's Steam platform.
	=== Steam Command-Line Client ===		=== Steam Command-Line Client ===
	==== Getting SteamCMD ====		==== Getting SteamCMD ====
	The ECO Dedicated Server is made available through Valve Software's [https://steampowered.com Steam] distribution system, and Valve provides a command-line tool called [https://developer.valvesoftware.com/wiki/SteamCMD SteamCMD] to facilitate command-line installation of products in various environments, including Linux. Follow the directions on the foregoing link to get the SteamCMD program installed and configured on your system. You will ''not'' need SteamCMD if you are acquiring the Eco Dedicated Server directly from ~~Strange Loop Games~~.		The ECO Dedicated Server is made available through Valve Software's [https://steampowered.com Steam] distribution system, and Valve provides a command-line tool called [https://developer.valvesoftware.com/wiki/SteamCMD SteamCMD] to facilitate command-line installation of products in various environments, including Linux. Follow the directions on the foregoing link to get the SteamCMD program installed and configured on your system. You will ''not'' need SteamCMD if you are acquiring the Eco Dedicated Server directly from {{SLG}}.
	==== Installing Eco with SteamCMD ====		==== Installing Eco with SteamCMD ====
	Presuming for the same of simplicity that you wish to install the Eco Dedicated Server into an <tt>Eco</tt> subdirectory of your home directory, a script such as the following will install and subsequently update the software for you:		Presuming for the same of simplicity that you wish to install the Eco Dedicated Server into an <tt>Eco</tt> subdirectory of your home directory, a script such as the following will install and subsequently update the software for you:

StalEF at 11:11, 13 June 2024

2024-06-13T11:11:12Z

← Older revision		Revision as of 13:11, 13 June 2024
Line 1:		Line 1:
	== Important Foreword ==		== Important Foreword ==
	If you run into trouble or have a question, you can make inquiries in the #server-help channel in the {{~~Eco Discord~~}}		If you run into trouble or have a question, you can make inquiries in the #server-help channel in the {{EcoDiscord}}
	== Prerequisites ==		== Prerequisites ==
	EcoServer is compiled natively for Linux but requires some packages.		EcoServer is compiled natively for Linux but requires some packages.

StalEF at 17:55, 20 April 2024

2024-04-20T17:55:42Z

← Older revision		Revision as of 19:55, 20 April 2024
Line 22:		Line 22:
	</syntaxhighlight>		</syntaxhighlight>
	=== SLG Direct Download ===		=== SLG Direct Download ===
	An archive of the current release of the Eco Dedicated Server as of this writing (Beta 9.4.1) can be found [https://play.eco/~~s3/release/EcoServerLinux_v0.9.4.1-beta.zip~~ here]. The following series of commands will download the archive, and set the Eco Dedicated Server up in an <tt>Eco</tt> subdirectory of your home directory, and save a copy of the install archive into a <tt>dist</tt> subdirectory of your home directory:		An archive of the current release of the Eco Dedicated Server as of this writing (Beta 9.4.1) can be found [https://play.eco/ here]. The following series of commands will download the archive, and set the Eco Dedicated Server up in an <tt>Eco</tt> subdirectory of your home directory, and save a copy of the install archive into a <tt>dist</tt> subdirectory of your home directory:
	<syntaxhighlight lang="sh">		<syntaxhighlight lang="sh">
	mkdir -p ~/Eco		mkdir -p ~/Eco

Vee Dee: +Category: Server management

2024-01-16T19:17:40Z

+Category: Server management

← Older revision		Revision as of 21:17, 16 January 2024
Line 186:		Line 186:

	If this happens, try clicking on the "+" symbol in the "Your Worlds" area, then adding in the external IP and port you used (probably 3000). Unfortunately, https://www.yougetsignal.com/tools/open-ports/ does _not_ accurately reflect one's ability to connect to the server.		If this happens, try clicking on the "+" symbol in the "Your Worlds" area, then adding in the external IP and port you used (probably 3000). Unfortunately, https://www.yougetsignal.com/tools/open-ports/ does _not_ accurately reflect one's ability to connect to the server.

			[[Category: Server management]]

162.158.203.40: Removed statement about the server not being officially supported. Confirmed by devs on their Discord here: https://discord.com/channels/254025510651297802/421479620479680523/1185713592645984306

2023-12-16T22:45:52Z

Removed statement about the server not being officially supported. Confirmed by devs on their Discord here: https://discord.com/channels/254025510651297802/421479620479680523/1185713592645984306

← Older revision		Revision as of 00:45, 17 December 2023
Line 1:		Line 1:
	== Important Foreword ==		== Important Foreword ==
	~~First, a disclaimer: [[Strange Loop Games]] does provide a Linux server build, but they do not offer official support for it at this time. It is provided as a convenience, not a product.~~		If you run into trouble or have a question, you can make inquiries in the #server-help channel in the {{Eco Discord}}

	If you run into trouble or have a question, you can make inquiries in the #server-help channel in the {{Eco Discord}}~~, but keep in mind the information above.~~
	== Prerequisites ==		== Prerequisites ==
	EcoServer is compiled natively for Linux but requires some packages.		EcoServer is compiled natively for Linux but requires some packages.

ZOP: /* Systemd service script */ fixed examples to actually work correctly to shutdown the service. Removed foot-gun advice about SIGINT to shutdown cleanly.

2022-05-05T16:24:18Z

Systemd service script: fixed examples to actually work correctly to shutdown the service. Removed foot-gun advice about SIGINT to shutdown cleanly.

← Older revision		Revision as of 18:24, 5 May 2022
Line 9:		Line 9:
	./install.sh		./install.sh
	</syntaxhighlight>This will install the following packages:		</syntaxhighlight>This will install the following packages:

	* [https://www.mono-project.com/docs/gui/libgdiplus/ libgdiplus]		* [https://www.mono-project.com/docs/gui/libgdiplus/ libgdiplus]

	* [https://www.gnu.org/software/libc/libc.html libc6-dev]		* [https://www.gnu.org/software/libc/libc.html libc6-dev]

	== Eco Dedicated Server files ==		== Eco Dedicated Server files ==
	There are two primary options for acquisition of the Eco dedicated server: getting it directly from Strange Loop Games, or through Valve Software's Steam platform.		There are two primary options for acquisition of the Eco dedicated server: getting it directly from Strange Loop Games, or through Valve Software's Steam platform.
Line 55:		Line 53:
	</syntaxhighlight>		</syntaxhighlight>
	== Systemd service script ==		== Systemd service script ==
	~~If you wish~~ to ~~set up~~ a ~~systemd~~ service to have ~~ECO run automatically,~~ this ~~will~~ do the ~~trick:~~		You can choose to create the service either system-wide OR as a user based service. The latter you CAN do without root but if you can't sudo/be root to use the loginctl command it won't stay around when you're logged out, and won't start on boot.

			If you've visited this before, note the example service files have been changed to actually cleanly shutdown the Eco server! The prior version of both examples in this Wiki would NOT correctly stop the server.

			For system-wide setup you can do the following -- using your favorite editor (vi, nano etc.) edit /etc/systemd/system/EcoServer.service or /usr/lib/systemd/system/EcoServer.service (which depends on your platform, generally though /usr/lib/systemd is for installed packages, not local modifications) and paste the following making sure to update User, Group, WorkingDirectory, and ExecStart.

	~~Using~~ your ~~favorite editor (vi, nano etc~~.~~) edit~~ /~~usr~~/~~lib~~/~~systemd~~/~~system/EcoServer.service and paste the following:~~		WorkingDirectory is going to be the root of your ECO server. If you'd normally start on the command line from /games/Eco then WorkingDirectory should be /games/Eco
	<syntaxhighlight lang="shell">		<syntaxhighlight lang="shell">
	[Unit]		[Unit]
	Description=Eco Server		Description=Eco Server
			# The below may or may not work correctly depending on platform, it's important that systemd is asked to start this after networking is online at the very least.
			After=syslog.target network.target nss-lookup.target network-online.target

	[Service]		[Service]
	Type=simple		Type=simple
Line 70:		Line 75:
	Group=ecoserver		Group=ecoserver
	Environment="DOTNET_BUNDLE_EXTRACT_BASE_DIR=%h/.net"		Environment="DOTNET_BUNDLE_EXTRACT_BASE_DIR=%h/.net"
	#ExecStartPre=/home/ark/server/steamcmd +login ~~[username]~~ +force_install_dir /home/ecoserver/Eco_server/ +app_update 739590 +quit		WorkingDirectory=/home/ecoserver/Eco_server
	ExecStart=~~/bin/bash -c 'cd /home/ecoserver/Eco_server && exec~~ /home/ecoserver/Eco_server/EcoServer'		# change to where your steamcmd exists if you want to automatically update on each restart.
	ExecStop=~~killall~~ -TERM ~~srcds_linux~~		#ExecStartPre=/home/ark/server/steamcmd +login anonymous +force_install_dir /home/ecoserver/Eco_server/ +app_update 739590 +quit
			# ExecStart MUST be a full path! IE starting with /
			ExecStart=/home/ecoserver/Eco_server/EcoServer
			ExecStop=kill -TERM $MAINPID
	[Install]		[Install]
	WantedBy=multi-user.target		WantedBy=multi-user.target
	</syntaxhighlight>		</syntaxhighlight>
	~~ExecStartPre is commented out because I was not able to get it to work without user input due to Steam Guard.~~
	Then update the systemd service by running the following:<syntaxhighlight lang="shell">		Then update the systemd service by running the following:<syntaxhighlight lang="shell">
	sudo systemctl daemon-reload		sudo systemctl daemon-reload
Line 86:		Line 93:
	sudo systemctl status EcoServer		sudo systemctl status EcoServer
	</syntaxhighlight>		</syntaxhighlight>
			You can also deploy using a systemd user service which means you won't need root to start/stop/restart. You'll have to remove the User and Group lines from the unit, and if you want it to start on boot you'll need to enable that for the user.

			As root or a user with sudo access (this step is critical when setting up the service as a user service if you do not want systemd to shut the server down every time you logout!!):
			<syntaxhighlight lang="shell">
			sudo loginctl enable-linger ecoserv
			</syntaxhighlight>

			User based service unit example:

			<syntaxhighlight lang="shell">
			[Unit]
			Description=Eco Server
			# The below may or may not work correctly depending on platform, it's important that systemd is asked to start this after networking is online at the very least.
			After=syslog.target network.target nss-lookup.target network-online.target

			[Service]
			Type=simple
			Restart=on-failure
			RestartSec=5
			StartLimitInterval=60s
			StartLimitBurst=3
			Environment="DOTNET_BUNDLE_EXTRACT_BASE_DIR=%h/.net"
			WorkingDirectory=%h/Eco_server
			# change to where your steamcmd exists if you want to automatically update on each restart.
			#ExecStartPre=/home/ark/server/steamcmd +login anonymous +force_install_dir %h/Eco_server/ +app_update 739590 +quit
			# ExecStart MUST be a full path! IE starting with /
			ExecStart=%h/Eco_server/EcoServer
			ExecStop=kill -TERM $MAINPID
			[Install]
			WantedBy=default.target
			</syntaxhighlight>

			As the ecoserv user (or whatever user you choose) create the directory for the unit file(s) if it doesn't exist, and place the above unit file within that directory:
			<syntaxhighlight lang="shell">
			# creates the whole path if it doesn't exist
			mkdir -p ~/.config/systemd/user/
			# edit the file here ... ~/.config/systemd/user/EcoServer.service ... or whatever you name it, just as long as it ends in .service
			systemctl --user daemon-reload
			systemctl --user enable EcoServer
			systemctl --user start EcoServer
			</syntaxhighlight>
			Notice the --user flag to systemctl AND not using sudo. In a user service you can not set the User and Group, and the WantedBy target must be default.target so we remove/change those in the service file. As a user service you can also use %h instead of /home/ecoserv (or whatever) to reference the user home directory, systemd will expand that for us.

	'''Debian/Ubuntu Version'''		'''Debian/Ubuntu Version'''
	<syntaxhighlight lang="shell">		<syntaxhighlight lang="shell">
Line 100:		Line 150:
	Group=eco		Group=eco
	LimitNOFILE=100000		LimitNOFILE=100000
			WorkingDirectory=/gameservers/eco
	ExecStartPre=/usr/games/steamcmd +login anonymous +force_install_dir /gamesservers/eco +app_update 739590 default validate +quit		ExecStartPre=/usr/games/steamcmd +login anonymous +force_install_dir /gamesservers/eco +app_update 739590 default validate +quit
	ExecStart=~~/bin/bash -c 'cd /gamesservers/eco && exec~~ /gamesservers/eco/EcoServer'		ExecStart=/gamesservers/eco/EcoServer
	ExecReload=~~/bin/~~kill -s TERM $MAINPID		ExecReload=kill -TERM $MAINPID
	ExecStop=~~/bin/~~kill -s TERM $MAINPID		ExecStop=kill -TERM $MAINPID
	[Install]		[Install]
	WantedBy=multi-user.target		WantedBy=multi-user.target
	</syntaxhighlight>		</syntaxhighlight>
	== Stopping the Server ==
	To safely shut down the Eco server, send SIGINT or press {{key\|Ctrl+C}} with the <tt>EcoServer</tt> process interactively to initiate a safe shutdown.
			==Stopping the Server==
			To safely shut down the Eco server, send SIGTERM (saves world), SIGINT (immediate stop! does not save the world!) or press {{key\|Ctrl+C}} with the <tt>EcoServer</tt> process interactively to initiate a safe shutdown.

	Please not that this procedure doesn't work with Eco versions prior to 9.0.0-beta.		Please not that this procedure doesn't work with Eco versions prior to 9.0.0-beta.
Line 122:		Line 175:
	You will need to make sure that the Docker container is exposing the ports and map them to ports on the host that are open in the hosts firewall and router.		You will need to make sure that the Docker container is exposing the ports and map them to ports on the host that are open in the hosts firewall and router.
	==Troubleshooting==		==Troubleshooting==
	===Missing GDI library ===		===Missing GDI library===
	You may sometimes get a crash on an attempted initial startup with an error resembling the following:		You may sometimes get a crash on an attempted initial startup with an error resembling the following:
	<syntaxhighlight lang="sh">		<syntaxhighlight lang="sh">

Redwyre: updated prerequisites to use install script

2022-04-16T06:12:35Z

updated prerequisites to use install script

← Older revision		Revision as of 08:12, 16 April 2022
Line 4:		Line 4:
	If you run into trouble or have a question, you can make inquiries in the #server-help channel in the {{Eco Discord}}, but keep in mind the information above.		If you run into trouble or have a question, you can make inquiries in the #server-help channel in the {{Eco Discord}}, but keep in mind the information above.
	== Prerequisites ==		== Prerequisites ==
	~~=== Mono No More ===~~		EcoServer is compiled natively for Linux but requires some packages.
	~~Prior to [[Version#v9.0.0\|version 9.0]] of Eco, it was~~ required ~~that you run with a very old build (no later than 5.14) of the Mono development libraries~~, ~~and~~ use ~~Mono to run the server. This is no longer the case. Install the latest Mono libraries with the commands~~:
	<syntaxhighlight lang="bash">		To install the required packages for Linux, use:<syntaxhighlight lang="bash">
	~~sudo apt update~~		./install.sh
	~~sudo apt~~ install ~~libgdiplus~~		</syntaxhighlight>This will install the following packages:
	</syntaxhighlight>
	~~See~~ [https://www.mono-project.com/docs/gui/libgdiplus/ libgdiplus] ~~for more information.~~		* [https://www.mono-project.com/docs/gui/libgdiplus/ libgdiplus]

	~~=== .NET Core Libraries ===~~		* [https://www.gnu.org/software/libc/libc.html libc6-dev]
	~~Eco is now built with and is run leveraging~~ [https://~~docs~~.~~microsoft~~.~~com~~/~~en-us/dotnet/core .NET Core], and runs as a native binary on Linux. You will have to [https:~~//~~docs.microsoft~~.~~com/en~~-~~us/dotnet/core/install/linux install the .NET Core 3.1 libraries~~]~~, repositories for which Microsoft makes available for several Linux distributions. Follow the directions on Microsoft's site for instructions for installing the libraries.~~

	== Eco Dedicated Server files ==		== Eco Dedicated Server files ==
Line 112:		Line 111:

	Please not that this procedure doesn't work with Eco versions prior to 9.0.0-beta.		Please not that this procedure doesn't work with Eco versions prior to 9.0.0-beta.

	==Docker==		==Docker==
	There is a Docker version of the server as well. You can pull the latest stable version using:		There is a Docker version of the server as well. You can pull the latest stable version using: