github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-11-07 20:31:06 -05:00
Code Issues Projects Releases Packages Wiki Activity
A web-based collaborative LaTeX editor
20936 commits 3 branches 7 tags 201 MiB
JavaScript 65.1%
TypeScript 24.3%
Less 3.5%
Java 2.4%
SCSS 1.5%
Other 3.1%
Find a file
Rebeka 71a8c69a30 revert style and template 
GitOrigin-RevId: 43e05b424ccbd08d6944cb0911b61a59df27dbc8
2023-08-30 08:04:06 +00:00
.github Merge pull request #4855 from overleaf/jpa-public-github-templates 2021-08-23 11:31:06 +00:00
develop Improve Server CE dev environment (#13820) 2023-08-04 08:04:55 +00:00
doc Merge pull request #9134 from overleaf/ae-server-ce-readme 2022-08-12 08:05:57 +00:00
libraries Merge pull request #14292 from overleaf/jpa-em-mj-warnings 2023-08-25 08:04:40 +00:00
patches Merge pull request #13056 from overleaf/jpa-pipeline-express 2023-05-25 08:03:47 +00:00
server-ce Merge pull request #14281 from overleaf/jpa-server-pro-node-18 2023-08-14 08:05:40 +00:00
services revert style and template 2023-08-30 08:04:06 +00:00
.gitignore
CONTRIBUTING.md Link to global security policy 2023-03-10 09:04:40 +00:00
docker-compose.debug.yml
docker-compose.yml Merge pull request #13141 from overleaf/msm-update-redis-ce-sp 2023-05-19 08:04:26 +00:00
LICENSE Merge remote-tracking branch 'dev-env/jpa-monorepo' into main 2021-08-05 08:03:43 +00:00
package-lock.json Merge pull request #14180 from overleaf/ii-update-simple-oauth2-package-2 2023-08-25 08:04:49 +00:00
package.json Upgrade storybook to v7 (#13165) 2023-07-17 10:27:52 +00:00
README.md

README.md


Overleaf

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

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

A screenshot of a project being edited in Overleaf Community Edition

Figure 1: A screenshot of a project being edited in Overleaf Community Edition.

Community Edition

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.

Enterprise

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 includes more features for security (SSO with LDAP or SAML), administration and collaboration (e.g. tracked changes). 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 the Overleaf Toolkit.

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.

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.