# sibosend/overleaf-toolkit architecture

> Architecture diagram of the GitHub repository sibosend/overleaf-toolkit, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sibosend/overleaf-toolkit
- Repository: https://github.com/sibosend/overleaf-toolkit

## Overview

This repository is an operations toolkit for configuring and running a local Overleaf deployment, not the Overleaf application itself. Its documented workflow is to initialize configuration, adjust the deployment settings, start the Docker services, then access Overleaf in a browser; persistent service data can be backed up and restored through the mapped data directory. The graph covers documented service roles and administration entry points. Source excerpts were not provided, so relationships beyond those stated or shown in the README are omitted.

Main entry points: [`lib/docker-compose.base.yml`](https://github.com/sibosend/overleaf-toolkit/blob/main/lib/docker-compose.base.yml) (Overleaf service), [`lib/config-seed/overleaf.rc`](https://github.com/sibosend/overleaf-toolkit/blob/main/lib/config-seed/overleaf.rc) (Deployment settings), [`bin/init`](https://github.com/sibosend/overleaf-toolkit/blob/main/bin/init) (Initialize config), [`bin/up`](https://github.com/sibosend/overleaf-toolkit/blob/main/bin/up) (Start deployment)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_setup["Setup and configuration"]
  node_init["Initialize config"]
  node_settings["Deployment settings<br/>[overleaf.rc]"]
  node_env["Container environment<br/>[variables.env]"]
end

subgraph group_runtime["Deployment runtime"]
  node_compose["Overleaf service"]
  node_gitbridge["Git bridge"]
  node_mongo[("MongoDB service")]
  node_redis[("Redis service")]
  node_nginx["NGINX service"]
  node_data[("Persistent data")]
end

subgraph group_operations["Administration"]
  node_up["Start deployment"]
  node_backup["Backup config"]
  node_doctor["Diagnose deployment"]
  node_upgrade["Upgrade deployment"]
end

node_operator(("Operator"))
node_browser(("Browser user"))

node_operator -->|"initializes"| node_init
node_init -->|"generates"| node_settings
node_operator -->|"configures"| node_settings
node_settings -->|"sets runtime values"| node_env
node_operator -->|"starts"| node_up
node_up -->|"starts services"| node_compose
node_compose -->|"configures bridge"| node_gitbridge
node_compose -->|"configures database"| node_mongo
node_compose -->|"configures cache"| node_redis
node_browser -->|"accesses Overleaf"| node_compose
node_compose -->|"maps persistent files"| node_data
node_operator -.->|"backs up config"| node_backup
node_operator -->|"checks deployment"| node_doctor
node_operator -.->|"upgrades deployment"| node_upgrade

click node_init "https://github.com/sibosend/overleaf-toolkit/blob/main/bin/init"
click node_settings "https://github.com/sibosend/overleaf-toolkit/blob/main/lib/config-seed/overleaf.rc"
click node_env "https://github.com/sibosend/overleaf-toolkit/blob/main/lib/config-seed/variables.env"
click node_compose "https://github.com/sibosend/overleaf-toolkit/blob/main/lib/docker-compose.base.yml"
click node_gitbridge "https://github.com/sibosend/overleaf-toolkit/blob/main/lib/docker-compose.git-bridge.yml"
click node_mongo "https://github.com/sibosend/overleaf-toolkit/blob/main/lib/docker-compose.mongo.yml"
click node_redis "https://github.com/sibosend/overleaf-toolkit/blob/main/lib/docker-compose.redis.yml"
click node_nginx "https://github.com/sibosend/overleaf-toolkit/blob/main/lib/docker-compose.nginx.yml"
click node_data "https://github.com/sibosend/overleaf-toolkit/tree/main/data"
click node_up "https://github.com/sibosend/overleaf-toolkit/blob/main/bin/up"
click node_backup "https://github.com/sibosend/overleaf-toolkit/blob/main/bin/backup-config"
click node_doctor "https://github.com/sibosend/overleaf-toolkit/blob/main/bin/doctor"
click node_upgrade "https://github.com/sibosend/overleaf-toolkit/blob/main/bin/upgrade"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_init,node_settings,node_env,node_browser toneBlue
class node_compose,node_gitbridge,node_mongo,node_redis,node_nginx,node_data toneAmber
class node_up,node_backup,node_doctor,node_upgrade toneMint
class node_operator toneIndigo
```

## Components

### Setup and configuration

- [Initialize config](https://github.com/sibosend/overleaf-toolkit/blob/main/bin/init): `bin/init`
- [Deployment settings](https://github.com/sibosend/overleaf-toolkit/blob/main/lib/config-seed/overleaf.rc): `lib/config-seed/overleaf.rc`
- [Container environment](https://github.com/sibosend/overleaf-toolkit/blob/main/lib/config-seed/variables.env): `lib/config-seed/variables.env`

### Deployment runtime

- [Overleaf service](https://github.com/sibosend/overleaf-toolkit/blob/main/lib/docker-compose.base.yml): `lib/docker-compose.base.yml`
- [Git bridge](https://github.com/sibosend/overleaf-toolkit/blob/main/lib/docker-compose.git-bridge.yml): `lib/docker-compose.git-bridge.yml`
- [MongoDB service](https://github.com/sibosend/overleaf-toolkit/blob/main/lib/docker-compose.mongo.yml): `lib/docker-compose.mongo.yml`
- [Redis service](https://github.com/sibosend/overleaf-toolkit/blob/main/lib/docker-compose.redis.yml): `lib/docker-compose.redis.yml`
- [NGINX service](https://github.com/sibosend/overleaf-toolkit/blob/main/lib/docker-compose.nginx.yml): `lib/docker-compose.nginx.yml`
- [Persistent data](https://github.com/sibosend/overleaf-toolkit/tree/main/data): `data`

### Administration

- [Start deployment](https://github.com/sibosend/overleaf-toolkit/blob/main/bin/up): `bin/up`
- [Backup config](https://github.com/sibosend/overleaf-toolkit/blob/main/bin/backup-config): `bin/backup-config`
- [Diagnose deployment](https://github.com/sibosend/overleaf-toolkit/blob/main/bin/doctor): `bin/doctor`
- [Upgrade deployment](https://github.com/sibosend/overleaf-toolkit/blob/main/bin/upgrade): `bin/upgrade`

### Other components

- **Operator**
- **Browser user**

## Connections

- Operator → Initialize config: initializes (evidence: `README.md`)
- Initialize config → Deployment settings: generates (evidence: `README.md`)
- Operator → Deployment settings: configures (evidence: `README.md`)
- Deployment settings → Container environment: sets runtime values (evidence: `README.md`)
- Operator → Start deployment: starts (evidence: `README.md`)
- Start deployment → Overleaf service: starts services (evidence: `README.md`)
- Overleaf service → Git bridge: configures bridge (evidence: `README.md`)
- Overleaf service → MongoDB service: configures database (evidence: `README.md`)
- Overleaf service → Redis service: configures cache (evidence: `README.md`)
- Browser user → Overleaf service: accesses Overleaf (evidence: `README.md`)
- Overleaf service → Persistent data: maps persistent files (evidence: `README.md`)
- Operator → Backup config: backs up config
- Operator → Diagnose deployment: checks deployment (evidence: `README.md`)
- Operator → Upgrade deployment: upgrades deployment
