Installation

Option 1: GitHub (build from source)

Follow these steps in order. Every command is for a terminal opened in the folder where you want PMIS to live.

1. Check the prerequisites

• Docker with Compose v2. Docker Desktop on Windows or macOS; Docker Engine with the Compose plugin on Linux. Check with docker compose version.
• Git, to download the source.
• OpenSSL, to generate the secrets. It is included on Linux and macOS, and in Git Bash on Windows. Windows PowerShell users can use the PowerShell block in step 3 instead.
• A free port 3000 for the web interface, or another port you set in step 3b.
• Internet access, to download the npm packages used by the build.

2. Clone the repository

git clone https://github.com/sneakywarwolf/PMIS.git
cd PMIS

Run every remaining command of this option from the PMIS folder.

3. Create the .env file and set the secrets

Copy the template. Linux, macOS and Git Bash:

cp .env.example .env

Windows Command Prompt:

copy .env.example .env

3a. Fill in the four required secrets. Each one must be its own long random value. Linux, macOS and Git Bash:

for k in POSTGRES_PASSWORD MINIO_ROOT_PASSWORD JWT_ACCESS_SECRET JWT_REFRESH_SECRET; do
  sed -i.bak "s|^$k=CHANGE_ME|$k=$(openssl rand -hex 32)|" .env
done
rm -f .env.bak
grep '=CHANGE_ME' .env || echo "All secrets set"

Windows PowerShell, run inside the PMIS folder:

$names = 'POSTGRES_PASSWORD', 'MINIO_ROOT_PASSWORD', 'JWT_ACCESS_SECRET', 'JWT_REFRESH_SECRET'
$lines = Get-Content .env
foreach ($name in $names) {
  $bytes = New-Object byte[] 32
  [Security.Cryptography.RandomNumberGenerator]::Create().GetBytes($bytes)
  $hex = -join ($bytes | ForEach-Object { $_.ToString('x2') })
  $lines = $lines -replace "^$name=CHANGE_ME$", "$name=$hex"
}
[IO.File]::WriteAllLines((Resolve-Path .env).Path, $lines)
if (Select-String -Path .env -Pattern '=CHANGE_ME') { 'Some secrets are still CHANGE_ME' } else { 'All secrets set' }

MINIO_ROOT_PASSWORD is the secret key of the object storage service (RustFS). The variable keeps its earlier name so existing .env files keep working.

3b. Optional settings (edit .env):

4. Build and start PMIS

docker compose up -d --build

The first build downloads the npm packages and takes several minutes. Later starts are quick.

5. Wait until everything is healthy

docker compose ps

Wait until backend, frontend, postgres and rustfs show (healthy), and redis shows Up. The backend creates the database tables and loads the vulnerability library before it reports healthy.

Option 1 is finished. Continue with Sign in and set up.

Option 2: Docker Hub (prebuilt images)

Pulls the published images sneakywarwolf/pmis-backend and sneakywarwolf/pmis-frontend. Nothing is built and no source code or Git is needed. You still need two small files from the repository.

1. Check the prerequisites

• Docker with Compose v2. Docker Desktop on Windows or macOS; Docker Engine with the Compose plugin on Linux. Check with docker compose version.
• OpenSSL, to generate the secrets. It is included on Linux and macOS, and in Git Bash on Windows. Windows PowerShell users can use the PowerShell block in step 3.
• A free port 3000 for the web interface, or another port you set in step 3b.
• Internet access, to pull the images.

2. Download the two files

Linux, macOS and Git Bash:

mkdir pmis && cd pmis
curl -fsSLO https://raw.githubusercontent.com/sneakywarwolf/PMIS/master/docker-compose.yml
curl -fsSL https://raw.githubusercontent.com/sneakywarwolf/PMIS/master/.env.example -o .env

Windows PowerShell (note curl.exe, which PowerShell does not alias):

mkdir pmis; cd pmis
curl.exe -fsSLO https://raw.githubusercontent.com/sneakywarwolf/PMIS/master/docker-compose.yml
curl.exe -fsSL https://raw.githubusercontent.com/sneakywarwolf/PMIS/master/.env.example -o .env

Run every remaining command of this option from the pmis folder.

3. Set the secrets in .env

3a. Fill in the four required secrets. Linux, macOS and Git Bash:

for k in POSTGRES_PASSWORD MINIO_ROOT_PASSWORD JWT_ACCESS_SECRET JWT_REFRESH_SECRET; do
  sed -i.bak "s|^$k=CHANGE_ME|$k=$(openssl rand -hex 32)|" .env
done
rm -f .env.bak
grep '=CHANGE_ME' .env || echo "All secrets set"

Windows PowerShell, run inside the pmis folder:

$names = 'POSTGRES_PASSWORD', 'MINIO_ROOT_PASSWORD', 'JWT_ACCESS_SECRET', 'JWT_REFRESH_SECRET'
$lines = Get-Content .env
foreach ($name in $names) {
  $bytes = New-Object byte[] 32
  [Security.Cryptography.RandomNumberGenerator]::Create().GetBytes($bytes)
  $hex = -join ($bytes | ForEach-Object { $_.ToString('x2') })
  $lines = $lines -replace "^$name=CHANGE_ME$", "$name=$hex"
}
[IO.File]::WriteAllLines((Resolve-Path .env).Path, $lines)
if (Select-String -Path .env -Pattern '=CHANGE_ME') { 'Some secrets are still CHANGE_ME' } else { 'All secrets set' }

MINIO_ROOT_PASSWORD is the secret key of the object storage service (RustFS). The variable keeps its earlier name so existing .env files keep working.

3b. Optional settings (edit .env): the same table as in Option 1, step 3b. Leave PMIS_VERSION=latest and PMIS_IMAGE_REPO=sneakywarwolf as they are, unless you host the images in your own registry.

4. Pull the images

Pull the two PMIS images, then the supporting PostgreSQL, Redis and RustFS (object storage) images that the stack uses:

docker pull sneakywarwolf/pmis-frontend:latest
docker pull sneakywarwolf/pmis-backend:latest
docker compose pull

The images are published for amd64 and arm64. If Docker reports HTTP 429 or "Too Many Requests", see the troubleshooting table below.

5. Start PMIS without building

docker compose up -d --no-build

--no-build makes Docker stop with an error if an image is missing, instead of building from source, which this folder cannot do.

6. Wait until everything is healthy

docker compose ps

Wait until backend, frontend, postgres and rustfs show (healthy), and redis shows Up.

Option 2 is finished. Continue with Sign in and set up.