github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-12-26 20:34:02 +00:00
Code Issues Projects Releases Packages Wiki Activity
A web-based collaborative LaTeX editor
18302 commits 3 branches 7 tags 206 MiB
JavaScript 65.4%
TypeScript 24%
Less 3.5%
Java 2.4%
SCSS 1.5%
Other 3.1%
Find a file
Thomas 1777c075ea Merge pull request #6423 from overleaf/tm-plans-new-events 
Add new analytics events to plans page/subscription flow

GitOrigin-RevId: 7b70ee30749ebc671cf2445f3cbdae91a7278b01
2022-02-02 09:03:07 +00:00
.github Merge pull request #4855 from overleaf/jpa-public-github-templates 2021-08-23 11:31:06 +00:00
doc Merge remote-tracking branch 'dev-env/jpa-monorepo' into main 2021-08-05 08:03:43 +00:00
libraries Merge pull request #6517 from overleaf/jpa-node-fetch-2-6-7 2022-02-01 09:03:24 +00:00
server-ce Merge pull request #6541 from overleaf/ms-em-server-ce-image-selector 2022-02-01 09:03:41 +00:00
services Merge pull request #6423 from overleaf/tm-plans-new-events 2022-02-02 09:03:07 +00:00
.gitignore Merge pull request #4734 from overleaf/jpa-server-ce-build 2021-08-17 08:03:11 +00:00
CONTRIBUTING.md Merge remote-tracking branch 'dev-env/jpa-monorepo' into main 2021-08-05 08:03:43 +00:00
docker-compose.debug.yml Merge pull request #6221 from overleaf/ae-web-port 2022-01-12 09:03:47 +00:00
docker-compose.yml Merge pull request #4893 from overleaf/em-synctex 2021-09-07 16:26:17 +00:00
LICENSE Merge remote-tracking branch 'dev-env/jpa-monorepo' into main 2021-08-05 08:03:43 +00:00
README.md It's 2021 (#4906) 2021-08-30 08:03:13 +00:00

README.md


Overleaf

An open-source online real-time collaborative LaTeX editor.

Key Features • Wiki • Server Pro • Contributing • Mailing List • Authors • License

Overleaf

Figure 1: A screenshot of Overleaf Server Pro's comments and tracked changes features.

Key Features

Overleaf is an open-source online real-time collaborative LaTeX editor. We run a hosted version at www.overleaf.com, but you can also run your own local version, and contribute to the development of Overleaf.

If you want help installing and maintaining Overleaf in your lab or workplace, we offer an officially supported version called Overleaf Server Pro. It also comes with extra security and admin features. Click here to find out more!

Keeping up to date

Sign up to the mailing list to get updates on Overleaf Releases and development

Installation

We have detailed installation instructions in our wiki:

Upgrading

If you are upgrading from a previous version of Overleaf, please see the Release Notes section on the Wiki for all of the versions between your current version and the version you are upgrading to.

Overleaf Docker Image

This repo contains two dockerfiles, Dockerfile-base, which builds the sharelatex/sharelatex-base image, and Dockerfile which builds the sharelatex/sharelatex (or "community") image.

The Base image generally contains the basic dependencies like wget and aspell, plus texlive. We split this out because it's a pretty heavy set of dependencies, and it's nice to not have to rebuild all of that every time.

The sharelatex/sharelatex image extends the base image and adds the actual Overleaf code and services.

Use make build-base and make build-community from server-ce/ to build these images.

We use the Phusion base-image (which is extended by our base image) to provide us with a VM-like container in which to run the Overleaf services. Baseimage uses the runit service manager to manage services, and we add our init-scripts from the server-ce/runit folder.

Contributing

Please see the CONTRIBUTING file for information on contributing to the development of Overleaf. See our wiki for information on setting up a development environment and how to recompile and run Overleaf after modifications.

Authors

The Overleaf Team

License

The code in this repository is released under the GNU AFFERO GENERAL PUBLIC LICENSE, version 3. A copy can be found in the LICENSE file.

Copyright (c) Overleaf, 2014-2021.