{"id":32695026,"url":"https://github.com/fahimfba/overleaf-toolkit-essential","last_synced_at":"2026-05-17T02:03:56.127Z","repository":{"id":320687533,"uuid":"1082991776","full_name":"FahimFBA/overleaf-toolkit-essential","owner":"FahimFBA","description":"A lightweight automation toolkit for managing and enhancing local Overleaf installations - includes smart LaTeX package installers, weekly updates, and essential setup scripts for a seamless offline Overleaf experience.","archived":false,"fork":false,"pushed_at":"2025-10-25T08:48:58.000Z","size":1940,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-25T09:22:17.341Z","etag":null,"topics":["latex","overleaf","overleaf-toolkit"],"latest_commit_sha":null,"homepage":"https://fahimfba.github.io/overleaf-toolkit-essential/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FahimFBA.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-25T05:56:09.000Z","updated_at":"2025-10-25T08:49:01.000Z","dependencies_parsed_at":"2025-10-25T09:32:21.191Z","dependency_job_id":null,"html_url":"https://github.com/FahimFBA/overleaf-toolkit-essential","commit_stats":null,"previous_names":["fahimfba/overleaf-toolkit-essential"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/FahimFBA/overleaf-toolkit-essential","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FahimFBA%2Foverleaf-toolkit-essential","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FahimFBA%2Foverleaf-toolkit-essential/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FahimFBA%2Foverleaf-toolkit-essential/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FahimFBA%2Foverleaf-toolkit-essential/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FahimFBA","download_url":"https://codeload.github.com/FahimFBA/overleaf-toolkit-essential/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FahimFBA%2Foverleaf-toolkit-essential/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33125184,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-16T18:38:32.183Z","status":"online","status_checked_at":"2026-05-17T02:00:05.366Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["latex","overleaf","overleaf-toolkit"],"created_at":"2025-11-01T18:01:35.043Z","updated_at":"2026-05-17T02:03:56.121Z","avatar_url":"https://github.com/FahimFBA.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Overleaf Toolkit Essential\n\nA lightweight automation toolkit for managing and enhancing **local Overleaf installations**.  \nIt automates LaTeX package installation, updates TeX Live automatically, and keeps your environment consistent with Overleaf’s cloud setup.\n\n---\n\n## 🎥 Setup Video Guide\n\n📺 **[Watch the full setup tutorial on YouTube](https://youtu.be/jDy9rdgSoHs)**\n\nThis walkthrough covers:\n\n- Cloning and configuring the toolkit\n- Installing and verifying LaTeX packages\n- Troubleshooting common issues\n\n---\n\n## ⚙️ Overview\n\n**Overleaf Toolkit Essential** is ideal for developers and researchers using the `sharelatex/sharelatex` Docker image.  \nIt ensures your local Overleaf setup stays up-to-date with minimal maintenance.\n\n### Key Features\n\n- Environment-driven configuration via `.env`\n- Smart package installation (only missing packages)\n- Weekly cron-based updates for TeX Live\n- Non-destructive and idempotent scripts\n- Works on Linux, macOS, and WSL2\n\n---\n\n## 🚀 Quick Start\n\n### 1. Clone the repository\n\n```bash\ngit clone https://github.com/FahimFBA/overleaf-toolkit-essential.git\ncd overleaf-toolkit-essential\n````\n\n### 2. Copy and configure environment\n\n```bash\ncp .env.example .env\n```\n\nEdit `.env` with your system paths (example):\n\n```bash\nCONTAINER_NAME=sharelatex\nPROJECT_DIR=$HOME/tmp-overleaf/overleaf-toolkit-essential\nLOG_FILE=$PROJECT_DIR/latex-update.log\nINSTALL_SCRIPT=$PROJECT_DIR/scripts/install-latex-packages.sh\n```\n\n\u003e **Note:** Use absolute paths.\n\u003e On WSL2, ensure it points to your Linux filesystem (e.g., `/home/fahim/tmp-overleaf/...`).\n\n### 3. Make scripts executable\n\n```bash\nchmod +x scripts/*.sh\n```\n\n### 4. Install LaTeX packages\n\n```bash\n./scripts/install-latex-packages.sh\n```\n\n### 5. Enable weekly auto-update\n\n```bash\n./scripts/setup-weekly-cron.sh\n```\n\nThis runs every **Monday at 4:00 AM** and logs results to `latex-update.log`.\n\n---\n\n## 🧩 Configuration\n\nAll settings are managed via `.env`:\n\n| Variable         | Description               | Example                                                                                 |\n| ---------------- | ------------------------- | --------------------------------------------------------------------------------------- |\n| `CONTAINER_NAME` | Overleaf container name   | `sharelatex`                                                                            |\n| `PROJECT_DIR`    | Toolkit directory on host | `/home/fahim/tmp-overleaf/overleaf-toolkit-essential`                                   |\n| `LOG_FILE`       | Log file path             | `/home/fahim/tmp-overleaf/overleaf-toolkit-essential/latex-update.log`                  |\n| `INSTALL_SCRIPT` | Path to installer script  | `/home/fahim/tmp-overleaf/overleaf-toolkit-essential/scripts/install-latex-packages.sh` |\n\n---\n\n## 📦 Installed Packages\n\nBy default, the toolkit installs these essential LaTeX packages:\n\n```\namsmath, amsfonts, amssymb, mathtools, siunitx,\nxcolor, graphicx, float, geometry, fancyhdr, caption, subcaption,\nlistings, algorithm, algorithmic, algorithm2e, tikz, pgfplots,\nhyperref, booktabs, multirow, array, longtable, tabularx, lipsum\n```\n\nYou can add more in `scripts/install-latex-packages.sh`.\n\n---\n\n## 🕒 Weekly Auto-Update\n\nThe scheduled cron job runs automatically:\n\n```\n0 4 * * 1 /path/to/install-latex-packages.sh \u003e\u003e /path/to/latex-update.log 2\u003e\u00261\n```\n\nTo view or edit your cron jobs:\n\n```bash\ncrontab -l\ncrontab -e\n```\n\n---\n\n## 🧰 Requirements\n\n* Docker (running `sharelatex/sharelatex`)\n* Access to `tlmgr` inside the container\n* Linux, macOS, or WSL2 host\n* Cron service enabled on host\n\n\u003e **Tip:** Tested on Ubuntu 24.04, MacOS and Windows 11 (WSL2) environments.\n\n---\n\n## 🤝 Contributing\n\nContributions are welcome!\nYou can help by:\n\n* Adding more LaTeX packages\n* Improving automation or cross-platform support\n* Enhancing installation or troubleshooting scripts\n\n### To contribute:\n\n1. Fork this repository\n2. Create a feature branch (`feature/your-update`)\n3. Commit your changes\n4. Submit a pull request with a clear description\n\n---\n\n## 🧾 License\n\nThis project is licensed under the [MIT License](LICENSE).\nYou’re free to use, modify, and distribute it under open-source terms.\n\n---\n\n## 👤 Author\n\n**Md. Fahim Bin Amin**\n[GitHub Profile](https://github.com/FahimFBA) • [LinkedIn](https://www.linkedin.com/in/fahimfba/)\n\n\u003e This is an independent open-source project, not affiliated with Overleaf Ltd.\n\n---\n\n⭐ **If you find this project helpful, please star it on GitHub!**","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffahimfba%2Foverleaf-toolkit-essential","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffahimfba%2Foverleaf-toolkit-essential","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffahimfba%2Foverleaf-toolkit-essential/lists"}