​
Prerequisites

  • Docker
  • Linux OS
  • PostgreSQL Client

​
Installation

To run Oxla on S3, you need to have Docker and the PostgreSQL client installed on your local machine.

​
Docker Setup

Once you’re done with installation, you can open your terminal and execute following command to check if you have installed your Docker instance properly:

docker ps
If it returns “Bad response from Docker Engine”, it means there is an issue with your Docker instance and you need to re-install it. Refer to our troubleshooting guide to learn more about common errors and how to resolve them.

​
Docker Compose File

Execute the command below to create a docker compose file:

vim one_node.yml

Then, update the file with the following code:

version: '3.5'
volumes:
  oxla_data:
services:
  oxla_node:
    image: public.ecr.aws/oxla/release:latest
    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
Don’t forget to replace environment variable placeholder values with the ones from your AWS instance.

​
Docker Container

Once you successfully followed the steps described above, you can execute the following command to create and start the docker container:

docker compose -f one_node.yml up

Now you are able to run Oxla server by executing the code below:

psql -h localhost
If you encounter an error such as: “bash: psql: command not found“, it means that the PostgreSQL client is not installed correctly and you need to re-install it. Refer to our troubleshooting guide to learn more about common errors and how to resolve them.

By now you should have successfully run the Oxla server:

psql (14.4, server Oxla 1.0)

HP=>
Run Oxla in 2 minutesMulti-node Deployment