This application allows to create an Overleaf server to compile and save LaTeX projects directly on UCloud. A base requirement of 2 cores and 3 GB memory is recommended for basic operations with around 5 concurrent users.
Multiple users are able to access the server and work simultaneously on the same project only if the app is deployed with a public URL.
In order to start the application the user must select two input folders: one for the MongoDB document database and the other one to store projects binary (non-text) files. In case of a new server, these folders must be empty.
Restoring database from dump¶
In order to start the application with a restored database, rather than a new database, the Restore database option must be checked. If the Project files directory contains a dump of a MongoDB called ‘database_dump’, the database will be restored from these files.
When the Overleaf server is running, it will dump the database into this same directory every hour. The database can also manually be dumped with the
mongodump command from the terminal.
Set up the admin account¶
When a new server is created, it is necessary to set up an admin account by replacing
/login in the app URL with
/launchpad, as shown in the figure below.
The admin user should provide an email address and a password for the registration. The same email is used for the login.
After the registration, the admin is able to log in to the server account using the button in the top-right corner of the screen.
All users are registered in the server with an email address. However, there is no email server configured in the backend. Therefore, it is not possible to send emails to the users from the app web interface.
Create and manage users¶
New users can be added to the database from the admin menu in the top navigation bar.
In the example shown above a new user account (
firstname.lastname@example.org) is created. To activate the account the admin should first copy the app URL in a new web page and replace
/admin/register with the string
/user/activate?token=... displayed in the previous screen. At this point the admin should set a password for this user and click on activate. This will open the project page of
If the job URL is public, the server admin may send the activation link directly to another collaborator, who will thus be able to activate the account and log in to the server.
Manage the database¶
The project text files are saved in the MongoDB database along with the users registration data. Any change in the database is recorded in the folder mounted in the app container. The database name is
sharelatex and it is served on port
The figure above shows all the document collections present in the `sharelatex` database, as displayed by the Mongo Express web interface.