This monorepo contains both the Filizer Client and Server applications.
client/: The CLI application for syncing files.server/: The FastAPI server for managing file data.
This project uses uv for dependency management. Dependencies are managed at the root level.
To install dependencies:
uv syncTo run all tests:
uv run pytestIndividual application READMEs can be found in their respective directories:
The server application can be deployed using Helm:
helm install filizer-server ./charts/filizer-serverSee the Helm chart directory for more configuration options.
Filizer follows Semantic Versioning (SemVer) for both the client and server.
- Client-to-Server Compatibility: The client verifies the server version before starting a scan.
- Server-to-Client Compatibility: The server checks the
X-Client-Versionheader in every request and will reject clients that are below the minimum required version. - Minimum Versions:
MIN_CLIENT_VERSIONandMIN_SERVER_VERSIONare defined incommon/models.py.
Upgrading to a new major version may require updating both the client and server.