Overleaf is a collaborative cloud-based LaTeX editor used for writing, editing and publishing scientific documents. It partners with a wide range of scientific publishers to provide official journal LaTeX templates, and direct submission links. In this step by step guide I will show you how to install Overleaf Community Edition on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest version of Overleaf v3.5.7

• STEP 1

Please Support My work by Making a Donation.

• STEP 2

Install Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

• STEP 3

Make sure you have a synology.me Wildcard Certificate. Follow my guide to get a Wildcard Certificate. If you already have a synology.me Wildcard certificate, skip this STEP.

• STEP 4

Go to Control Panel / Login Portal / Advanced Tab / click Reverse Proxy. Follow the instructions in the image below.

• STEP 5

Now click the “Create” button. Follow the instructions in the image below.

• STEP 6

After you click the Create button, the window below will open. Follow the instructions in the image below.

On the General area, set the Reverse Proxy Name description: type in Overleaf. After that, add the following instructions:

Source:
Protocol: HTTPS
Hostname: overleaf.yourname.synology.me
Port: 443

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 7643

• STEP 7

On the Reverse Proxy Rules click the Custom Header tab. Click Create and then, from the drop-down menu, click WebSocket. After you click on WebSocket, two Header Names and two Values will be automatically added. Click Save. Follow the instructions in the image below.

• STEP 8

Go to Control Panel / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.

• STEP 9

Go to Control Panel / Security / Advanced tab/ Check Enable HTTP Compression then click Apply. Follow the instructions in the image below.

• STEP 10

Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it overleaf. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

• STEP 11

Now create three new folders inside the overleaf folder that you created at STEP 10 and name them configdb, db, redis. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

• STEP 12

Follow my step by step guide on how to activate SMTP for your Gmail account. This step is mandatory. Note: If you don’t want to use the easiest way for SMTP with Google and you already have SMTP details from your own Mail Server, you can just skip this STEP and use your personalized email SMTP details instead.

• STEP 13

Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.

• STEP 14

In the Name field type in overleaf. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

version: '3.9'
services:
    overleaf:
     restart: on-failure:5
     image: sharelatex/sharelatex:3.5.7
     healthcheck:
      test: curl -f http://localhost:80/ || exit 1
     container_name: Overleaf
     depends_on:
       mongo:
         condition: service_healthy
       redis:
         condition: service_healthy
     ports:
         - 7643:80
     stop_grace_period: 60s
     volumes:
         - /volume1/docker/overleaf:/var/lib/sharelatex
     environment:
      SHARELATEX_APP_NAME: Overleaf Community Edition
      SHARELATEX_MONGO_URL: mongodb://mongo/sharelatex
      SHARELATEX_REDIS_HOST: redis
      REDIS_HOST: redis
      ENABLED_LINKED_FILE_TYPES: project_file,project_output_file
      ENABLE_CONVERSIONS: true
      EMAIL_CONFIRMATION_DISABLED: false
      SHARELATEX_ADMIN_EMAIL: Your-own-gmail-address
      TEXMFVAR: /var/lib/sharelatex/tmp/texmf-var
      SHARELATEX_SITE_URL: https://overleaf.yourname.synology.me
      SHARELATEX_NAV_TITLE: mariushosting
      SHARELATEX_EMAIL_SMTP_HOST: smtp.gmail.com
      SHARELATEX_EMAIL_SMTP_PORT: 587
      SHARELATEX_EMAIL_SMTP_USER: Your-own-gmail-address
      SHARELATEX_EMAIL_SMTP_PASS: Your-own-app-password
      SHARELATEX_EMAIL_SMTP_TLS_REJECT_UNAUTH: true
      SHARELATEX_EMAIL_SMTP_IGNORE_TLS: false
      SHARELATEX_EMAIL_FROM_ADDRESS: Your-own-gmail-address
      SHARELATEX_EMAIL_SMTP_LOGGER: true

    mongo:
     restart: on-failure:5
     image: mongo:4.4
     container_name: Overleaf-DB
     expose:
            - 27017
     volumes:
        - /volume1/docker/overleaf/db:/data/db
        - /volume1/docker/overleaf/configdb:/data/configdb
     healthcheck:
       test: echo 'db.stats().ok' | mongo localhost:27017/test --quiet
       interval: 10s
       timeout: 10s
       retries: 5
    redis:
      restart: on-failure:5
      image: redis
      mem_limit: 256m
      mem_reservation: 50m
      cpu_shares: 768
      security_opt:
       - no-new-privileges:true
      healthcheck:
       test: ["CMD-SHELL", "redis-cli ping || exit 1"]
      container_name: Overleaf-REDIS
      expose:
       - 6379
      volumes:
       - /volume1/docker/overleaf/redis:/data
      environment:
       TZ: Europe/Bucharest

