Skip to content

hafedh049/Offline-Overleaf

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 

Repository files navigation


🧠 Overleaf Toolkit Quick-Start Guide

This guide assumes you’re running Ubuntu / Debian / Kali / Mint in a Linux environment (can be WSL).

0️⃣ Install Ubuntu WSL (if not already installed)

# Open PowerShell
wsl --install -d Ubuntu 
  
# Launch Ubuntu  
wsl -d Ubuntu
  • After installation, your WSL Ubuntu shell is ready to run docker & Overleaf Toolkit.

1️⃣ Prepare the System

# Optional: become root
sudo -i

# Add passwordless sudo for your user
echo "$SUDO_USER ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/$SUDO_USER
chmod 440 /etc/sudoers.d/$SUDO_USER
exit

2️⃣ Install Docker, Docker Compose v5, and utilities

sudo apt update
sudo apt install -y docker.io curl wget tree nodejs python3-pip
sudo systemctl start docker
sudo systemctl enable docker
sudo usermod -aG docker $USER
newgrp docker

# Remove old docker-compose v1 if exists
sudo apt remove docker-compose -y

# Configure systemd for docker 
sudo nano /etc/wsl.conf
# Then add these lines inside the file
[boot]
systemd=true

# Then exit the wsl
exit

# Shutdown it
wsl --shutdown

# Reopen it again
wsl -d Ubuntu

# Install Docker Compose v5
sudo curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-linux-x86_64" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
docker-compose --version   # should show v5.x

3️⃣ Clone the Overleaf Toolkit

mkdir -p ~/overleaf && cd ~/overleaf
git clone https://github.com/overleaf/toolkit.git ./overleaf-toolkit
cd overleaf-toolkit
ls
# bin  CHANGELOG.md  config  data  doc  lib  LICENSE  README.md

4️⃣ Initialise Configuration

bin/init
  • Check config/:
ls config
# overleaf.rc  variables.env  version
  • Edit config/overleaf.rc:
nano config/overleaf.rc
# Disable sibling containers for CE:
SIBLING_CONTAINERS_ENABLED=false

This is mandatory for Community Edition, otherwise CE will fail to start.


5️⃣ Run the Doctor

bin/doctor
  • Should output something like:
====== Overleaf Doctor ======
- Host Information
    - Linux
- Dependencies
    - bash
    - docker
    - docker compose
- Configuration
- Warnings: ...
====== End ======

6️⃣ Start Overleaf (Detached Mode)

bin/up -d
  • Pulls required docker images (Mongo, Redis, CE) and starts all containers

  • Logs can be followed if needed:

bin/logs
# or for multiple services:
bin/logs -f web filestore docstore clsi

7️⃣ Access Launchpad & Create Admin Account

  • Go to http://localhost/launchpad

  • Fill in email & password to create first admin account

  • Ignore any test step, just log in and start using Overleaf


8️⃣ Create or Import Projects

  • Go to project page inside Overleaf

  • Either import a project or create a blank project for testing/editing


Optional: Install Full TeX Live inside container (~5GB+)

Inside the sharelatex container:

# Get the container ID
docker ps

# Enter the container
docker exec -it <container_id> bash

Update tlmgr to the latest release

cd /tmp
curl -LO https://mirror.ctan.org/systems/texlive/tlnet/update-tlmgr-latest.sh
chmod +x update-tlmgr-latest.sh

# Run the updater
./update-tlmgr-latest.sh -- --confirm

# Check version
tlmgr --version
# Example: tlmgr revision 78301 (2026-03-07)

Install full TeX Live

tlmgr install scheme-full
  • Installs all LaTeX packages, XeLaTeX, LuaLaTeX, fonts, etc.

  • Recommended for Arabic or custom fonts.

  • This may take a while (~5–6GB).

  • In the project File ~ Settings ~ Compiler ~ Choose XeLatex

About

Overleaf Toolkit Quick-Start Guide (Ubuntu WSL)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors