Installation

Requirements

• Python 3.11 or newer
• Git

Step by step

git clone https://github.com/airenare/inkstone.git
cd inkstone

# 2. Install dependencies
pip install -r requirements.txt

# 3. Point at your vault
echo "VAULT_PATH=/path/to/your/vault" > .env

# 4. Run
python3 app.py

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Docker alternative

If you'd rather not touch Python at all:

docker build -t inkstone .
docker run -p 8000:8000 -e VAULT_PATH=/vault -v /path/to/vault:/vault inkstone

See Docker for compose examples and private vault setup.

First-run checklist

• Repository cloned
• Dependencies installed (`pip install -r requirements.txt`)
• `VAULT_PATH` set in `.env` or as an environment variable
• At least one note has `website: true` in frontmatter
• Server running (`python3 app.py`)
• Site visible at `http://localhost:8000`