selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

OpenFamily logo

Self-host OpenFamily

v1.9.0

Self-hosted family organizer with calendar, budget, recipes

ReleaseOpen SourceAGPL-3.0
Updated8 hours ago
LanguageTypescript
Setup difficultyModerate
MobileNative app
ThemeDark mode
Stars
198
CPU
1 CPU core
RAM
1 GB
Storage
3 GB for Docker images + few hundred MB for database
Ports
80 (Frontend (Nginx)), 3001 (Backend API)
Requires
Node.js, PostgreSQL
Docker
ghcr.io/nexaflowfrance/openfamily-client
Install with Docker Compose
OpenFamily dashboard overviewShopping list with store modeMonthly calendar viewBudget tracking with chartsWeekly meal plannerFamily member profilesWeekly planning view

What is OpenFamily?

OpenFamily is a self-hosted family organizer built by NexaFlow France. It centralizes household management with 12 modules: shopping lists with store mode and templates, recurring tasks with assignments, a monthly calendar with reminders and iCal export, weekly planning for work and school schedules, a recipe library with advanced filters, a weekly meal planner with PDF export, and a budget tracker with charts and per-category limits. Family profiles store health info and emergency contacts. Real-time sync via WebSocket keeps all devices updated, and Web Push VAPID delivers notifications even when the application is not open. The app supports parent/child roles with read-only budget for children, multilingual interface (English, French, Simplified Chinese), and offline browsing via PWA. It runs as a three-container Docker stack (PostgreSQL 16, Node.js/Express API, React/Nginx frontend) or via a Windows all-in-one installer that bundles Node.js and PostgreSQL. An Android APK connects to your self-hosted server. Integrations include Mealie and Tandoor for recipe import, Home Assistant and Grocy for shopping list sync, and Nextcloud for CalDAV calendar import. Licensed under AGPL-3.0 with a paid cloud option (OpenFamily Cloud) for those who prefer not to self-host.

Should you self-host OpenFamily?

OpenFamily scores 51/100 on selfhost.directory (how scoring works) and ranks #8 of 15 in Home Management. It has 198 GitHub stars.

It shipped 10 stable releases in the past year. The latest, v1.9.0, came out on 25 October 2026. New versions land roughly every 2 weeks.

Setup is moderate: expect some configuration beyond a single command. An official Docker image is available. It is AGPL-3.0-licensed and written mostly in Typescript.

Its closest alternative on selfhost.directory is yuvomi (76/100, 2 068 stars). It scores higher overall, so compare the two before you pick. See OpenFamily vs yuvomi side by side.

Features

  • Budget tracking
  • Calendar with reminders
  • Family profiles
  • Meal Planner
  • Multilingual interface
  • Offline mode (PWA)
  • Push Notifications
  • Real-time sync
  • Recipe library
  • Shared accounts with roles
  • Shopping list with store mode
  • Task Management
  • Third-party Integrations
  • Weekly planning

OpenFamily README

How to install OpenFamily

Install OpenFamily with Docker Compose

Environment variables
POSTGRES_PASSWORD, JWT_SECRET, TZ, VAPID_*, SMTP_*, REGISTRATION_ENABLED, CORS_ORIGINS, APP_PUBLIC_URL, ANDROID_CERT_SHA256, ANDROID_PACKAGE_NAME

cp .env.example .env # edit your settings docker-compose up -d --build

Recommended for servers. Published images available at ghcr.io/nexaflowfrance/openfamily-server and ghcr.io/nexaflowfrance/openfamily-client

How to configure OpenFamily

  • ANDROID_CERT_SHA256Android app signing cert SHA256

    Android app signing cert SHA256

  • ANDROID_PACKAGE_NAMEAndroid package name

    Android package name

  • APP_PUBLIC_URLPublic URL for email links

    Public URL for email links

  • AUTH_RATE_LIMIT_MAX10Max auth requests per window

    Max auth requests per window

  • AUTH_RATE_LIMIT_WINDOW_MS900000Auth rate limit window in ms

    Auth rate limit window in ms

  • CORS_ORIGINShttp://localhost:5173,http://localhost:3000Allowed CORS origins (comma-separated)

    Allowed CORS origins (comma-separated)

  • JWT_SECRETreplace-me-with-a-long-random-secretJWT signing secret (32+ chars)

    JWT signing secret (32+ chars)

  • MAIL_FROMFrom email address

    From email address

  • NODE_ENVdevelopmentNode environment

    Node environment

    values: production, development

  • POSTGRES_DBopenfamilyDatabase name

    Database name

  • POSTGRES_HOSTlocalhostDatabase host

    Database host

  • POSTGRES_PASSWORDopenfamily2024Database password

    Database password

  • POSTGRES_PORT5433Database port

    Database port

  • POSTGRES_USERopenfamilyDatabase user

    Database user

  • REGISTRATION_ENABLEDtrueAllow self-registration

    Allow self-registration

    values: true, false

  • SERVER_PORT3001Backend server port

    Backend server port

  • SMTP_HOSTSMTP server host

    SMTP server host

  • SMTP_PASSSMTP password

    SMTP password

  • SMTP_PORT587SMTP server port

    SMTP server port

  • SMTP_SECUREfalseUse secure SMTP

    Use secure SMTP

    values: true, false

  • SMTP_USERSMTP username

    SMTP username

  • SUPPORT_EMAILSupport email shown in emails

    Support email shown in emails

  • TZEurope/ParisFamily time zone (IANA)

    Family time zone (IANA)

  • VAPID_PRIVATE_KEYWeb Push VAPID private key

    Web Push VAPID private key

  • VAPID_PUBLIC_KEYWeb Push VAPID public key

    Web Push VAPID public key

  • VAPID_SUBJECTmailto:your-email@example.comVAPID subject (mailto:)

    VAPID subject (mailto:)

  • VITE_API_URLAPI URL for separate origin deployment

    API URL for separate origin deployment

  • VITE_WS_URLWebSocket URL for separate origin deployment

    WebSocket URL for separate origin deployment

OpenFamily releases & version history

More in Home Management

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…