- 🚀 One-command deployment for Overleaf Community Edition through the official Overleaf Toolkit.
- 🧩 Recommended default flow: choose local/server deployment, then OVERSEI automatically selects the latest compatible MongoDB version and runs the recommended full install by default.
- ✅ MongoDB 8.0+ compatibility to avoid the ShareLaTeX abort caused by MongoDB 6.x/7.x.
- 🧩 ARM64/aarch64 server compatibility by configuring ShareLaTeX to run as
linux/amd64with QEMU/binfmt support on ARM hosts. - 🇨🇳 Chinese UI and typesetting support with
OVERLEAF_SITE_LANGUAGE=zh-CN,ctex,xeCJK, Chinese fonts, Windows core fonts, and XeLaTeX-ready configuration. - 🪞 TeX Live repository compatibility with automatic fallback to the TUNA historic
tlnet-finalmirror when the container TeX Live year is older than the current CTAN repository. - 🔤 Font installers for Windows core fonts, Adobe fonts, and Noto CJK fonts, including
fontconfig/fc-cachehandling. - 📦 LaTeX package installer for full scheme, common thesis-template packages, or custom
tlmgrpackage names, includingcollection-latexextra,multirow/bigstrut,cprotect, and common CUMCM-style dependencies. - 🧱 Optional custom image persistence after installing Chinese support, fonts, or packages, preventing container recreation from losing
ctex.styor other installed files after you confirm your templates compile correctly. - 🛠️ Automatic repair mode for existing
overleaf-toolkitcheckouts, partialconfigdirectories, MongoDB version settings, ARM64 overrides, and service startup issues. - 🔌 Port conflict handling: if
8888is used by an old Overleaf container, it is removed; if another service owns it, OVERSEI automatically selects an available port from8889-8999. - 🧰 Local management command: after installation, use
overseiorOVERSEIto show URLs, status, config, logs, or continue package/font installation.
Run as root on a Linux server:
bash <(curl -sL --connect-timeout 10 https://raw.githubusercontent.com/AMTOPA/Overleaf-Sharelatex-Easy-Install/main/install.sh) || bash <(curl -sL --connect-timeout 10 https://github.math-enthusiast.top/OVERSEI/install.sh)- Linux or WSL environment with
apt-get. - Root privileges.
- Docker and Docker Compose. The installer can install missing Compose support when possible.
- ARM64/aarch64 servers are supported through
linux/amd64compatibility mode for the ShareLaTeX CE image, which is usually slower than native x86_64. - Network access to GitHub, Docker Hub, Ubuntu package mirrors, and CTAN/TUNA mirrors.
- Port
8888is used by default. - If
8888is already occupied, the installer automatically selects an available port from8889-8999. You can also setOVERSEI_PORT=8890before running the script to prefer a specific port.
| Installation Option | Available Options | Description |
|---|---|---|
| Recommended Full Installation (default) | Base Services + Chinese Support + Recommended Fonts + Common LaTeX Packages | Default option; applies recommended choices without asking for MongoDB, font, or package mode again |
| Base Services Only | Overleaf + MongoDB + Redis | Minimal deployment using Overleaf Toolkit |
| Chinese Support | Chinese web UI, collection-langchinese, xeCJK, ctex, SimSun/SimKai, Windows core fonts |
Enable Chinese UI, CUMCM-style templates, and document compilation |
| Additional Fonts | Windows Core Fonts / Adobe Fonts / Noto CJK / Manual Times New Roman | Expand available fonts in the ShareLaTeX container |
| LaTeX Packages | scheme-full / common thesis-template packages / custom package list |
Install packages through tlmgr; the common mode includes collection-latexextra |
| Automatic Repair | Existing toolkit/config/container setup | Use this after interrupted installs, partial installs, or repeated runs that hit toolkit initialization errors |
The installer writes /usr/local/bin/oversei and an uppercase alias OVERSEI. After that, you do not need to fetch the installer again:
oversei --help
oversei urls
oversei status
oversei packages
OVERSEI repairCommon commands:
| Command | Description |
|---|---|
oversei urls |
Show clean recommended access URLs |
oversei urls --all |
Also show Docker internal URLs |
oversei status |
Show container and port status |
oversei config |
Show key Toolkit config values |
oversei repair |
Detect and repair an existing installation |
oversei packages |
Open the LaTeX package installer |
oversei logs sharelatex |
Show recent ShareLaTeX logs |
Recent Overleaf Community Edition images require MongoDB 8.0 or newer. Older installer versions could leave MONGO_VERSION=6.0 in config/overleaf.rc, which caused ShareLaTeX to abort during startup.
OVERSEI now:
- Defaults to MongoDB
8.0+. - Automatically fetches the latest compatible MongoDB tag after the deployment type is selected, falling back to a safe default if Docker Hub is unavailable.
- If
OVERSEI_MONGO_VERSIONis set, rejects values below8.0and falls back to automatic selection. - Writes
MONGO_VERSIONreliably toconfig/overleaf.rc. - Checks the actual running MongoDB version after startup.
- Stops the installation and prints logs if MongoDB or ShareLaTeX fails.
sharelatex/sharelatex:6.1.2 currently does not provide an ARM64 image manifest. On Oracle ARM, Ampere, Raspberry Pi, and other aarch64 hosts, Docker can fail with:
no matching manifest for linux/arm64/v8 in the manifest list entries
On ARM64 hosts, OVERSEI now:
- Installs
qemu-user-staticandbinfmt-support. - Mounts and enables
binfmt_miscforqemu-x86_64; if the distro service does not register it, OVERSEI automatically runs a privileged Docker binfmt registrar. - Stops before starting ShareLaTeX if amd64 emulation is still unavailable, preventing repeated
exec /sbin/my_init: exec format errorrestarts. - Writes
sharelatex.platform=linux/amd64toconfig/docker-compose.override.yml. - Keeps MongoDB and Redis on native ARM64 images; only ShareLaTeX uses amd64 compatibility mode.
If an older installer already failed, rerun the install command and choose automatic repair. The installer will regenerate or repair the compatibility configuration.
The ShareLaTeX image may contain a frozen TeX Live release, while the current CTAN tlnet repository may have already moved to the next year. In that case, tlmgr reports an error like:
Local TeX Live (2025) is older than remote repository (2026).
Cross release updates are only supported with update-tlmgr-latest --update.
OVERSEI detects the local TeX Live year and automatically switches to the compatible TUNA historic archive:
https://mirrors.tuna.tsinghua.edu.cn/tex-historic-archive/systems/texlive/<year>/tlnet-final
This keeps package installation compatible with the TeX Live version bundled in the Overleaf container.
After Chinese support, fonts, or LaTeX packages are installed, OVERSEI asks whether to commit the current sharelatex container to a local custom image and configure Overleaf Toolkit to use it. It is recommended to compile and verify your own templates first, then persist the image after everything works.
The current installer has been tested with:
sharelatex/sharelatex:6.1.2mongo:8.2redis:7.4- Web service exposed on
0.0.0.0:8888 ctex.styandxeCJK.styalgorithmicx.sty,algorithm.sty,multirow.sty, andbigstrut.stycprotect.styandsuffix.styTimes New Roman,Arial,SimSun, andsimkai.ttf- Noto CJK fonts
- A minimal XeLaTeX document using Chinese text and algorithm packages
Check the MongoDB version in the generated toolkit config:
grep '^MONGO_VERSION=' /root/overleaf/overleaf-toolkit/config/overleaf.rcIt must be 8.0 or newer.
Rerun the install command with v5.6 or newer. The installer generates:
services:
sharelatex:
platform: linux/amd64and installs the amd64 container compatibility dependencies.
Run the Chinese support or package installer again. OVERSEI will detect the TeX Live year and configure a compatible historic repository automatically.
This is Overleaf Toolkit refusing to run bin/init when a config directory already exists. Since v5.5, OVERSEI detects an existing config/overleaf.rc and skips bin/init; if config is incomplete, it is backed up to config.bak.<timestamp> before reinitialization. Rerun the installer and choose automatic repair.
The host port 8888 is already occupied. Since v5.6, OVERSEI checks the port before startup: old Overleaf/ShareLaTeX containers are removed automatically, while unrelated services cause the installer to switch to the next available port and print the actual access URL at the end.
Chinese support only installs Chinese typesetting packages such as ctex and xeCJK. For thesis templates such as CUMCM, use the common thesis-template package mode, which installs collection-latexextra and common template dependencies. Use scheme-full only when you need the most complete TeX Live installation and can accept the larger disk and IO cost.
CUMCM-style templates often require Windows font names such as Times New Roman, Arial, SimSun, and the exact file name simkai.ttf. Run the Chinese support installer again. OVERSEI installs Microsoft core fonts, downloads SimSun/SimKai, refreshes fc-cache, and adds simkai.ttf to the TeX Live local font tree with mktexlsr.
Install a font option again. The installer ensures fontconfig exists and refreshes the font cache with fc-cache.
docker ps --format 'table {{.Names}}\t{{.Image}}\t{{.Status}}\t{{.Ports}}'- Installer repository: this project.
- Overleaf Toolkit installation:
/root/overleaf/overleaf-toolkit. - Toolkit config file:
/root/overleaf/overleaf-toolkit/config/overleaf.rc. - Default external access URL:
- Local deployment:
http://localhost:8888 - Server deployment:
http://<server-ip>:8888
- Local deployment:
- If
8888is occupied, use the actual port printed by the installer. - First-time admin setup URL:
http://<ip>:<actual-port>/launchpad. - Login URL after initialization:
http://<ip>:<actual-port>/login. - After base service installation, the installer prints public URLs, host LAN URLs,
localhost, and127.0.0.1by default. To include Docker internal URLs, runoversei urls --all.
This project is licensed under the MIT License.