FileRise Documentation
Docs Changelog Support Try demo Get FileRise Pro
FileRise / Docs

Developer guide

Reference guides and how-tos for FileRise core and Pro.

Last updated Feb 15, 2026
On this page

Contributions are welcome. See CONTRIBUTING.md for workflow and PR guidelines.

Repo structure (core)

  • public/ - frontend assets + entrypoints (index.html, api.php, webdav.php)
  • src/FileRise/ - PSR-4 backend tree (namespaced FileRise\\...)
    • src/FileRise/Http/Controllers/ - request handlers
    • src/FileRise/Domain/ - models / business logic (users, auth, admin config, etc.)
    • src/FileRise/Support/ - shared utilities (ACL, crypto, filesystem helpers)
    • src/FileRise/Storage/ - storage + sources
    • src/FileRise/WebDAV/ - WebDAV support
  • src/controllers/, src/models/, src/lib/, src/webdav/ - legacy shims (compat layer via class_alias)
  • scripts/ - CLI helpers (e.g., scan_uploads.php)

Local dev quick start

composer install
php -S 127.0.0.1:8080 -t public

For local paths, you can point data directories to a temp location:

FR_TEST_UPLOAD_DIR=/tmp/filerise/uploads
FR_TEST_USERS_DIR=/tmp/filerise/users
FR_TEST_META_DIR=/tmp/filerise/metadata

OpenAPI spec

  • Source: src/FileRise/OpenApi/ and public/api/ annotations
  • Generate spec:
./scripts/gen-openapi.sh

This writes openapi.json.dist.

Pro note

Pro features live in FileRisePro/. Keep core usable without Pro and avoid adding core dependencies on the Pro bundle unless explicitly required.