Skip to main content

Installation

Qpon can be deployed using Docker. It requires a PostgreSQL database to run.

The latest image is available on Docker Hub at labsatquicko/qpon:latest

Download the compose file

curl -LO https://github.com/org-quicko/qpon/raw/main/docker-compose.yml

Set the environment variables

curl -LO https://github.com/org-quicko/qpon/raw/main/.env.example

# create a .env file and set the environment variables
cp .env.example .env

Start the services

docker compose up -d

Visit http://localhost:3000/setup to set up the super admin user.

Environment Variables

VariableDescriptionExample
DB_USERNAMEDatabase usernameqpon_user
DB_PASSWORDDatabase passwordstrongpassword
DB_NAMEDatabase nameqpon_db
DB_HOSTDatabase hostdb (use 'db' for Docker)
JWT_SECRETJWT signing secretany-random-string
SALT_ROUNDSBcrypt salt rounds for passwords10

These variables can be set in a .env file, in your shell, or directly in docker-compose.yml.