From afd70e6b02fed38699705b3c364983ebdf4cd2d2 Mon Sep 17 00:00:00 2001 From: Michael Green <84688932+michael-j-green@users.noreply.github.com> Date: Tue, 11 Jul 2023 23:00:24 +1000 Subject: [PATCH] Update README.MD (#14) * doc: updated documentation to include instructions on starting with docker-compose --- README.MD | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.MD b/README.MD index cce6722..8022cfb 100644 --- a/README.MD +++ b/README.MD @@ -57,10 +57,17 @@ When Gaseous-Server is started for the first time, it creates a configuration fi ## Deploy with Docker Dockerfile and docker-compose.yml files have been provided to make deployment of the server as easy as possible. +1. Download the docker-compose.yml file +2. Open the docker-compose.yml file and edit the igdbclientid and igdbclientsecret to the values retrieved from your IGDB account +3. Run the command "docker-compose up -d" +4. Connect to the host on port 5198 + +## Build and Deploy with Docker +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.yml file and edit the igdbclientid and igdbclientsecret to the values retrieved from your IGDB account -4. Run the command "docker-compose up -d" +3. Open the docker-compose-build.yml file and edit the igdbclientid and igdbclientsecret to the values retrieved from your IGDB account +4. Run the command "docker-compose up --file docker-compose-build.yml -d" 5. Connect to the host on port 5198 ## Adding Content