Skip to main content

Install with Docker

Pre-requisites​

Ensure that your system meets the following requirements:

  • Linux or WSL2 Docker
  • Latest Docker Engine and Docker Compose

To enable GPU support, you will need:

  • nvidia-driver
  • nvidia-docker2
note
  • If you have not installed Docker, follow the instructions here.
  • If you have not installed the required file for GPU support, follow the instructions here.

Run Jan in Docker​

You can run Jan in Docker with two methods:

  1. Run Jan in CPU mode
  2. Run Jan in GPU mode

To run Jan in Docker CPU mode, by using the following code:

# cpu mode with default file system
docker compose --profile cpu-fs up -d

# cpu mode with S3 file system
docker compose --profile cpu-s3fs up -d

Docker Compose Profile and Environment​

The available Docker Compose profile and the environment variables listed below:

Docker Compose Profile​

ProfileDescription
cpu-fsRun Jan in CPU mode with default file system
cpu-s3fsRun Jan in CPU mode with S3 file system
gpu-fsRun Jan in GPU mode with default file system
gpu-s3fsRun Jan in GPU mode with S3 file system

Environment Variables​

Environment VariableDescription
S3_BUCKET_NAMES3 bucket name - leave blank for default file system
AWS_ACCESS_KEY_IDAWS access key ID - leave blank for default file system
AWS_SECRET_ACCESS_KEYAWS secret access key - leave blank for default file system
AWS_ENDPOINTAWS endpoint URL - leave blank for default file system
AWS_REGIONAWS region - leave blank for default file system
API_BASE_URLJan Server URL, please modify it as your public ip address or domain name default http://localhost:1377
warning

If you are stuck in a broken build, go to the Broken Build section of Common Errors.