Quick Start

May 21, 2026 · 1 min read

Contents

Local

git clone https://github.com/airenare/inkstone.git
cd inkstone
pip install -r requirements.txt
VAULT_PATH=/path/to/your/vault python3 app.py

Alternatively, create .env and write VAULT_PATH=/path/to/your/vault in it. Then just:

python3 app.py

Docker

docker run -p 8000:8000 \
-e VAULT_PATH=/vault \
-v /path/to/your/vault:/vault \
inkstone

No Python installation required.

Production

See Production Deployment for Coolify, webhooks, and SSL setup.

Your first note

Create any .md file in your vault and add this frontmatter:

---
website: true
title: Hello World
date: 2026-01-01
---

This is my first published note.

The server hot-reloads — save your note and refresh the browser. No restart needed.

The note is now live at /hello-world. That's it.

For the full frontmatter reference, see Frontmatter Reference.