Look after
your place.

Install, run, and back up Folkweave. Each guide links to the app’s own docs.

Install and get started.

Run with Docker Compose
Published images for amd64 or arm64, with version pins, storage, and upgrades.
Published container images
Every release tag on GitHub Container Registry.
Downloads, checksums, and installation
Pick a release and follow the steps for your system.
Gentoo overlay
Install with Portage, services included.
Build from source
Build steps and development notes.
Try the local demo
Build with Go 1.26.11 or newer and run a throwaway copy with sample content.

Configure and look after it.

Back up and recover.

The app backs itself up every day. Keep a copy on another machine, and test a restore before you need one.

Automatic backups
What’s in a backup, how long copies are kept, and how to spot a failure.
Restore and retention instructions
Accounts and data

Upgrade with a way back.

Read the release notes and make a backup first. After a database migration, the only way back is that backup.

Make yourself at home.

Set up in the browser or in a terminal.

sudo folkweave setup
sudo folkweave create-owner --username yourname
sudo folkweave set-password --username yourname

setup prints a private key for the browser page. The account commands ask for the password twice without showing it. Scripts can use --password-stdin or --password-file PATH, and --data-dir DIRECTORY picks an instance. More in the setup guide.

Write every setting as KEY="value", following the shared configuration format. OpenRC reads /etc/conf.d/folkweave; systemd reads /etc/folkweave/folkweave.env.

When something needs attention.

Start with the deployment guide. Still stuck? search or open an issue with your app version, how you installed it, and the error. Remove passwords, tokens, and private data from logs first.