README

Maintainable, plugin-first open-source forum framework.

Core is the host (identity, forum primitives, permissions, extension runtime, contracts). Deployment-specific behavior—mail transport, optional search engines, storage vendors, and similar—lives in extensions.

Documentation

Language	Start here
简体中文	`docs/zh-CN/README.md`
English	`docs/en-US/README.md`
Hub	`docs/README.md`

Quick paths:

快速开始 / Getting started
使用说明 / Usage
开发指南 / Development
生产部署 / Deployment
Extension technical reference: docs/extensions/

Repository map

Path	Role
`apps/web`	Nuxt 4 frontend
`apps/api`	Go Fiber API with embedded River worker, CLI
`contracts/`	OpenAPI + Protobuf
`extensions/`	Built-in / optional / dev packages
`docs/`	Bilingual handbooks + extension reference
`knowledge/`	Decisions, module notes, session handoffs
`scripts/`	Dev and test helpers
`deploy.sh` + `compose*.yaml`	Production and dependency orchestration

Local development

./scripts/dev.sh                 # PostgreSQL, Redis, Mailpit + migrations
./scripts/api-dev.sh             # API (embeds worker in dev)
cd apps/web && bun run dev       # Nuxt on :3000

Background jobs: the API process always embeds the River worker in development and production. Worker ownership is not configurable, so saved settings, SecretStore access, extension runtimes, and queue consumers share one process.

Useful URLs:

Web: http://127.0.0.1:3000
API health: http://127.0.0.1:3000/api/v1/health
API ready: http://127.0.0.1:3000/api/v1/ready
Mailpit: http://127.0.0.1:18025

Meilisearch is optional (docker compose --profile search up -d meilisearch). Default search is built-in site PostgreSQL FTS.

Full steps: docs/zh-CN/getting-started.md or docs/en-US/getting-started.md.

Production

The rolling install entry downloads and verifies the latest stable Release bootstrap. It then refreshes the complete matching deploy toolkit:

(
  set -eu
  mkdir -p sforum
  cd sforum
  bootstrap_dir="$(mktemp -d .sforum-bootstrap.XXXXXX)"
  trap 'rm -rf "$bootstrap_dir"' EXIT HUP INT TERM
  curl -fsSLo "$bootstrap_dir/sforum-bootstrap.sh" \
    https://github.com/zhuchunshu/SForum/releases/latest/download/sforum-bootstrap.sh
  curl -fsSLo "$bootstrap_dir/SHA256SUMS" \
    https://github.com/zhuchunshu/SForum/releases/latest/download/SHA256SUMS
  (
    cd "$bootstrap_dir"
    awk '$2 == "sforum-bootstrap.sh" { print }' SHA256SUMS > sforum-bootstrap.sha256
    test "$(wc -l < sforum-bootstrap.sha256 | tr -d '[:space:]')" = 1
    if command -v sha256sum >/dev/null 2>&1; then
      sha256sum -c sforum-bootstrap.sha256
    else
      shasum -a 256 -c sforum-bootstrap.sha256
    fi
    if command -v gh >/dev/null 2>&1; then
      gh attestation verify sforum-bootstrap.sh --repo zhuchunshu/SForum
    fi
  )
  install -m 0755 "$bootstrap_dir/sforum-bootstrap.sh" ./sforum-bootstrap.sh
  rm -rf "$bootstrap_dir"
  trap - EXIT HUP INT TERM
  ./sforum-bootstrap.sh install  # Enter uses the latest stable release
)

Never pipe remote shell content into bash. Download the bootstrap and its SHA256SUMS, verify the exact filename entry, and only then execute it — see docs/zh-CN/deployment.md for the full instructions.

Existing installations update through ./sforum-bootstrap.sh upgrade. Every run refreshes the bootstrap and the target Release's complete deploy toolkit before handing off to upgrade.sh. The default resolves to the newest stable Release and is confirmed before any change (--yes skips prompts). Prereleases are never selected implicitly: pass --channel prerelease or an explicit tag such as v3.0.0-alpha.N. Every choice resolves to a concrete vX.Y.Z tag and runs the matching GHCR images — floating latest images are never used in production Compose.

Production uses one API process with an embedded River worker, sharing the database pool, SecretStore-backed settings, and extension runtime. Existing standalone Worker containers from older releases are removed during an update; legacy environment settings cannot disable the API-owned worker.

The first blue/green ingress conversion has a short maintenance window. Later releases keep API/Web HTTP traffic available when the database is unchanged or every pending Core migration explicitly declares backward-compatible online execution; WebSockets may reconnect while durable River jobs remain protected by the queue during the API slot handoff. Undeclared Core and all River migrations use the blue/green-aware deploy.sh maintenance path.

Details: docs/zh-CN/deployment.md / docs/en-US/deployment.md.

Community

Report vulnerabilities privately according to SECURITY.md.
SForum is available under the MIT License.

Contributing / agents

Read AGENTS.md
Read docs/ for usage and development
Read knowledge/index.md for current project memory
Keep OpenAPI, tests, and knowledge notes updated with code changes

zhuchunshu / sforum

Maintainers

Package info

Fund package maintenance!

Statistics

Security