Skip to content

lcpu-club/overleaf

 
 

Repository files navigation

About This Fork 关于本分支

This fork is developed and maintained by LCPU. We try to implement all entreprise features into this fork. We have currently implemented the following features:

  • Sandboxed compiles and selecting build image (#4, #5)
  • Review and comment (#12)

You can see all local changes at Commit History.

For instructions on how to deploy Overleaf, see Quick Start Guide.

Future development roadmap is in GitHub Projects. Feel free to share your thoughts in GitHub Issues and pull requests are welcomed and appreciated. To get started, go to ./development.

本分支由北京大学学生 Linux 俱乐部开发并维护。我们致力于将Overleaf中的企业级功能移植入开源分支,目前,我们已经实现了以下功能:

  • 编译沙箱及自定义编译镜像 (#4, #5)
  • 审阅与评论 (#12)

可在快速开始查阅安装指南。

开发计划位于 GitHub Projects,欢迎在 GitHub Issues 中提出你的想法。我们欢迎并由衷感谢你的PR。有关开发帮助,请参阅 ./development


Overleaf

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

WikiServer ProContributingMailing ListAuthorsLicense

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-2024.

Packages

 
 
 

Languages

  • JavaScript 65.7%
  • TypeScript 24.0%
  • Less 3.6%
  • Java 2.5%
  • Pug 1.2%
  • SCSS 1.1%
  • Other 1.9%