Skip to content
Wulfic edited this page May 9, 2026 · 2 revisions

Simple Photos — Wiki

A privacy-first, self-hosted photo & media library. The Rust server, React web app, and Android client share one storage model and one HTTP API.

Documentation

  • API Reference — every HTTP endpoint, request/response shape, and auth requirement.
  • Build & Packaging — how to build the server, produce .deb / .exe / .apk artifacts, and run the release pipeline.
  • Testing — Python E2E test layout, DDT patterns, how to add new test files, and the helpers exposed in tests/helpers.py.

Repository layout (top-level)

Path Purpose
server/ Rust (axum) backend — encrypted blob store, sync engine, REST API
web/ React + Vite web client — gallery, albums, viewer, secure gallery
android/ Kotlin Jetpack Compose mobile client
packaging/ Debian + Windows packaging definitions
Icons/ Shared app icons
install.sh, install.ps1 Self-install helpers

Branch model

  • main — lean release branch. Contains only what's needed to build and ship the server, web app, Android app, and installers.
  • dev — full development branch. Contains tests, agent customisation, benchmark results, and other development artefacts. A GitHub Action mirrors every push to dev over to main after stripping development-only paths (see .github/sync-main-exclude.txt on dev).

Open pull requests against dev.

Quick links

Clone this wiki locally