Installation
Install RaisFast in seconds — choose from curl, npm, Homebrew, Docker, cargo, or build from source.
Quick Install (Recommended)
macOS / Linux
curl -fsSL https://raisfast.com/install.sh | shWindows (PowerShell)
irm https://raisfast.com/install.ps1 | iexVerify
raisfast --versionAll Install Methods
Install globally:
npm install -g raisfastOr run without installing:
npx raisfast --helpThe npm package wraps the native binary — no Node.js runtime required at execution time.
brew tap RaisFast/homebrew-tap
brew install raisfastPull from GitHub Container Registry:
docker pull ghcr.io/raisfast/raisfast:latestRun:
docker run -d \
--name raisfast \
-p 9898:9898 \
-v ./data:/app/data \
ghcr.io/raisfast/raisfast:latestOr use Docker Compose for the full stack (backend + frontend + S3 storage):
curl -O https://raw.githubusercontent.com/RaisFast/raisfast/main/docker-compose.yml
docker compose up -dAvailable tags: latest, 0.2, 0.2.23 (semver).
cargo install raisfastRequires Rust toolchain. Installs from crates.io.
Download pre-built binaries from GitHub Releases:
| Platform | Target |
|---|---|
| macOS (Apple Silicon) | aarch64-apple-darwin |
| macOS (Intel) | x86_64-apple-darwin |
| Linux (ARM64) | aarch64-unknown-linux-gnu |
| Linux (ARM64, static) | aarch64-unknown-linux-musl |
| Linux (x86_64) | x86_64-unknown-linux-gnu |
| Linux (x86_64, static) | x86_64-unknown-linux-musl |
| Windows (x86_64) | x86_64-pc-windows-msvc |
Download, extract, and move to your PATH.
Build from Source
If you need a custom feature set or want to contribute.
Prerequisites
- Rust 1.85+ (edition 2024)
- C compiler —
ccon Linux, Xcode CLI tools on macOS - SQLite3 development headers
- just — command runner (recommended)
Install just with your preferred package manager:
# macOS
brew install just
# Linux
curl -LsSf https://github.com/casey/just/releases/latest/download/just-installer.sh | sh
# Or via cargo
cargo install just
# Windows
winget install --id Casey.JustQuick Build with just
git clone https://github.com/RaisFast/raisfast.git
cd raisfast
# Build release binary (SQLite + all plugins + search)
just build
# Build with Admin UI (frontend + backend)
just build-full
# Start dev server
just devThe binary is output at target/release/raisfast.
just Commands
| Command | Description |
|---|---|
just build | Build release binary (SQLite + all plugins + search) |
just build-full | Build release binary with embedded Admin UI |
just dev | Start development server |
just check | Compile check (fast, no binary output) |
just lint | Run clippy with warnings as errors |
just test | Run all tests |
just qa | Format check + lint |
just ci | Full CI pipeline: fmt → lint → test |
Database Backend
Switch the database backend by overriding the db variable:
just db=postgres check
just db=mysql checkManual Build
Without just, use cargo directly:
# Default features (SQLite + all plugins + search + OpenAPI)
cargo build --release
# Custom features
SQLX_OFFLINE=false DATABASE_URL="sqlite:./storage/db/raisfast.db?mode=rwc" \
cargo build --release --no-default-features \
--features "db-sqlite,plugin-all,search-tantivy,openapi"Default Features
Building without --no-default-features enables:
db-sqlite, search-tantivy, plugin-js, plugin-lua, plugin-rhai, openapi, proxyFeature Flags
Database (pick one)
| Flag | Description |
|---|---|
db-sqlite | SQLite backend |
db-postgres | PostgreSQL backend |
db-mysql | MySQL backend |
Plugin Engines
| Flag | Description |
|---|---|
plugin-js | JavaScript (QuickJS) |
plugin-lua | Lua 5.4 (mlua) |
plugin-rhai | Rhai scripting |
plugin-wasm | WebAssembly (wasmtime) |
plugin-all | All four engines |
Search & Storage
| Flag | Description |
|---|---|
search-tantivy | Full-text search via Tantivy |
storage-s3 | S3-compatible object storage |
Payment Providers
| Flag | Description |
|---|---|
payment-alipay | Alipay |
payment-wechat | WeChat Pay |
payment-stripe | Stripe |
payment-dodo | Dodo Payments |
payment-creem | Creem |
payment-all | All payment providers |
Other
| Flag | Description |
|---|---|
tls | HTTPS via rustls |
openapi | Swagger UI at /api/docs |
proxy | Multi-tenant reverse proxy |
tauri | Tauri desktop mode |
System Diagnostics
After installation, run the built-in health check:
raisfast doctorThis validates your environment, configuration, database connectivity, and security settings.
