From 296c3cd737352f8b4478ebe211e8e75d8fd4cd40 Mon Sep 17 00:00:00 2001 From: Michael Green <84688932+michael-j-green@users.noreply.github.com> Date: Wed, 9 Oct 2024 09:07:14 +1100 Subject: [PATCH] Updated Installation (markdown) --- Installation.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/Installation.md b/Installation.md index 661d678..a4691a6 100644 --- a/Installation.md +++ b/Installation.md @@ -2,9 +2,13 @@ * An IGDB API key. See https://github.com/gaseous-project/gaseous-server/wiki/Metadata for instructions on creating an API key. -# Docker +# Installation -## Deploy as separate containers (preferred) +## Choose an installation method + +### Docker + +#### Deploy as separate containers (preferred) 1. Create a new directory on your host named `gaseous` 2. Enter `cd gaseous` to move into the `gaseous` directory @@ -56,7 +60,7 @@ volumes: 7. Run the command ```docker-compose up -d``` 8. Connect to the host on port 5198 -## Deploy the all in one container +#### Deploy the all in one container **Note:** This container contains a MariaDB instance built in and is intended for use on systems that do not easily allow multiple containers such as Unraid. It is not recommended that this image be used if you have the choice as the built in MariaDB instance is only updated when the image is published, which may be a security risk. @@ -96,7 +100,9 @@ volumes: 7. Run the command ```docker-compose up -d``` 8. Connect to the host on port 5198 -# Build and deploy from source +### Source + +#### Build and deploy from source 1. Install and configure a MariaDB or MySQL instance - this is beyond the scope of this document 2. Install the dotnet 7.0 packages appropriate for your operating system @@ -119,7 +125,7 @@ volumes: 14. The server can then be started by executing ```dotnet /opt/gaseous-server/gaseous-server.dll``` * If you would like the server to run on a different ip address and port (for example 0.0.0.0:8080), add the --urls argument: ```dotnet /opt/gaseous-server/gaseous-server.dll --urls http://0.0.0.0:8080``` -## Updating from source +#### Updating from source 1. Stop the server 2. Switch to the source directory @@ -130,7 +136,7 @@ volumes: * ```git checkout ``` 4. Run steps 12 and 13 from the above Build guide -# Deploy to Unraid +### Deploy to Unraid With thanks to [Tom1243](https://github.com/Tom1243) for building this process. @@ -139,3 +145,7 @@ These steps describe a FRESH INSTALL. REMOVE ANY OLD CONTAINERS AND old APPDATA 1. Download the `gaseousserver.xml` file from https://github.com/gaseous-project/unraid-template 2. In Main -> BootDevice -> config -> plugins -> dockerMan -> templates-user click UPLOAD (at the bottom) then select the gaseousserver.xml file 3. In Docker click ADD CONTAINER, select a template, make one of the Gaseous. Click APPLY. + +# Next Steps + +(Recommended) Import DAT files: https://github.com/gaseous-project/gaseous-server/wiki/Signatures \ No newline at end of file