Get FileEngine
FileEngine is open source and self-hostable, with a repository per component. Take the whole stack, or only the parts you need.
Run the whole stack
A pre-configured Docker Compose stack that pulls the published images and brings the components up together. This is the quickest way to a working install; the component list below is for building or reading the parts yourself.
Compose configuration Images on Docker HubThe core, and the doors into it
One permissioned core, reachable four ways.
| Component | What it does | Built with | License | Source |
|---|---|---|---|---|
| Core gRPC | The engine: storage, versioning, access control and the gRPC surface every other component speaks to. | C++ | AGPL v3 | file_engine_core |
| REST bridge | HTTP access to the core, for your own services and integrations. | C++ | AGPL v3 | fileengine_http_proxy |
| WebDAV bridge | Mount the store as a network drive. Saving over a file still writes a new version. | C++ | AGPL v3 | fileengine_webdav |
| MCP bridge | The agent surface: permission-filtered corpus search, versioned reads and canonical source links, for any MCP client. | Python / FastAPI | AGPL v3 | fileengine_mcp |
| Front-end SPA | The web interface: browsing, preview, editing, markup, review and the research chat. | TypeScript / Vue 3 | AGPL v3 | file_engine_frontend |
Services
The capabilities that run alongside the core.
| Component | What it does | Built with | License | Source |
|---|---|---|---|---|
| Convert, search and AI | Rendition and text extraction, full-text and vector search, and the retrieval-augmented research chat. | Python / FastAPI | AGPL v3 | fileengine_convert_search_ai |
| Commenting and review | Comments anchored to files and versions, review requests, and resolution states. | Python / FastAPI | AGPL v3 | fileengine_threaded_communication |
| File difference | Page-by-page 2D comparison and identity-aware 3D and CAD model comparison. | Python / FastAPI | AGPL v3 | fileengine_difference_service |
| Folder actions | Per-folder automation that fires on file activity and chains into review-gated workflows. | Python / FastAPI | AGPL v3 | fileengine_folder_actions |
| External sharing | Bounded outside links: recipient allow-list, one-time code, expiry, use caps and revocation. | Python / FastAPI | AGPL v3 | fileengine_external_share |
| LDAP user management | Directory-backed users and roles behind the identity layer. | Python / FastAPI | AGPL v3 | fileengine_ldap_manager_api |
| Security logging service | The tamper-evident audit log: every security-relevant action recorded, across every door, with rules-based alerting. | Python / FastAPI | AGPL v3 | fileengine_security_event_logger |
| Integration provisioning API | Server-to-server construction of standardized workspaces from a JSON blueprint. | Python / FastAPI | AGPL v3 | fileengine_integration_provisioning |
Build on it
Licensed so they can be used from a closed application.
| Component | What it does | Built with | License | Source |
|---|---|---|---|---|
| Embeddable widgets | Standalone web components that drop into any product, in any framework or none. MIT, so a commercial product can embed them with no copyleft obligation. | JavaScript / Web Components | MIT | fileengine_commercial_integration_components |
| Python library | Python bindings for talking to the core. | Python | LGPL v3 | file_engine_python |
| JavaScript and TypeScript library | JavaScript and TypeScript bindings for talking to the core. | TypeScript | LGPL v3 | file_engine_javascript |
Proxima File Vault is the hosted service for FileEngine. If you would rather not run any of this yourself, join the interest list.