BucketNest Try the demo

Self-host BucketNest

Free, with every feature. Your data stays on your own hardware.

What you need

  • A Linux server, NAS or VM with Docker. 2 GB of RAM is plenty; a Raspberry Pi 5 works too.
  • A domain name and a reverse proxy for HTTPS (Caddy, nginx, Traefik or a Cloudflare Tunnel), or just your home network.
  • About 30 minutes the first time.

Quick start

git clone https://github.com/brendanlib/bucketnest.git
cd bucketnest
cp .env.example .env && chmod 600 .env
sed -i "s|^SESSION_SECRET=.*|SESSION_SECRET=$(openssl rand -hex 32)|" .env
sed -i "s|^POSTGRES_PASSWORD=.*|POSTGRES_PASSWORD=$(openssl rand -hex 24)|" .env
nano .env            # set PUBLIC_URL to the address you'll use
mkdir -p inbox && sudo chown 1000:1000 inbox
docker compose up -d --build

Open your address and register: the first account becomes the household owner, and sign-up then closes. Invite everyone else from Settings → Household.

Read the full deployment guide View the source

Keeping it running

  • Updates: git pull && docker compose up -d --build. Database migrations run themselves.
  • Backups: ./scripts/backup.sh on a schedule, with copies kept off the server.
  • Help: the guide has a troubleshooting table, and you can report a bug any time.

The licence, in plain English

BucketNest is free software under the GNU Affero General Public License v3. You can use it, change it and share it, for yourself or your clients. If you change it and run it as a service for other people, you have to offer them your changed source code too. That keeps it open for everyone.