RaisFastRaisFast
Getting Started

Installation

Install RaisFast in seconds — choose from curl, npm, Homebrew, Docker, cargo, or build from source.

macOS / Linux

curl -fsSL https://raisfast.com/install.sh | sh

Windows (PowerShell)

irm https://raisfast.com/install.ps1 | iex

Verify

raisfast --version

All Install Methods

Install globally:

npm install -g raisfast

Or run without installing:

npx raisfast --help

The npm package wraps the native binary — no Node.js runtime required at execution time.

brew tap RaisFast/homebrew-tap
brew install raisfast

Pull from GitHub Container Registry:

docker pull ghcr.io/raisfast/raisfast:latest

Run:

docker run -d \
  --name raisfast \
  -p 9898:9898 \
  -v ./data:/app/data \
  ghcr.io/raisfast/raisfast:latest

Or 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 -d

Available tags: latest, 0.2, 0.2.23 (semver).

cargo install raisfast

Requires Rust toolchain. Installs from crates.io.

Download pre-built binaries from GitHub Releases:

PlatformTarget
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 compilercc on 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.Just

Quick 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 dev

The binary is output at target/release/raisfast.

just Commands

CommandDescription
just buildBuild release binary (SQLite + all plugins + search)
just build-fullBuild release binary with embedded Admin UI
just devStart development server
just checkCompile check (fast, no binary output)
just lintRun clippy with warnings as errors
just testRun all tests
just qaFormat check + lint
just ciFull CI pipeline: fmt → lint → test

Database Backend

Switch the database backend by overriding the db variable:

just db=postgres check
just db=mysql check

Manual 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, proxy

Feature Flags

Database (pick one)

FlagDescription
db-sqliteSQLite backend
db-postgresPostgreSQL backend
db-mysqlMySQL backend

Plugin Engines

FlagDescription
plugin-jsJavaScript (QuickJS)
plugin-luaLua 5.4 (mlua)
plugin-rhaiRhai scripting
plugin-wasmWebAssembly (wasmtime)
plugin-allAll four engines

Search & Storage

FlagDescription
search-tantivyFull-text search via Tantivy
storage-s3S3-compatible object storage

Payment Providers

FlagDescription
payment-alipayAlipay
payment-wechatWeChat Pay
payment-stripeStripe
payment-dodoDodo Payments
payment-creemCreem
payment-allAll payment providers

Other

FlagDescription
tlsHTTPS via rustls
openapiSwagger UI at /api/docs
proxyMulti-tenant reverse proxy
tauriTauri desktop mode

System Diagnostics

After installation, run the built-in health check:

raisfast doctor

This validates your environment, configuration, database connectivity, and security settings.

On this page