Skip to content

Commit d0a8e6e

Browse files
Updating Quick-Start Guide
As per Pull Request overleaf#311 (overleaf#311), I have included in the manual the steps to install the full TexLive packages.
1 parent d7e63ce commit d0a8e6e

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

doc/quick-start-guide.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,35 @@ $ bin/up
9797
You should see some log output from the docker containers, indicating that the containers are running.
9898
If you press `CTRL-C` at the terminal, the services will shut down. You can start them up again (without attaching to the log output) by running `bin/start`. More generally, you can run `bin/docker-compose` to control the `docker compose` system directly, if you find that the convenience scripts don't cover your use-case.
9999

100+
## Installing all TexLive packages
101+
102+
Since the current install is minimal and some packages may be required in the future for compiling some documents, let's install all available packages (Full TexLive). From the `overleaf-toolkit` directory mentioned in previous steps, run the following command to access the Sharelatex Docker container:
103+
```bash
104+
bin/shell
105+
```
106+
We are now inside the container's shell. We can check the current version of the packages using the following command:
107+
```bash
108+
tlmgr --version
109+
```
110+
Next, run the following command to install all the libraries:
111+
```bash
112+
tlmgr install scheme-full
113+
```
114+
This will install several packages, so it might take some time. Once finished, we can exit the container shell using `Ctrl D` or the `exit` command.
115+
116+
The last step is to save all changes in the container.
117+
First, we need to know the version number, which can be done with the command:
118+
```bash
119+
cat config/version
120+
```
121+
Then, we update the version in the container using:
122+
```bash
123+
docker commit sharelatex sharelatex/sharelatex:VERSION-with-texlive-full
124+
```
125+
Next, update the `config/version` file with the text editor (Nano, Vi, ...) to include the text `with-texlive-full` alongside the version number so it looks like ```X.X.X-with-texlive-full```.
126+
127+
Finally, execute the sequence `sudo bin/up`, then stop the service with `Ctrl C`, and then `sudo bin/start`, as in previous steps, to recreate the Docker container, this time with all the packages installed.
128+
100129

101130
## Create the first admin account
102131

0 commit comments

Comments
 (0)