Skip to content

About

YunoHost package for Yuvomi, the self-hosted family planner

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Yuvomi logo

Yuvomi for YunoHost

The self-hosted family planner, as a YunoHost app.

Tasks, calendar, budget, meals, health and more for the whole household, on your YunoHost server, with its own domain and in every YunoHost backup.

Package version Runs on amd64 and arm64 YunoHost 12.1.17 or newer Lint status MIT license

→ Install  ·  Admin notes  ·  Releases  ·  Yuvomi  ·  yuvomi.cloud

This repository packages Yuvomi for YunoHost. The package installs the official Yuvomi release unchanged, runs it as a systemd service behind YunoHost's nginx and keeps its secrets in the app settings. What Yuvomi itself does, module by module, is on yuvomi.cloud and in the main repository.


Install

The package is not in the YunoHost catalog yet. Install it from this repository:

sudo yunohost app install https://github.com/ulsklyc/yuvomi_ynh
  1. Pick a domain or subdomain of its own (for example family.example.com); Yuvomi cannot run under a sub path yet.
  2. Pick the YunoHost user who becomes the Yuvomi administrator and enter a password for that account. It is separate from the YunoHost password.
  3. Open the domain, sign in and invite the rest of the family from Settings > Family. They need no YunoHost account. On phones, add the page to the home screen, no app store needed.

Requirements - YunoHost 12.1.17 or newer on amd64 or arm64, about 200 MB RAM while running (600 MB during install and upgrade) and 600 MB of disk.

What the package takes care of

  • The administrator account - created during the install, so the first-run setup page never faces the internet.
  • Database encryption - always on. The key is generated at install, kept in the app settings and carried by every YunoHost backup; an upgrade without it stops instead of opening the database with a new one.
  • YunoHost backups - a backup stops Yuvomi for a few seconds and copies the database while it is closed, so the copy is consistent. Yuvomi's own daily backups, documents and modules are in it too.
  • Upgrades - .env is rebuilt from the app settings on every upgrade, the database migrations run on the next start.
  • System integration - nginx in front, a hardened systemd service, log rotation, and the service in the YunoHost admin.

Admin notes (key, backups, configuration, logs) are in doc/ADMIN.md.

Not yet: the YunoHost catalog, sub paths and the YunoHost login
  • YunoHost catalog - the package is installed from this repository until it is accepted into the catalog. From then on YunoHost's bot generates this README from manifest.toml and doc/.
  • Sub path - Yuvomi does not run under a sub path such as example.com/yuvomi yet. Sub-path support is discussed in ulsklyc/yuvomi#2231.
  • YunoHost login (SSO, LDAP) - Yuvomi keeps its own accounts and supports OpenID Connect. Keep the app public ("visitors"), so the installable app, calendar feeds and API tokens work outside the YunoHost portal.

How it works

The package downloads the Yuvomi release asset (yuvomi-<version>-dist.tar.gz) named in manifest.toml (checked by sha256; the asset carries a GitHub build provenance attestation), installs the runtime dependencies with npm and removes what the server never reads, the same list the official container image leaves out. Yuvomi itself runs unchanged, and this repository contains no Yuvomi code.

Yuvomi path On the YunoHost server (app id yuvomi)
database /home/yunohost.app/yuvomi/db/yuvomi.db (encrypted)
backups /home/yunohost.app/yuvomi/backups
documents /home/yunohost.app/yuvomi/documents
modules /home/yunohost.app/yuvomi/modules
configuration /var/www/yuvomi/.env (managed, see above)
log /var/log/yuvomi/yuvomi.log

A second instance gets its own id (yuvomi__2) and paths.

The package version is the Yuvomi version plus a package revision, e.g. 2.85.0~ynh1.

Maintaining this repository
  • New Yuvomi release - the Bump workflow checks for a new release every day and opens one pull request with the new version, asset URL, sha256 (taken only after gh attestation verify passed) and the upstream diff of the files the package depends on. Before merging, read that diff and the Yuvomi release notes for changes to environment variables, secrets, Node or the files the server needs, and install or upgrade once on a YunoHost server.
  • Package changes - raise the ~ynhN revision in manifest.toml.
  • Contributing - constraints, decisions, commit and AI assistance rules are in CONTRIBUTING.md.

Support



Yuvomi logo

One home for your household. On the server you already run.

→ Install it  ·  Take the tour  ·  Ask a question


MIT licensed, see LICENSE. Yuvomi itself is MIT-licensed by ulsklyc.

About

YunoHost package for Yuvomi, the self-hosted family planner

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages