Skip to main content

Local Install

We recommend using Docker because it takes care of all of the necessary dependencies.

Prerequisites

You will need to install:

Docker Compose

  • Create .env file
DEBUG_MODE=True
ALLOWED_HOSTS=*
DATABASE_HOST=db
DATABASE_PORT=5432
DATABASE_NAME=db
DATABASE_USERNAME=postgres
DATABASE_PASSWORD=postgres
DETACHED_WORKER=False
  • Create a docker-compose.yml file
version: '3'

services:
karrio:
container_name: karrio
image: danh91.docker.scarf.sh/karrio/server:2022.6.2
restart: unless-stopped
ports:
- "5002:5002"
env_file: .env
depends_on:
- db
networks:
- db_network
- web_network
volumes:
- karriostatics:/karrio/static

dashboard:
container_name: dashboard
image: danh91.docker.scarf.sh/karrio/dashboard:2022.6.2
ports:
- "3000:3000"
environment:
- 'NEXT_PUBLIC_KARRIO_API_URL=http://[YOUR-LOCAL-IP-ADDRESS]:5002'
- 'NEXTAUTH_URL=http://[YOUR-LOCAL-IP-ADDRESS]:3000'
- JWT_SECRET="n*s-ex6@ex_r1i%bk=3jd)p+lsick5bi*90!mbk7rc3iy_op1r"
networks:
- web_network

db:
container_name: db
image: postgres
restart: unless-stopped
environment:
POSTGRES_DB: "db"
POSTGRES_USER: "postgres"
POSTGRES_PASSWORD: "postgres"
PGDATA: /var/lib/postgresql/data/sandbox
networks:
- db_network

volumes:
karriostatics:
karrio-db:

networks:
db_network:
web_network:
  • Run the application
docker-compose up

The karrio server should be running at http://localhost:5002.
The karrio dashboard should be running at http://localhost:3000.

Log in with the default admin account admin@example.com | demo

Next steps