projectsfilex

FileXIn progressOpen source

README.md

The problem

Online PDF sites and desktop suites either take your files or your money. Free online tools upload your documents to someone else's server; the good desktop tools need a licence or a subscription.

What FileX does

FileX is a private toolkit for PDF, Office files, ebooks, images and scans, in one web UI with a REST API. It runs in Docker on your own machine, keeps files in its own volume and deletes them 24 hours after a job finishes (or at once with "Delete now").

  • 30 tools across organise, optimise, convert, OCR and scans, edit, security and ebooks
  • Convert to any format: plans a multi-step route (for example DOCX → PDF → CBZ) and shows it before anything runs
  • Real digital signatures with your own certificate (PAdES, via pyHanko)
  • The same REST API the UI uses, so everything can be scripted
30
tools, plus multi-step Convert to any format
0
accounts, cloud services or paid APIs
24 h
until your files are deleted after a job
2 GB
RAM for the core tools (4 GB with everything)

How it's built

A FastAPI backend queues jobs in Redis (Valkey) for separate worker groups. core always runs; office, ocr and ebook are optional Docker Compose profiles, so a small machine only runs what it needs. The UI is React + Vite.

How a job runs

  1. 01
    Upload
    Web UI or REST API
  2. 02
    Queue
    FastAPI hands the job to Redis (Valkey)
  3. 03
    Worker
    core, office, ocr or ebook group
  4. 04
    Result
    Download, then auto-delete after 24 h

Every engine is free and open source: qpdf, pikepdf, PyMuPDF, pypdfium2, Ghostscript and img2pdf for PDF; LibreOffice and Pandoc for Office; OCRmyPDF, Tesseract, unpaper and OpenCV for scans; Calibre and djvulibre for ebooks.

Security

Out of the box it listens on 127.0.0.1 only. Containers run with a read-only filesystem except their data folders, the internal queue uses per-service ACL users with passwords kept as Docker secrets, and workers expose no ports.

Status

Pre-release (v0.1). There are no published images yet, so the first start builds them from source. Licensed AGPL-3.0.

FileX tool catalogue with search and tool families
The catalogue: search first, then one colour field per tool family.
Compress result showing the size saved with before and after previews
Compress PDF: presets or a target size, with a before/after preview.
Convert page planning a route from Word to CBZ via PDF
Convert to any format: the route is shown before anything runs.
← All projects