diff --git a/README.md b/README.md index eee581a72c..bb07b4281e 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,6 @@ Older server versions can be found in the V# branches of this repository. Note t ### Pre-Requisites -- [ASP .NET Core Runtime (>= v6.0)](https://dotnet.microsoft.com/download/dotnet/6.0) (Choose the option to `Run Server Apps` for your system) If you plan to install tgstation-server as a Windows service, you should also ensure that your .NET Framework runtime version is >= v4.7.2 (Download can be found on same page). Ensure that the `dotnet` executable file is in your system's `PATH` variable (or that of the user's that will be running the server). - A [MariaDB](https://downloads.mariadb.org/), MySQL, [PostgresSQL](https://www.postgresql.org/download/), or [Microsoft SQL Server](https://www.microsoft.com/en-us/download/details.aspx?id=55994) database engine is required ### Installation @@ -27,6 +26,8 @@ Follow the instructions for your OS below. #### Windows +Download and install the [ASP .NET Core Runtime (>= v6.0)](https://dotnet.microsoft.com/download/dotnet/6.0) (Choose the option to `Run Server Apps` for your system). If you plan to install tgstation-server as a Windows service, you should also ensure that your .NET Framework runtime version is >= v4.7.2 (Most modern systems have it by default. Download can be found on same page). Ensure that the `dotnet` executable file is in your system's `PATH` variable (or that of the user's that will be running the server), you can test this by opening a command prompt and running `dotnet --list-runtimes`. + [Download the latest release .zip](https://github.com/tgstation/tgstation-server/releases/latest). You probably want the `ServerService` package. Choose `ServerConsole` if you prefer not to use the Windows service. Extract the .zip file to where you want the server to run from. Note the account running the server must have write and delete access to the `lib` subdirectory. @@ -43,7 +44,7 @@ Installing natively is the recommended way to run tgstation-server on Linux. ##### Ubuntu -Install TGS and all it's dependencies via our apt repository with this one-liner: +Install TGS and all it's dependencies via our apt repository, interactively configure it, and start the service with this one-liner: ```sh sudo dpkg --add-architecture i386 \ @@ -52,7 +53,9 @@ sudo dpkg --add-architecture i386 \ && sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv B6FD15EE7ED77676EAEAF910EEEDC8280A307527 \ && sudo add-apt-repository -y "deb https://tgstation.github.io/tgstation-ppa/debian unstable main" \ && sudo apt update \ -&& sudo apt install -y tgstation-server +&& sudo apt install -y tgstation-server \ +&& sudo tgs-configure \ +&& sudo systemctl start tgstation-server ``` ##### Debian