Quickstart

Go from zero to a running documentation platform in under 5 minutes. This guide covers the fastest path — for detailed options, see the Installation guide.

Step 1: Install

# 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

Or with Docker:

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

If using Docker, skip to Step 3 — the container auto-initializes.

Step 2: Start the server

docplatform serve

The server prints its normal startup log lines first (database migrations applying, background workers starting — a handful of lines is normal and expected, even on a brand-new install), then a short “ready” banner once it’s actually listening:

  DocPlatform <version> — welcome!
  → http://localhost:3000
  Your data lives in: /home/you/.local/share/docplatform
  Keep this window open while you work. Press Ctrl+C to stop.

(The exact data path shown depends on your OS — see below. A line like API_KEY_PEPPER is empty may also appear on a first run with no extra configuration; that’s expected for local/evaluation use and is not an error.)

On first run, DocPlatform creates its data directory. By default this is an OS-standard per-user location — ~/.local/share/docplatform on Linux, ~/Library/Application Support/DocPlatform on macOS, %LOCALAPPDATA%\DocPlatform on Windows (run docplatform doctor to see the exact resolved path and which rule chose it):

data.db              # SQLite database
analytics.db         # Analytics database (separate file)
jwt-private.pem      # Auto-generated RS256 signing key
search-index/        # Embedded full-text search index
workspaces/          # One directory per workspace — your .md files live here

Open http://localhost:3000 in your browser.

Step 3: Register your account

1. Click Create Account
2. Enter your name, email, and password
3. You’re signed in and ready to write

Registering creates your own organization — you are its Super Admin — along with a starter workspace pre-loaded with example content, so you can begin writing immediately.

Step 4: Connect git (optional)

To back your workspace with a git repository, open Workspace Settings → Git in the web UI, connect with a GitHub personal access token, and pick the repository and branch. Existing .md files are pulled in and indexed automatically. See the Git Integration guide for details.

Step 5: Create your first page

1. Click New Page in the sidebar
2. Give it a title — the URL slug auto-generates from the title
3. Start writing in the rich editor
4. Changes autosave every few seconds

The page is stored as a Markdown file in your workspace’s directory under workspaces/ inside your data directory (run docplatform doctor to find it). If you connected git, it auto-commits and pushes.

Step 6: Try it out

Here are a few things to try right away:

What’s next