Installation

DocPlatform ships as a single binary with zero runtime dependencies. Choose the installation method that fits your workflow.

Option 1: Pre-built binary (recommended)

Download the latest release for your platform.

Linux / macOS

# Recommended (auto-detects platform)
curl -fsSL https://valoryx.org/install.sh | sh

# Or download manually
curl -sLO https://github.com/Valoryx-org/releases/releases/latest/download/docplatform-linux-amd64
chmod +x docplatform-linux-amd64
sudo mv docplatform-linux-amd64 /usr/local/bin/docplatform

# Verify the installation
docplatform version

Expected output:

docplatform v0.5.2 (commit: abc1234, built: 2026-03-08T10:00:00Z)

Windows

# Download and run
Invoke-WebRequest https://github.com/Valoryx-org/releases/releases/latest/download/docplatform-windows-amd64.exe -OutFile docplatform.exe

# Verify
.\docplatform.exe version

# Start the server
.\docplatform.exe serve

Open http://localhost:3000 to get started.

Download manually

If you prefer to download manually, visit the GitHub Releases page. Binaries are available for:

Platform	Architecture	Filename
Linux	amd64	`docplatform-linux-amd64`
Linux	arm64	`docplatform-linux-arm64`
macOS	amd64 (Intel)	`docplatform-darwin-amd64`
macOS	arm64 (Apple Silicon)	`docplatform-darwin-arm64`
Windows	amd64	`docplatform-windows-amd64.exe`

Each release includes SHA-256 checksums for verification.

Option 2: Docker

Run DocPlatform as a container with persistent data stored in a volume.

docker run -d \
  --name docplatform \
  -p 3000:3000 \
  -v docplatform-data:/data \
  ghcr.io/valoryx-org/docplatform:latest

The container auto-initializes on first run. Open http://localhost:3000 to get started.

Docker Compose

For a more manageable setup, use Docker Compose:

# docker-compose.yml
services:
  docplatform:
    image: ghcr.io/valoryx-org/docplatform:latest
    container_name: docplatform
    ports:
      - "3000:3000"
    volumes:
      - docplatform-data:/data
    environment:
      - PORT=3000
      - DATA_DIR=/data
    restart: unless-stopped

volumes:
  docplatform-data:

docker compose up -d

For production Docker deployments, see the Docker deployment guide.

Option 3: Build from source

Build from source if you want to contribute or run a development version.

Prerequisites:

Go 1.26+
Node.js 20+ (frontend assets are pre-built; no pnpm required)
Git
Make

# Clone the repository
git clone https://github.com/Valoryx-org/docplatform.git
cd docplatform

# Build the binary (compiles Go + embeds static frontend assets)
make build

# Verify
./docplatform version

Development mode

For hot-reloading during development:

# Simple run (no hot reload)
make dev

# Go hot reload with air
make dev-hot

make dev starts the server for development. make dev-hot starts the Go server with hot reload via air and the Vite dev server with HMR.

Next steps

With DocPlatform installed, continue to:

Quickstart — initialize a workspace and start the server in 2 commands
Your First Workspace — set up git sync, invite users, and customize settings

Uninstall

Binary

# Remove the binary
sudo rm /usr/local/bin/docplatform

# Remove data (if you want a clean slate)
rm -rf .docplatform/

Docker

docker stop docplatform && docker rm docplatform
docker volume rm docplatform-data  # removes all data