Install

typress ships as a single binary. The Bun runtime, SQLite, the admin SPA, the theme runtime, and the plugin host are all in one executable. No PHP, no Node.js, no external database.

Use the release binary

GitHub Releases carries linux-x64 / macos-arm64 / macos-x64 / windows-x64 builds with SHA-256 checksums.

# Linux
curl -fsSL -o typress https://github.com/miazakura01/typress/releases/latest/download/typress-linux-x64
chmod +x typress

# Verify
curl -fsSL https://github.com/miazakura01/typress/releases/latest/download/typress-linux-x64.sha256
sha256sum typress

Build from source

Bun 1.3 or newer. Cross-compiling currently produces a broken JSC heap on the target platform — a known Bun bug — so build natively on the same OS you'll deploy to.

git clone https://github.com/miazakura01/typress.git
cd typress
bun install
bun test
bun run build:bin   # produces dist/typress

First boot

Run the executable. The server initialises a fresh data directory and SQLite on the spot.

./typress
# typress listening on http://localhost:4321
# data dir: ./data

Open http://localhost:4321/admin in a browser. On first launch it redirects to the admin-account setup. Pick an email and a 12+ character password, and the admin UI is live from that moment.

Next steps

Before going to production you should set TYPRESS_MASTER_KEY and TYPRESS_PUBLIC_ORIGIN at minimum — see Configuration. For systemd and TLS, see Deployment.