sendnrw/gaseous-server
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.MD (#14)

Browse Source 
* doc: updated documentation to include instructions on starting with docker-compose
This commit is contained in:
Michael Green
2023-07-11 23:00:24 +10:00
committed by GitHub
parent f1842d21ff
commit afd70e6b02
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.MD
View File

@@ -57,10 +57,17 @@ When Gaseous-Server is started for the first time, it creates a configuration fi
## Deploy with Docker ## Deploy with Docker
Dockerfile and docker-compose.yml files have been provided to make deployment of the server as easy as possible. 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" 1. Clone the repo with "git clone https://github.com/gaseous-project/gaseous-server.git"
2. Change into the gaseous-server directory 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 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 -d" 4. Run the command "docker-compose up --file docker-compose-build.yml -d"
5. Connect to the host on port 5198 5. Connect to the host on port 5198
## Adding Content ## Adding Content