# 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 warranties, manuals, maintenance, stock, lending, insurance. It is open source and self-hosted, installable on TrueNAS and Unraid.

Canonical page: https://ourlocalhost.com/app/7509/ferret

## Description

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.

## Health score

46/100 (Fair), based on 4 of 4 factors.
- Maintained: 75 (last commit 15 days ago)
- Popular: 14 (4 GitHub stars)
- Easy to install: 45 (2 install platforms, install notes, Docker image)
- Light to run: 20 (8 GB minimum RAM, runs on ARM)

## Links

- TrueNAS: https://apps.truenas.com/catalog/ferret/
- Unraid: https://ca.unraid.net/apps/ferret-0v2a7h508xjer9?q=Ferret
- GitHub: https://github.com/ferret-project/ferret
- Official website: https://digitalempire.us
- Documentation: https://ferret-demo.digitalempire.us/docs/

## 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.

---
Source: Our Local Host (https://ourlocalhost.com/app/7509/ferret), the self-hosted and open-source app directory.
