Skip to content

QuickStart

Pre-requisites

Gaia needs :

  • a Docker daemon (used to run Terraform itself), or a Kubernetes cluster
  • a MongoDb database (to store its data)

Getting started with Kubernetes & Helm

Prerequisites

  • Access to a Kubernetes cluster (version 1.22 minimum)
  • helm version 3.8 minimum
  • kubectl version 1.22 minimum

Create a namespace in your cluster for Gaia:

kubectl create namespace gaia

Install the Helm chart for Gaia in the created namespace using the following command:

helm install gaia https://github.com/gaia-app/chart/archive/refs/tags/v0.1.2.tar.gz --namespace gaia

When gaia is started, get the URL of the service by running:

kubectl get svc --namespace gaia
The expected output is: 
NAME            TYPE           CLUSTER-IP       EXTERNAL-IP   PORT(S)        AGE
gaia            LoadBalancer   <cluster-ip>     <ext-ip>      80:<port>/TCP  6m39s
gaia-database   ClusterIP      <cluster-ip>     <none>        27017/TCP      6m39s
Take note of the <ext-ip> and the <port> and open your browser to http://<ext-ip>:<port>

Getting started with docker-compose & pre-build images

Prerequisites

  • docker version 20.10.14 minimum
  • docker-compose version 1.29 minimum

Create the following docker-compose.yml file

version: "3.9"
services:
  gaia:
    image: "gaiaapp/gaia"
    ports: 
      - "8080:8080"
    environment:
      - "GAIA_MONGODB_URI=mongodb://mongo/gaia"
      - "GAIA_RUNNER_API_PASSWORD=123456"
      - "GAIA_EXTERNAL_URL=http://gaia:8080"
  runner:
    image: "gaiaapp/runner"
    environment:
      - "GAIA_URL=http://gaia:8080"
      - "GAIA_RUNNER_API_PASSWORD=123456"
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock"
  mongo:
    image: "mongo:4.4"

Then, run docker-compose up -d. When Gaia is started, open http://localhost:8080 on your browser.

Getting started with source-code & Docker

Prerequisites

  • docker version 20.10.14 minimum
  • docker-compose version 1.29 minimum

Using docker-compose

The Gaia source code contains several docker-compose files to help users getting started quickly.

Start Gaia & a MongoDb database

Clone the Gaia repository & run docker-compose: 

git clone git@github.com:gaia-app/gaia.git
cd gaia
docker-compose up -d

Start Gaia-Runner

Clone the runner repository & run docker-compose: 

git clone git@github.com:gaia-app/runner.git
cd runner
docker-compose up -d

Getting started with source code, Maven & Java

Prerequisites

  • Java 17
  • Maven version 3.8+

Build Gaia with maven

Clone the Gaia repository, & run mvn package to build and executable jar of Gaia:

git clone git@github.com:gaia-app/gaia.git
cd gaia
mvn package -DskipTests

An executable jar will be build in the target directory.

Run Gaia as a jar

Run the executable jar with the following command:

java -jar target/gaia-2.3.0.jar

To configure the database, see database-configuration

Login

Go to http://localhost:8080

Default credentials are :

  • admin account with ROLE_ADMIN
username: admin
password: admin123
  • user account with ROLE_USER
username: user
password: user123