From c3d0ba2aa6dcfbd266a7d35b174f15ce8a402b6b Mon Sep 17 00:00:00 2001 From: mserranom Date: Mon, 17 Feb 2020 13:57:53 +0100 Subject: [PATCH] merged README.md --- server-ce/README.md | 26 +++++++++++++++++-- server-ce/docker-image/README.md | 43 -------------------------------- 2 files changed, 24 insertions(+), 45 deletions(-) delete mode 100644 server-ce/docker-image/README.md diff --git a/server-ce/README.md b/server-ce/README.md index 776088abe4..8b1463d23c 100644 --- a/server-ce/README.md +++ b/server-ce/README.md @@ -8,9 +8,9 @@

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

@@ -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. diff --git a/server-ce/docker-image/README.md b/server-ce/docker-image/README.md deleted file mode 100644 index c1894afce0..0000000000 --- a/server-ce/docker-image/README.md +++ /dev/null @@ -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.