Updated Installation (markdown)

Michael Green
2024-09-17 11:15:10 +10:00
parent 8047b89ff6
commit 895c13a516

@@ -6,22 +6,55 @@
## 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.yml file for the database type you would like to use.
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
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-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
1. Create a new directory on your host named `gaseous`
2. Enter `cd gaseous` to move into the `gaseous` directory
3. Enter `nano docker-compose.yml` (or your favourite text editor) to create a new `docker-compose.yml` file
4. Paste the following Docker Compose yaml into the file:
```yaml
version: '2'
services:
gaseous-server:
container_name: gaseous-server
image: gaseousgames/gaseousserver:latest
restart: unless-stopped
networks:
- gaseous
depends_on:
- gsdb
ports:
- 5198:80
volumes:
- gs:/root/.gaseous-server
environment:
- TZ=Australia/Sydney
- dbhost=gsdb
- dbuser=root
- dbpass=gaseous
- igdbclientid=<clientid>
- igdbclientsecret=<clientsecret>
gsdb:
container_name: gsdb
image: mariadb
restart: unless-stopped
networks:
- gaseous
volumes:
- gsdb:/var/lib/mysql
environment:
- MARIADB_ROOT_PASSWORD=gaseous
- MARIADB_USER=gaseous
- MARIADB_PASSWORD=gaseous
networks:
gaseous:
driver: bridge
volumes:
gs:
gsdb:
```
5. Edit the environment variables igdbclientid and igdbclientsecret to the values retrieved from your IGDB account (see: https://github.com/gaseous-project/gaseous-server/wiki/Metadata for details on creating your IGDB key). Other environment variables that can be configured can be found here: https://github.com/gaseous-project/gaseous-server/wiki/Configuration-File
6. Save and close the file
7. Run the command ```docker-compose up -d```
8. Connect to the host on port 5198
# Build and deploy from source