Getting Started

Deploy Oxla in minutes! 🎊

Over the following steps, we'll set you up with an Oxla server so you can see how easy it is to access. Let's get started!

Prerequisite

⚠️ Install Docker. Please refer to this page for further details.

⚠️ We recommend you to use Linux OS computer to deploy an Oxla server

⚠️ Install PostgreSQL on your local machine. Please refer to this page.

Installation Steps

1) Open your terminal and execute this command to check if you have installed your docker properly:

docker ps

2) Execute the following command to create a file that contains docker compose file:

vim one_node.yml

Option 1 - Run Oxla against data in your local machine

3) If you want to run Oxla using data in your local machine, input the following code into the docker compose file:

version: '3.5'
volumes:
  oxla_data:
services:
  oxla_node:
    image: public.ecr.aws/oxla/release:2023.5.0-Release-x86_64
    security_opt:
      - seccomp:unconfined
    ulimits:
      nofile:
        soft: 40000
        hard: 40000
    volumes:
      - oxla_data:/data
    ports:
      - 5432:5432
    environment:
      - OXLA_HOME=${OXLA_HOME-/data}



Option 2 - Run Oxla against data in S3

3) If you want to run Oxla using data in S3, input the following code into the docker compose file:

version: '3.5'
volumes:
  oxla_data:
services:
  oxla_node:
    image: public.ecr.aws/oxla/release:2023.2.1-Release-x86_64
    security_opt:
      - seccomp:unconfined
    ulimits:
      nofile:
        soft: 40000
        hard: 40000
    volumes:
      - oxla_data:/data
    ports:
      - 5432:5432
    environment:
      - OXLA_HOME=s3://yourdirectoryname
      - AWS_DEFAULT_REGION=AWS_DEFAULT_REGION
      - AWS_ACCESS_KEY_ID=AWS_ACCESS_KEY_ID
      - AWS_SECRET_ACCESS_KEY=AWS_SECRET_ACCESS_KEY

4) Execute the following command to create and start the docker container:

docker compose -f one_node.yml up

5) Execute the following command to run Oxla:

psql -h localhost

When you get the following result, you are now in the Oxla server✅

psql (14.4, server Oxla 1.0)

HP=>