github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-11-21 20:47:08 -05:00
Code Issues Projects Releases Packages Wiki Activity

merged README.md

Browse source
This commit is contained in:
mserranom 2020-02-17 13:57:53 +01:00
parent 93dce40328
commit aad5df5168
2 changed files with 24 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -8,9 +8,9 @@
<p align="center">
<a href="#key-features">Key Features</a> •
<a href="https://github.com/overleaf/overleaf/wiki">Wiki</a> •
<a href="https://www.overleaf.com/for/enterprises">Server Pro</a> •
<a href="https://www.sharelatex.com/i/university/onsite">Server Pro</a> •
<a href="#contributing">Contributing</a> •
<a href="https://mailchi.mp/overleaf.com/community-edition-and-server-pro">Mailing List</a> •
<a href="https://www.overleaf.com/for/enterprises">Mailing List</a> •
<a href="#authors">Authors</a> •
<a href="#license">License</a>
</p>
@ -54,6 +54,28 @@ This repository does not contain any code. It acts a wrapper and toolkit for man
| **[tags](https://github.com/overleaf/tags)** | The backend API for managing project tags (folders). |
| **[spelling](https://github.com/overleaf/spelling)** | An API for running server-side spelling checking on Overleaf documents. |
## 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` to build these images.
We use the [Phusion base-image](https://github.com/phusion/baseimage-docker)
(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 `./runit`
folder.
## Contributing
Please see the [CONTRIBUTING](https://github.com/overleaf/overleaf/blob/master/CONTRIBUTING.md) file for information on contributing to the development of Overleaf. See [our wiki](https://github.com/overleaf/overleaf/wiki/Developer-Guidelines) for information on setting up a development environment and how to recompile and run Overleaf after modifications.

43
docker-image/README.md
View file

@ -1,43 +0,0 @@
# Overleaf Docker Image
This is the source for building the Overleaf community-edition docker image.
## End-User Install
Please see the [offical wiki for install
guides](https://github.com/overleaf/overleaf/wiki)
## Development
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` to build these images.
### How the Overleaf code gets here
This repo uses [the public Overleaf
repository](https://github.com/overleaf/overleaf), which used to be the main
public source for the Overleaf system.
That repo is cloned down into the docker image, and a script then installs all
the services.
### How services run inside the container
We use the [Phusion base-image](https://github.com/phusion/baseimage-docker)
(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 `./runit`
folder.