Skip to main content

Docker Installation

Docker is the recommended way to run SolidPing. It provides isolation, easy updates, and consistent behavior across environments.

Quick Start​

With SQLite (Simplest)​

For testing or small deployments, you can use SQLite as the database. The image already defaults to it, storing the database file and uploaded blobs under /data, so a single mounted volume is enough:

docker run -d \
  --name solidping \
  -p 4000:4000 \
  -v solidping-data:/data \
  ghcr.io/fclairamb/solidping:latest

For production deployments, PostgreSQL is recommended. Uploaded blobs still default to /data/files, so keep mounting /data:

docker run -d \
  --name solidping \
  -p 4000:4000 \
  -v solidping-data:/data \
  -e SP_DB_TYPE=postgres \
  -e SP_DB_URL="postgresql://user:password@host:5432/solidping" \
  ghcr.io/fclairamb/solidping:latest

Every value can be overridden with -e — Postgres above is the usual reason, but the same applies to SP_FILESTORAGE_LOCAL_ROOT if you want uploads on a different path.

Don't skip the volume

SolidPing stores the SQLite database (unless you switch to Postgres) and a handful of blobs (org logos, status-page assets, incident screenshots) under /data by default. Without a mounted volume there, everything is destroyed on the next docker stop / docker run cycle — silently. See File Storage for the S3 alternative, which has no such constraint.

Bind mounts (-v ./data:/data) keep the host directory's existing ownership, which may not be writable by the container's nonroot user (uid/gid 65532). Either chown 65532:65532 the host directory first, or run the container with --user. Named volumes (-v solidping-data:/data, used above) don't have this problem — Docker seeds them from the image with the right ownership.

Environment Variables​

VariableImage defaultBare-binary defaultDescription
SP_DB_TYPEsqlitesqliteDatabase type: postgres, sqlite, sqlite-memory
SP_DB_URL--PostgreSQL connection string (required if SP_DB_TYPE=postgres)
SP_DB_DIR/data.Directory for SQLite database file
SP_SERVER_LISTEN:4000:4000Server listen address and port
SP_FILESTORAGE_LOCAL_ROOT/data/files./data/filesWhere uploaded blobs (org logos, status-page assets, screenshots) are written — must be a mounted volume, see File Storage

The "bare-binary default" column applies only when running solidping directly, outside Docker — the published image sets the first three via ENV so a bare docker run -v solidping-data:/data just works.

On a small host (1 GB of RAM or less), see Small hosts for the memory settings. Note that docker stats also counts the page cache of the image the container read, so read RssAnon instead.

Docker Compose Example​

Create a docker-compose.yml file:

version: '3.8'

services:
  postgres:
    image: postgres:16-alpine
    environment:
      POSTGRES_USER: solidping
      POSTGRES_PASSWORD: solidping
      POSTGRES_DB: solidping
    volumes:
      - postgres-data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U solidping"]
      interval: 5s
      timeout: 5s
      retries: 5

  solidping:
    image: ghcr.io/fclairamb/solidping:latest
    ports:
      - "4000:4000"
    environment:
      SP_DB_TYPE: postgres
      SP_DB_URL: postgresql://solidping:solidping@postgres:5432/solidping?sslmode=disable
    volumes:
      - solidping-data:/data
    depends_on:
      postgres:
        condition: service_healthy

volumes:
  postgres-data:
  solidping-data:

Start the services:

docker-compose up -d

Accessing the Dashboard​

Once running, access the dashboard at http://localhost:4000.

Default credentials:

  • Email: admin@solidping.io
  • Password: solidpass
First login sets a new password

That password is published in the SolidPing repository, so it buys you exactly one login. SolidPing lands you on a "set a new password" screen and the account can do nothing else until you complete it — over the API, every endpoint except POST /api/v1/auth/change-password, GET /api/v1/auth/me and POST /api/v1/auth/logout answers 403 with code PASSWORD_CHANGE_REQUIRED.

This applies to any fresh database, self-hosted or not. There is no setting that turns it off.

The same screen asks for your own email address while the account still uses admin@solidping.io. It is optional there, and you can change it later from Account > Profile. To start with your own address instead, set SP_ADMIN_EMAIL before the first start (see Changing an email address).

Updating​

To update to the latest version:

docker pull ghcr.io/fclairamb/solidping:latest
docker stop solidping
docker rm solidping
# Run the docker run command again

Or with Docker Compose:

docker-compose pull
docker-compose up -d

Health Check​

The server exposes a health check endpoint:

curl http://localhost:4000/api/mgmt/health

Next Steps​