fleetex 0.2.3

Fleetex: a pip-installable launcher to self-host your own LaTeX editor, powered by Overleaf Community Edition (Docker). Independent project, not affiliated with Overleaf.

Fleetex

Your own private, self-hosted LaTeX editor — a pip-installable launcher built on Overleaf Community Edition.

Fleetex runs Overleaf on a server you control. Install and upgrade it with pip install fleetex, and keep your customizations in a GitHub repo you can pull from. Your users only need a web browser.

Disclaimer: Fleetex is an independent, community-maintained launcher. It is not affiliated with, endorsed by, or sponsored by Overleaf. It does not redistribute Overleaf's source code — it pulls the official, publicly available sharelatex/sharelatex Docker image at runtime. "Overleaf" and "ShareLaTeX" are trademarks of their respective owners and are used here only nominatively to describe what Fleetex runs. Fleetex is distributed under AGPL-3.0 for compatibility with Overleaf Community Edition.

This package is a thin, zero-dependency Python wrapper around Docker Compose. It does not reimplement Overleaf — Overleaf CE is a set of Node.js services shipped as the sharelatex/sharelatex Docker image. This launcher pulls that upstream stack, renders a compose file, and gives you a friendly CLI to operate it.

---

🐍 The Fleetex Python stack (a from-scratch reimplementation)

This repo also contains a ground-up Python reimplementation of Overleaf's backend services under services/ — see ROADMAP.md and PROGRESS.md. Nine services (auth/projects/editor web, real-time websockets, document-updater OT engine, docstore, filestore, clsi, chat, notifications) plus a minimal browser frontend with live collaborative editing. The OT engine is TP1-fuzz-verified and its browser twin is byte-checked against it.

Run the entire Python stack with one command:

docker compose up --build

Then open http://localhost:3000 → register → create/open a project. Open a second browser tab (or share with someone) editing the same document — changes sync live. (Ports published to the host: 3000 web, 3026 real-time websocket.)

…or drive it with the fleetex launcher (python edition)

The fleetex CLI can run this reimplementation instead of the stock Overleaf CE image. Point it at a checkout and switch editions:

fleetex config --edition python --source /path/to/fleetex
fleetex up            # builds + starts the Python stack (project: fleetex-app)
fleetex status        # shows the 10 services
fleetex down          # stops it

For LAN/remote access, tell it the host address browsers should use (the live-sync websocket connects there directly):

fleetex config --advertise-host 192.168.50.21   # your server's LAN IP
fleetex up                                        # → http://192.168.50.21:3000

No create-admin step — the Python stack uses open self-registration. With no --source, the launcher clones the repo automatically. The ce edition (stock Overleaf CE on :8080) remains the default; switch back with fleetex config --edition ce.

Backups

Your data (projects, users, docs, uploads) lives in Docker named volumes that survive rebuilds and upgrades. Snapshot and restore it with:

fleetex backup                       # writes ~/.fleetex/backups/fleetex-backup-<timestamp>/
fleetex backup --output /mnt/backups # or choose where
fleetex restore ~/.fleetex/backups/fleetex-backup-20260101-120000   # OVERWRITES current data

restore stops the stack, replaces the data, and prompts before doing anything destructive. Run a fleetex backup before any risky upgrade.

Auto-start on reboot

Every service uses restart: unless-stopped, so once Docker starts at boot the whole stack comes back up on its own. Enable Docker at boot once:

sudo systemctl enable docker
fleetex up            # start it once; it now returns after every reboot

(fleetex down stops it and keeps it stopped across reboots until the next fleetex up.)

Editor features

The browser editor (served by the web service) supports:

• Live collaborative-ready editing over HTTP with autosave; LaTeX syntax highlighting, a line gutter, and Tab→spaces.
• Compile to PDF with an inline preview, plus an Overleaf-style Logs panel that parses compile errors/warnings (click an error to jump to the line) and a raw-log view.
• File tree with folders — create folders, drag-and-drop docs/files between them, upload into a selected folder, and nested display.
• Version history — every save is a version; browse them, see a live diff against your current text, and restore.
• Sharing by email, live cursors/presence, and image includes.
• Download the whole project as a zip (all files + the compiled output.pdf) from the dashboard or the editor toolbar.
• Resizable panes (drag the dividers) and a togglable preview.

