From 03d6d80fdb13a6528fae8c5a084a75a8faf10c69 Mon Sep 17 00:00:00 2001 From: Shane Kilkelly Date: Tue, 19 Feb 2019 10:20:17 +0000 Subject: [PATCH 1/2] Update the readme with a short explanation of how this code works --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 47 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8e5cd84b8e..53a770d328 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,47 @@ -## Install -Please see the [offical wiki for install guides](https://github.com/sharelatex/sharelatex/wiki/Production-Installation-Instructions) \ No newline at end of file +# ShareLaTeX Docker Image + +This is the source for building the sharelatex community-edition docker image. + + +## End-User Install +Please see the [offical wiki for install +guides](https://github.com/sharelatex/sharelatex/wiki/Production-Installation-Instructions) + + +## 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 image extends the base image and adds the actual sharelatex code +and services. + +Use `make build-base` and `make build-community` to build these images. + + +### How the Sharelatex code gets here + +This repo uses [the public Sharelatex +repository](https://github.com/sharelatex/sharelatex), which used to be the main +public source for the sharelatex system. + +That repo is cloned down into the docker image, and a script then installs all +the services. This way of doing things predates the new dev-env, and isn't +currently tested. + + +### 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 sharelatex services. Baseimage uses the `runit` service +manager to manage services, and we add our init-scripts from the `./runit` +folder. + +Overall, this is very like how the services would run in production, it just +happens to be all inside one docker container instead of being on one VM. From e3590379581699e197590aae285880f42a643df2 Mon Sep 17 00:00:00 2001 From: Shane Kilkelly Date: Fri, 1 Mar 2019 11:16:12 +0000 Subject: [PATCH 2/2] remove bit from readme --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index 53a770d328..ed5cd3a91f 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,3 @@ We use the [Phusion base-image](https://github.com/phusion/baseimage-docker) in which to run the sharelatex services. Baseimage uses the `runit` service manager to manage services, and we add our init-scripts from the `./runit` folder. - -Overall, this is very like how the services would run in production, it just -happens to be all inside one docker container instead of being on one VM.