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: Initialize a workspace

docplatform init --workspace-name "My Docs" --slug my-docs

This creates:

.docplatform/
├── data.db              # SQLite database
├── jwt-private.pem      # Auto-generated RS256 signing key
└── workspaces/
    └── {workspace-id}/
        ├── docs/        # Your documentation lives here
        └── .docplatform/
            └── config.yaml

With git (optional)

Connect to an existing git repository during initialization:

docplatform init \
  --workspace-name "My Docs" \
  --slug my-docs \
  --git-url git@github.com:your-org/docs.git \
  --branch main

DocPlatform clones the repository and begins syncing. Any existing .md files are automatically indexed.

Step 3: Start the server

docplatform serve

INFO  Server starting            addr=:3000 version=v0.5.2
INFO  Database initialized       path=.docplatform/data.db
INFO  Search index ready         documents=0
INFO  Workspace loaded           name="My Docs" slug=my-docs
INFO  Listening on               http://localhost:3000

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

Step 4: Register your account

The first user to register automatically becomes the Super Admin with full platform access.

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

Security note: The first-user-becomes-admin flow only applies when no users exist. After the first registration, new accounts get the default role configured for the workspace.

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 docs/ directory. 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