Quick Start
Install Valoryx in 30 Seconds
One command. No dependencies. Works on Linux, macOS, Windows, and Docker.
System Requirements
OS: Linux (amd64/arm64), macOS (Intel/Apple Silicon), Windows (amd64)
Disk: ~50 MB (binary + SQLite database)
RAM: 128 MB minimum, 256 MB recommended
Port: 3000 (default, configurable)
No external dependencies. Single binary includes everything.
Choose Your Method
Pick the installation method that fits your workflow.
# Auto-detects OS and architecture (amd64 / arm64)
$ curl -fsSL https://valoryx.org/install.sh | sh
Installed to /usr/local/bin/docplatform
Quick Start
# Start the server
$ docplatform serve
Open http://localhost:3000
# Initialize a workspace with a git repo
$ docplatform init --repo https://github.com/your-org/docs.git
# Download the latest Windows binary
PS> Invoke-WebRequest -Uri "https://github.com/Valoryx-org/releases/releases/latest/download/docplatform-windows-amd64.exe" -OutFile "docplatform.exe"
# Optional: move to a directory in your PATH
PS> Move-Item docplatform.exe "$env:LOCALAPPDATA\Microsoft\WindowsApps\"
Quick Start
# Start the server
PS> .\docplatform.exe serve
Open http://localhost:3000
# Initialize a workspace with a git repo
PS> .\docplatform.exe init --repo https://github.com/your-org/docs.git
# Pull and run with persistent data
$ docker run -d -p 3000:3000 -v docplatform-data:/data ghcr.io/valoryx-org/docplatform:latest
Running at http://localhost:3000
Docker Compose
services:
docplatform:
image: ghcr.io/valoryx-org/docplatform:latest
ports:
- "3000:3000"
volumes:
- docplatform-data:/data
restart: unless-stopped
volumes:
docplatform-data:
Download from GitHub Releases
Pre-built binaries available for Linux, macOS, and Windows across amd64 and arm64 architectures.
Zero Dependencies
Single Binary
Free Forever
Signed and Verified
You are all set!
$ docplatform version
DocPlatform v0.5.2
$ docplatform serve
Server running at http://localhost:3000
What's Next
Troubleshooting
Permission denied — Run with sudo:
sudo curl -fsSL https://valoryx.org/install.sh | shPort 3000 in use — Use a different port:
docplatform serve --port 8080Wrong binary — Check your OS/arch:
uname -smBehind a proxy — Set
HTTP_PROXY and HTTPS_PROXY before running the installerStill stuck? Open an issue on GitHub
Need a managed solution?
Valoryx Cloud handles hosting, backups, and updates so your team can focus on writing.