Note: Before you paste the code above in the Web editor area below, change the value for SHARELATEX_ADMIN_EMAIL and type in your own Gmail address.
Note: Before you paste the code above in the Web editor area below, change the value for SHARELATEX_SITE_URL and type in your own synology.me DDNS with https:// at the beginning that you have previously created at STEP 6.
Note: Before you paste the code above in the Web editor area below, change the value for SHARELATEX_NAV_TITLE and type in your own nav title. mariushosting is an example for a nav title.
Note: Before you paste the code above in the Web editor area below, change the value for SHARELATEX_EMAIL_SMTP_USER and type in your own Gmail address. Refer to STEP 12.
Note: Before you paste the code above in the Web editor area below, change the value for SHARELATEX_EMAIL_SMTP_PASS and type in your own Gmail app password. Refer to STEP 12.
Note: Before you paste the code above in the Web editor area below, change the value for SHARELATEX_EMAIL_FROM_ADDRESS and type in your own Gmail address. Refer to STEP 12.
Note: Before you paste the code above in the Web editor area below, change the value for TZ. (Select your current Time Zone from this list.)

• STEP 15

Scroll down on the page until you see a button named Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.

⌛Now just wait because the Overleaf image is about 3GB.

• STEP 16

If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“.

• STEP 17

On the left sidebar in Portainer, click Containers. Identify your Overleaf instance, then click on the little terminal icon. Follow the instructions in the image below.

• STEP 18

After you click on the little terminal icon at STEP 17, a new page will open. Click Connect. Follow the instructions in the image below.

• STEP 19

After you click Connect at STEP 18, a Console will open. Copy Paste the code below and follow the instructions in the image.

cd /var/www/sharelatex; grunt user:create-admin --email=yourownemail

Note: Before you paste the code above in the Console area below, change yourownemail text with your email.

• STEP 20

Once the code is inserted, confirm by pressing Enter on your keyboard to start the process of admin user creation. After some seconds, you will get a link. Copy your generated link.

• STEP 21

Go back to STEP 1 or you will deal with karma 🙂.

• STEP 22

Copy the link generated at STEP 20 and then paste it in a new browser tab. Type in your own Password then click Activate. Follow the instructions in the image below.

• STEP 23

Click Create First Project then Blank Project. Follow the instructions in the image below.

• STEP 24

Give a name to the Project then click Create. Follow the instructions in the image below.

• STEP 25

Your Overleaf dashboard at a glance! Click the home icon. Follow the instructions in the image below.

• STEP 26

Confirm your email. Click Resend confirmation email. Follow the instructions in the image below.

• STEP 27

Check your email then click Confirm Email. Follow the instructions in the image below.

Enjoy Overleaf!

Note: Overleaf Full Environment Variables.
Note: Overleaf Full Documentation to use it.
Note: Can I run Docker on my Synology NAS? See the supported models.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Find out how to update the Overleaf container with the latest image.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.

This post was updated on Saturday / February 24th, 2024 at 5:52 PM