Inkweld

Self-hosted collaborative writing platform for novelists & worldbuilders
Your words, your server, your control.

Quick Start • Features • Status • Architecture • Development • Contributing

# Pull and run with Docker
docker run -d \
  --name inkweld \
  -p 8333:8333 \
  -e HOST=0.0.0.0 \
  -e SESSION_SECRET=$(openssl rand -hex 32) \
  -e WEBAUTHN_RP_ID=your-domain.com \
  -e ALLOWED_ORIGINS=https://your-domain.com \
  -v inkweld_data:/data \
  ghcr.io/bobbyquantum/inkweld:latest

Then open http://localhost:8333 in your browser.

📖 Full deployment guide →

Write together, or alone. Work entirely in your browser with no server, keep writing across your devices through your own cloud storage, or connect to an Inkweld server for real-time collaboration.

Build your world as you write. Create characters, locations, factions — whatever your story needs. Link them together with relationships, and reference them directly in your prose with @mentions.

Own your data. Many hosting options are supported. Native sync server binaries (thanks to Bun), self contained Docker images, and support for Cloudflare free tier deployment.

Export when you're ready. PDF, EPUB, Markdown, HTML. Configurable publish plans let you publish multiple asset variants from a single project.

📋 Full feature roadmap →

• Can be deployed and used now, however, until numbered releases are started, there are no guarantees that data migration paths will be available.
• Not recommended for production use. If you do use it in this way, always back up your work before upgrading, and be aware, manual fixing of exports might be needed to move to newer versions.
• At some point closer to the first numbered release, the drizzle migrations will be squashed into a single V1 migration, meaning existing databases will need to be reset or manually fixed.

Status: ✅ Done | 🔨 In Progress | ⬜ Planned
Priority: 🔥 High | 🟡 Medium | 🟢 Nice to have

All AI features require admin configuration and are disabled by default. See AI Stance.

Inkweld has two parts that can run together or separately, plus an optional Cloud Sync mode that needs neither an Inkweld server nor an account:

The client is where you write. It's a full web app that works offline.

The server enables real-time collaboration and sharing. Run it on your own hardware or a VPS. Without it, you can still use Inkweld locally — documents save to your browser.

Cloud Sync mirrors your projects to your own Dropbox or Nextcloud straight from the browser, so you can move between devices without running a server.

• Bun 1.4+
• Node.js 22+

git clone https://github.com/bobbyquantum/inkweld.git
cd inkweld
bun install
cp .env.example .env
npm run dev

Frontend runs on :4200, backend on :8333.

📖 Developer docs →

Inkweld is self-hosted — the content on your server doesn't leave your server and any browsers you connect with.

The exception to this are if you use external AI services. There's an AI Kill Switch that disables all AI features, and AI is disabled by default.

If you choose to enable AI features, you can configure both self hosted services and external services, and uses include image generation based on content, and grammar suggestions.

You should be aware when using external AI services that content could be used to train, and in the case of some providers, even be published or sold as training data sets.

Always check the provider policies when configuring AI features.

Disclosure: GitHub Copilot and Claude Code is used in development (a lot). The desktop background image in the main app is currently AI-generated. Some of the examples in the docs use generative AI for images and text.

The main logo is not AI, this was hand-drawn in Inkscape as SVG.

Check out the Status and Feature Roadmap for areas that need work.

• 🐛 Report bugs
• 💡 Request features
• 🔧 Submit PRs

MIT — see LICENSE.