Skip to content

overleaf

Configuration for the Overleaf (ShareLaTeX) service, deployed as a pod of three containers: MongoDB, Redis and the application. A one-shot unit initializes the MongoDB replica set at first boot.

overleaf.image

The image of Overleaf to deploy (the application is still named ShareLaTeX in some images).

  • Type: String
  • Example: docker.io/rigon/sharelatex-full:6.0.0

overleaf.mongo_image

The image of MongoDB used by Overleaf.

  • Type: String
  • Example: docker.io/mongo:8.0

overleaf.redis_image

The image of Redis used by Overleaf.

  • Type: String
  • Example: docker.io/library/redis:7.4

overleaf.http_port

Port to listen for HTTP requests.

  • Type: Integer
  • Example: 3004

overleaf.app_name

Display name of the Overleaf instance.

  • Type: String
  • Example: My Overleaf

overleaf.hostname

Public host name of the service, used as https://<hostname> in the links Overleaf generates. It should match its Caddy site.

  • Type: Fully qualified domain name
  • Example: overleaf.mydomain.com

overleaf.admin_email

Administrator email login for Overleaf. After the first boot, you have to log in as the u_overleaf user (see Maintenance) and run:

./create_admin.sh

Then Ctrl+click or go to the generated URL and set a password. Additional users can then be created from the Overleaf dashboard.

  • Type: Email address
  • Purpose: Used for system notifications and administrative access.