4. Choose Community Edition or Server Pro

If you're a Server Pro customer please continue with the next steps to log into our image repository and change the Toolkit configuration to use the Server Pro image. If not, you can skip this section and move on to the personalizing your instance step.

Obtaining Server Pro Image

Server Pro is distributed as a Docker image on the quay.io registry: quay.io/sharelatex/sharelatex-pro

You will have been supplied with a set of credentials when you signed up for a Server Pro license.

First use your provided credentials to log in to the quay.io repository:

docker login quay.io
Username: <sharelatex+your_provided_username>
Password: <your_provided_password>

Then run bin/docker-compose pull to pull the Server Pro image from the quay.io registry.

These credentials do not provide access to the quay.io website.

Switching to Server Pro

If you're deploying an on-premises version of Overleaf for the first time we highly recommend first setting up the Overleaf Toolkit with the Community Edition before switching to Server Pro as this will help you get familiarized with the process.

As Server Pro can be used as a drop-in replacement for the Community Edition you'll be able to use all your existing settings and customizations. When you're ready, Toolkit deployments can enable Server Pro by editing the config/overleaf.rc file and changing the SERVER_PRO environment variable to true.

SERVER_PRO=true

The next time you run bin/up, the Toolkit will automatically download and use the Server Pro image.

If you're upgrading from the Community Edition to Server Pro you can do that now. If not, please move onto the next step in the deployment guide to personalize your instance.