Ferret

Ferret is a self-hosted home inventory for multiple people in a household that catalogs items by photo, barcode, or room, finds them by search, and keeps…

  • Business & Finance
  • Home Automation
  • Productivity
  • Tools & Utilities
Ferret is a self-hosted home inventory for multiple people in a household that catalogs items by photo, barcode, or room, finds them by search, and keeps warranties, manuals, maintenance, stock, lending, insurance reports, and box labels in one place.

Platform availability

Available on 2 of 10 platforms

  • Unraid
  • TrueNAS
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

46/100 Fair

Maintained
75last commit 15 days ago
Popular
144 GitHub stars
Easy to install
452 install platforms, install notes, Docker image
Light to run
208 GB minimum RAM, runs on ARM

Availability: platform listings confirmed today

GitHub stars
4
Open issues
0
Last commit
2026-11-06
Latest release
2026.11.6
License
MIT
Activity
rising

Checked 15 days ago - source: GitHub (ferret-project/ferret)

Resources & Compatibility

Minimum requirements: 8 GB RAM, 6 CPU core(s). ARM (e.g. Raspberry Pi) is supported.

Checked 15 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Set Docker login, port, and data Replace <username> and <password> with your own login before starting, leave port 27017 reachable, and back up the local ./data folder. Client apps use that port and those credentials to reach FerretDB, while ./data holds your saved data, so losing it means losing your database. source
  • Install PostgreSQL first If your FerretDB setup does not already include PostgreSQL, install it as a prerequisite before starting FerretDB. FerretDB relies on PostgreSQL to actually store and query your data, so if PostgreSQL is missing the installation or first start can fail. source
  • Start services with Docker Compose After any required settings are filled in, run docker compose up to bring FerretDB and its supporting services online. If you skip this, the containers are not running, so the app will be unreachable and data operations won't work. source
  • Set PUBLIC_URL before first start Set the PUBLIC_URL environment variable before the first start; on first run Ferret generates its own secrets. source
  • Create a key file (FILES_KEY) After first start, make a key file under Settings, Server, Keys and keep it off the server; without FILES_KEY, uploaded photos and documents can't be read. source
  • Optional AI features AI features are optional and run on your own models: set Ollama, an OpenAI-compatible server, Qdrant, and docling addresses under Settings 'Show more settings'; built-in help for setup to AI stack is at /docs. source

Fetched yesterday - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

What .env variables should I set before first startup?

Set AUTH_SECRET and FILES_KEY, each generated with openssl rand -base64 32, plus PUBLIC_URL. The first account created becomes the server admin.

How do I configure Ferret behind a reverse proxy?

Set TRUSTED_PROXIES to the reverse proxy address.

Can Ferret's AI features use local models?

AI is optional and can be pointed at Ollama, any OpenAI-compatible server, or docling.

What user roles and sign-on options are available?

Households can have owners, admins, members, and read-only viewers. Invitations are sent by email, and single sign-on can use your own identity provider.

How is Ferret data stored and backed up?

Ferret uses one Docker container with SQLite. It supports nightly backups with a restore check and lets you download everything anytime.

Does Ferret have a mobile app?

There is an installable phone app that works offline, with barcode and QR scanning built in.

Answers sourced from github.com

Community

Collected 15 days ago - public community threads