Run Oxla on S3 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 use a Linux OS computer to deploy an Oxla server.

⚠️ Install PostgresSQL-client-14 for psql connection. 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
If it returns “Bad response from Docker engine”, this means there is an issue with your docker engine. Try re-install your docker.
  1. Execute the following command to create a file that contains docker compose file:
vim one_node.yml
  1. Input the following code into the docker compose file:
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 the s3, AWS\_DEFAULT\_REGION, AWS\_ACCESS\_KEY\_ID, and AWS\_SECRET\_ACCESS\_KEY with appropriate values.
Depending on your computer’s RAM capacity, you may need to adjust the environment variable to optimize performance. You can set OXLA_MAX_NON_QUERY_MEM to a custom number.
For example OXLA_MAX_NON_QUERY_MEM=4194304
  1. Execute the following command to create and start the docker container:
docker compose -f one_node.yml up
  1. Execute the following command to run Oxla:
psql -h localhost
If you encounter an error response “bash: psql: command not found“, this means that you have not installed PostgreSQL.
  1. When you get the following result, you are now in the Oxla serverâś…
psql (14.4, server Oxla 1.0)

HP=>
Encountered an error? We got you! Head over here to see your troubleshooting resolutions!