These ship in the repo's services/ tree, which the python edition builds from source — so git pull on your checkout (then fleetex up) delivers editor updates without needing a launcher upgrade.

---

Why this exists

You want an Overleaf alternative for work that:

• runs on your own server, fully under your control,
• installs and updates with a single command (pip install -U fleetex),
• and lets you keep improvements in a GitHub fork you can git pull.

That's exactly what this is.

Requirements

• Linux server with Docker Engine + the Docker Compose v2 plugin (docker compose version must work).
• Python 3.9+ (for the fleetex CLI; the services run Python inside containers).
• git — only for the python edition when no --source is given (used to clone the stack).
• ~6 GB free disk (clsi ships TeX Live) and a couple of GB of RAM.

Run fleetex doctor to check all of the above and report anything missing before you fleetex up.

Install

pip install fleetex        # from PyPI (once published)

or from your GitHub fork (the "GitHub pull" workflow, see below):

pip install "git+https://github.com/<you>/fleetex.git"

Quick start

fleetex up                     # pull images + start the stack (detached)
fleetex create-admin [e-mail]
fleetex open                   # open http://localhost:8080

Then log in as the admin you created. That's it — you have a working, self-hosted Overleaf.

Commands

Command	What it does
fleetex up	Pull images and start Overleaf (add --foreground to stream logs, --no-pull to skip pulling)
fleetex down	Stop the stack (data is preserved). --volumes also wipes data
fleetex status	Show container status
fleetex logs -f [service]	Tail logs (optionally for one service)
fleetex restart	Restart all services
fleetex open	Open the web UI in a browser
fleetex create-admin <email>	Create the first admin user
fleetex exec <service> <cmd...>	Run a command in a container (e.g. exec sharelatex bash)
fleetex doctor	Check prerequisites (Docker, Compose v2, git, disk)
fleetex backup / restore	Back up / restore data (projects, docs, uploads)
fleetex config [--port N ...]	View or change settings and re-render the compose file
fleetex version	Show launcher + Docker versions

Configuration

State lives in a single directory: ~/.fleetex by default (override with FLEETEX_HOME or --home). It contains config.json, a rendered docker-compose.yml, and a data/ directory holding the bind-mounted volumes for the app, MongoDB, and Redis.

fleetex config                          # show current settings
fleetex config --port 9000              # change the HTTP port
fleetex config --image sharelatex/sharelatex:5.0   # pin an image version
fleetex config --data-dir /srv/overleaf/data       # move data to a big disk

The update workflow (PyPI + GitHub)

Upgrade the Overleaf app itself (new upstream sharelatex/sharelatex release):

fleetex up          # `up` pulls the latest image by default
# or pin a specific version:
fleetex config --image sharelatex/sharelatex:<tag> && fleetex restart

Upgrade this launcher (new features/fixes in the CLI):

pip install -U fleetex               # from PyPI
# or from your fork:
pip install -U "git+https://github.com/<you>/fleetex.git"

Make your own improvements — fork this repo on GitHub, edit, and either install from your fork (pip install git+...) or open a PR upstream. Cut a release by bumping version in pyproject.toml and publishing:

python -m build
twine upload dist/*

Development

pip install -e ".[dev]"
pytest                    # tests mock out Docker; no containers needed

Security note (read before exposing to a network)

Overleaf Community Edition is designed for fully-trusted environments. Sandboxed Compiles (user isolation during LaTeX compilation) are a Server Pro feature and are not available in CE — any user who can compile has broad access to the sharelatex container. For a small trusted team on an internal server this is fine; do not expose CE directly to untrusted users. Put it behind your VPN / SSO reverse proxy and TLS. See the upstream README.

Relationship to upstream & license

This launcher packages and orchestrates the unmodified upstream Overleaf CE images. Overleaf is a trademark of Overleaf; this is an independent packaging project and is not affiliated with or endorsed by Overleaf. Overleaf CE is licensed under AGPL-3.0, and this launcher is distributed under the same license to stay compatible.