Updated Installation (markdown)
@@ -6,22 +6,55 @@
|
|||||||
|
|
||||||
## Deploy with the prebuilt Docker image
|
## 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. Create a new directory on your host named `gaseous`
|
||||||
|
2. Enter `cd gaseous` to move into the `gaseous` directory
|
||||||
1. Download the docker-compose.yml file for the database type you would like to use.
|
3. Enter `nano docker-compose.yml` (or your favourite text editor) to create a new `docker-compose.yml` file
|
||||||
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
|
4. Paste the following Docker Compose yaml into the file:
|
||||||
3. Run the command ```docker-compose up -d```
|
```yaml
|
||||||
4. Connect to the host on port 5198
|
version: '2'
|
||||||
|
services:
|
||||||
## Build and deploy a Docker image from source
|
gaseous-server:
|
||||||
|
container_name: gaseous-server
|
||||||
Dockerfile and docker-compose-build.yml files have been provided to make deployment of the server as easy as possible.
|
image: gaseousgames/gaseousserver:latest
|
||||||
|
restart: unless-stopped
|
||||||
1. Clone the repo with ```git clone https://github.com/gaseous-project/gaseous-server.git```
|
networks:
|
||||||
2. Change into the gaseous-server directory
|
- gaseous
|
||||||
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
|
depends_on:
|
||||||
4. Run the command ```docker-compose --file docker-compose-{database}-build.yml up -d```
|
- gsdb
|
||||||
5. Connect to the host on port 5198
|
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
|
# Build and deploy from source
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user