Skip to main content
Shipped is a self-hosted dashboard that tracks package releases across platforms like GitHub, NPM, and Docker.

​
Prerequisites

Choose one of the following:
  • Docker: Docker 20.10 or later
  • Build from source: Node.js 24+ and pnpm 10.30.0+

​
Installation Methods

# Pull the latest version
docker pull nipakke/shipped:1

# Run the container
docker run -d \
  --name shipped \
  -p 3000:3000 \
  -v /path-to-data:/data \
  --restart unless-stopped \
  nipakke/shipped:1

​
Verify Installation

Once Shipped is running, verify the installation:
1

Access the dashboard

Open your browser and navigate to http://localhost:3000
2

Check the status

You should see the Shipped dashboard. If no packages are configured, you’ll see an empty state.

​
Data Persistence

Shipped uses two directories for data storage:
  • /data/config - YAML configuration files (lists, providers, general settings)
  • /data/cache - Package release data cache (reduces API calls)
When using Docker, mount the /data volume to persist your configuration and cache: 
-v /path-to-data:/data
Or mount them separately: 
-v /path-to-data/config:/data/config
-v /path-to-data/cache:/data/cache

​
Environment Variables

Shipped can be configured using environment variables. All variables are optional with sensible defaults.

​
Common Variables

VariableDefaultDescription
SERVER_CONFIG_DIRconfigConfig files directory (relative or absolute)
SERVER_PACKAGES_CACHE_DIRcacheCache directory for package data
SERVER_PACKAGES_CACHE_DISABLEDfalseDisable package caching
SERVER_LOG_LEVEL-Set log level (trace, debug, info, warning, error, fatal)

​
Docker Environment Variables

When using Docker, these are pre-configured in the image: 
HOST=0.0.0.0
SERVER_CONFIG_DIR=/data/config
SERVER_PACKAGES_CACHE_DIR=/data/cache
See the Environment Variables reference for the complete list.

​
Next Steps

Quick Start

Get started with your first tracked package

Docker Compose

Advanced Docker Compose setup

Configuration

Learn about YAML configuration files

Providers

Explore supported package providers

Build docs developers (and LLMs) love

Get started for freeTalk to us