Install

Get started.

Up and running in minutes. Docker or source — your choice.

01

Quick Start

The fastest way to get Nexus running. One command pulls and starts the latest image.

Terminal
$ docker run -d \
    --name nexus \
    -p 8585:8585 \
    -v nexus-data:/app/data \
    ghcr.io/petalcat/nexus:latest
Nexus will be available at http://localhost:8585
02

Docker Compose

Recommended for persistent setups. Drop this into your existing compose stack or use it standalone.

Terminal
# compose.yml
services:
  nexus:
    image: ghcr.io/petalcat/nexus:latest
    ports:
      - "8585:8585"
    volumes:
      - nexus-data:/app/data
    environment:
      # Optional: set ORIGIN when behind a reverse proxy
      ORIGIN: http://localhost:8585
    restart: unless-stopped

volumes:
  nexus-data:
Run: docker compose up -d
03

From Source

Build and run directly from the repository. Useful for development or if you want full control.

Terminal
$ git clone https://github.com/PetalCat/Nexus
$ cd Nexus
$ pnpm install
$ pnpm build
$ PORT=8585 node build
Available at http://localhost:8585 after start

Requirements

Docker Docker 20+ or Podman
From Source Node.js 22+, pnpm
Database SQLite — bundled, no setup
First Run Open browser to port 8585