Skip to main content

Quick Start

Get Inkweld running on your machine in minutes.

Try with Docker​

The fastest way to try Inkweld:

docker run -p 8333:8333 \
  -v inkweld_data:/data \
  -e SESSION_SECRET=your-secret-key-min-32-characters-long \
  -e CLIENT_URL=http://localhost:8333 \
  ghcr.io/bobbyquantum/inkweld:latest

Open http://localhost:8333 and create your first account.

Local Development​

Clone and run from source:

git clone https://github.com/bobbyquantum/inkweld.git
cd inkweld
bun install
npm start

The frontend runs on port 4200, backend on port 8333.

Next Steps​

🌟 Features

See what Inkweld can do

🚀 Installation

Deploy for production

✍️ User Guide

Learn how to use Inkweld

⚙️ Configuration

Environment variables and settings

Community​