Skip to content
avrabePublic

About

Self-hosted household photo and video library as one Rust binary: timeline per person, world map, local faces

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

lichtbild

A self-hosted photo and video library for a household, as one Rust binary.

lichtbild indexes photo folders read-only, in place, without copying or moving them. It serves:

  • a timeline per person, or merged;
  • a world map of where photos were taken (planned);
  • later, face recognition and similar search.

Everything runs on the home server. The map tiles come from a local file, and no photo, place or face leaves the house.

Status: v0.1.0 skeleton. lichtbild scan indexes JPEG, PNG, WebP and GIF, makes thumbnails and reports every file it found as indexed or skipped with a reason; HEIC and video are counted as "not yet supported". lichtbild serve renders the timeline. There is no login yet, so serve listens on loopback only. See docs/BRIEF.md for what it should become.

Use

export LICHTBILD_ROOTS='person1=/srv/photos/person1;person2=/srv/photos/person2'
export LICHTBILD_DATA_DIR=/var/lib/lichtbild
lichtbild serve    # http://127.0.0.1:8080/, scans at start and every 24 h
lichtbild scan     # one scan and its report, only while no server runs; exit 2 if found != indexed + skipped

The index is a redb file in the data directory, owned by one process: serve scans in a low-priority background thread and logs the report; scan refuses while a server holds the index.

All settings are in lichtbild --help and config.example.toml. The data directory must exist (lichtbild creates nothing at startup), and lichtbild refuses to start when it and a root overlap. Behind a reverse proxy, set LICHTBILD_ALLOWED_HOSTS to the public host name: requests for any other host get 421.

Verification

Losses, hazards, constraints, requirements and tests are rivet artifacts in artifacts/; the control structure is in docs/control-structure.md. varve run -- rivet validate must pass with 0 warnings. docs/planted-faults.md lists the fault that shows each check can fail.

Releases are signed like haus's: verify SHA256SUMS.txt with

cosign verify-blob \
  --certificate-identity-regexp '^https://github\.com/avrabe/lichtbild/\.github/workflows/release\.yml@refs/tags/v[0-9][^/]*$' \
  --certificate-oidc-issuer https://token.actions.githubusercontent.com \
  --bundle SHA256SUMS.txt.cosign.bundle SHA256SUMS.txt
sha256sum -c --ignore-missing SHA256SUMS.txt

License

Apache-2.0, see LICENSE.

About

Self-hosted household photo and video library as one Rust binary: timeline per person, world map, local faces

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages