diff --git a/Installation.md b/Installation.md index 6f6e3f7..926b932 100644 --- a/Installation.md +++ b/Installation.md @@ -1,19 +1,21 @@ -# Deploy with the prebuilt Docker image +# Docker + +## Deploy with the prebuilt Docker image Dockerfile and docker-compose.yml files have been provided to make deployment of the server as easy as possible. 1. Download the docker-compose-{database}.yml file for the database type you would like to use. -2. Open the docker-compose.yml file and edit the igdbclientid and igdbclientsecret to the values retrieved from your IGDB account +2. Open the docker-compose.yml file and edit the environment variables igdbclientid and igdbclientsecret to the values retrieved from your IGDB account. Other environment variables that can be configured can be found here: https://github.com/gaseous-project/gaseous-server/wiki/Configuration-File 3. Run the command ```docker-compose up -d``` 4. Connect to the host on port 5198 -# Build and deploy a Docker image from source +## Build and deploy a Docker image from source Dockerfile and docker-compose-build.yml files have been provided to make deployment of the server as easy as possible. 1. Clone the repo with ```git clone https://github.com/gaseous-project/gaseous-server.git``` 2. Change into the gaseous-server directory -3. Open the docker-compose-{database}-build.yml file and edit the igdbclientid and igdbclientsecret to the values retrieved from your IGDB account +3. Open the docker-compose-build.yml file and edit the environment variables igdbclientid and igdbclientsecret to the values retrieved from your IGDB account. Other environment variables that can be configured can be found here: https://github.com/gaseous-project/gaseous-server/wiki/Configuration-File 4. Run the command ```docker-compose --file docker-compose-{database}-build.yml up -d``` 5. Connect to the host on port 5198 @@ -31,12 +33,13 @@ Dockerfile and docker-compose-build.yml files have been provided to make deploym 8. Create a directory in the home directory of the user that will run the server. For example, if running as the user ```gaseous```, create the directory ```/home/gaseous/.gaseous-server``` 9. Change into the ```.gaseous-server``` directory created in the previous step 10. Copy the JSON from the config file above into a new file named ```config.json``` -11. Update the database section with the database server hostname, username, password, and port +11. Update the database section with the database server hostname, username, password, and port. A full description of the configuration options can be found here: https://github.com/gaseous-project/gaseous-server/wiki/Configuration-File 12. Compile the server by changing back to the repo cloned earlier and executing: * ```dotnet restore "gaseous-server/gaseous-server.csproj"``` * ```dotnet publish "gaseous-server/gaseous-server.csproj" --use-current-runtime --self-contained false -c Release -o ``` * replace `````` with the directory of your choosing. The compiled application will be copied there. For this example we'll use ```/opt/gaseous-server``` -13. The server can then be started by executing ```dotnet /opt/gaseous-server/gaseous-server.dll``` +13. Download the EmulatorJS package from https://cdn.emulatorjs.org/releases/4.0.9.7z and extract the contents to the ``/opt/gaseous-server/wwwroot/emulators/EmulatorJS`` directory +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``` **Note**: The above instructions were tested on macOS Ventura, and Ubuntu 22.04.3. There was a report that Debian 11 had an issue with the git submodule commands (see: https://github.com/gaseous-project/gaseous-server/issues/71). This was possibly due to an older git package.