Overleaf docs
Plans and pricingTemplatesUser docsGo to Overleaf
On-premises
On-premises
  • Welcome
    • Server Pro vs. Community Edition
  • Release notes
    • Release notes 5.x.x
      • Doc version recovery
    • Release notes 4.x.x
    • Release notes 3.x.x
      • Full project history migration
    • Release notes 2.x.x
    • Release notes 1.x.x
    • Release notes 0.x.x
  • Getting started
    • Before you start
    • Requirements
      • Skills needed
      • Hardware requirements
      • Software requirements
    • Microservices
    • Server Pro infrastructure
    • What is the Overleaf Toolkit?
  • Installation
    • Introduction
    • Using the Toolkit
      • 1: Download the Toolkit
      • 2: Familiarize yourself with the Toolkit
      • 3: Initialize the configuration
      • 4. Choose Community Edition or Server Pro
      • 5. Personalizing your instance
      • 6. Post-installation tasks
    • Air-gapped/offline deployments
    • Upgrading TeX Live
  • Configuration
    • Overleaf Toolkit
      • Files and locations
      • Toolkit settings
      • Environment variables
      • Server Pro-only configuration
        • LDAP
        • SAML 2.0
        • Sandboxed Compiles
        • Git integration
        • Templates
        • Adding LaTeX user help
      • Logging
      • TLS proxy
      • Branding
      • Localization
      • Email delivery
      • Redis
      • S3
  • Maintenance
    • docker-compose.yml to Toolkit migration
    • Upgrading your deployment
    • Data and backups
      • Exporting projects
    • Extending TeX Live
    • Horizontal scaling
    • S3 migration
    • Updating MongoDB
  • User and project management
    • User management
      • Username migration
    • Understanding license usage
    • Project management
  • Support
    • Project limits
    • Troubleshooting
    • Getting help
    • Support guides
      • Using templates as an individual
    • Overleaf user docs
Powered by GitBook
LogoLogo

Discover Overleaf

  • Home
  • Features

Solutions

  • Plans and pricing
  • For universities
  • For business
  • For government

Resources

  • Templates
  • User docs and LaTeX learning
  • Blog

© Overleaf

On this page
  • Services
  • Compiling
  • Networking
  • Summary

Was this helpful?

Export as PDF
  1. Getting started

Server Pro infrastructure

PreviousMicroservicesNextWhat is the Overleaf Toolkit?

Last updated 3 months ago

Was this helpful?

Services

The Server Pro infrastructure comprises four primary services: sharelatex, git-bridge (optional), mongo and redis. The sharelatex service, which runs the main Server Pro application, depends on the mongo and redis services for its database and caching/real-time functionalities and the git-bridge to handle the (optional). The only port published on the host machine is port 80, which is by the sharelatex container.

Server Pro also optionally supports for project files and full project history as well as being able to proxy access to the main . For more information, see our guide on pages.

If required, MongoDB and Redis can be externalised using environment variables to point to external services. For more information, see if you are using Docker Compose and if using the Overleaf Toolkit.

Compiling

For , the sharelatex container will orchestrate the creation of new containers to handle project compiles, it does this via the Docker socket on the host machine. You can read more about the editor and end-to-end compile/caching process .

Networking

Communication between containers is facilitated through Docker's internal DNS resolution via a dedicated bridge network, and no firewalls are enabled. By default, the above services use their respective standard ports but are configurable by environment variables. The sharelatex container uses port 80 for external web access (served by Nginx), the mongo container uses port 27017 and redis uses port 6379.

For customers using our managed solution , you can optionally for terminating HTTPS connections using Nginx via an environment variable. Alternatively, you can use your existing TLS proxy.

You can view a diagram explaining the flow of requests .

Summary

  • Outside the Docker network, only port 80 is accessible and bound to Nginx. Note: The sharelatex container runs many that communicate with each other via HTTP. However, these ports are not accessible from outside the Docker network.

  • Inside the Docker network, Overleaf services, MongoDB, Redis and Git Bridge can talk to each other freely.

  • Inside containers, no network is available.

Git integration
S3 compatible storage
Overleaf documentation site
Adding LaTeX user help
Configuring Overleaf
Toolkit settings
Sandboxed Compiles
Overleaf Toolkit
enable a TLS proxy
here
services
Sandboxed Compiles
here