Start here
- Self-hosting guide — deployment planning, Docker Compose, single-binary setup, and database choices.
- Security model — authentication, permissions, path safety, atomic writes, and operator responsibilities.
- Downloads — artifact channels and current availability.
- Status and limitations — implemented areas, verification gaps, and roadmap priorities.
Installation
The release documentation will provide two complete paths: a verified Docker Compose file and a versioned single-binary service setup. Examples will use real image names, ports, volume locations, health checks, and flags from the matching release.
Until those values are published, the self-hosting guide focuses on decisions that do not require placeholders: storage layout, permissions, proxy boundaries, database choice, and backups.
Configuration reference
The reference will map every supported flag to its environment-variable equivalent and document defaults, required values, restart behavior, and whether a setting contains a secret.
Planned groups include server URLs and listeners, storage spaces, database access, authentication, SMTP, OIDC, proxy trust, network restrictions, logging, and retention.
API and CLI
API documentation will be versioned with the server and include authentication scopes, pagination, error formats, and compatibility notes. CLI examples will use a scoped token and avoid placing credentials directly in command history.
Backup and restore
Backup documentation will cover both the file library and metadata state. A complete guide needs tested procedures for SQLite, PostgreSQL, local version storage, and any supported export command.
Restore instructions will include verification steps. “The command finished” is not enough; operators should be able to confirm that accounts, shares, permissions, versions, and representative files are intact.
Contributing to docs
The source repository URL and contribution guide will appear here when they are published. Documentation changes should be reviewed against a specific FileYard version so examples do not drift ahead of the software.