Skip to content

Commit

Permalink
Updating Quick-Start Guide
Browse files Browse the repository at this point in the history
As per Pull Request overleaf#311 (overleaf#311), I have included in the manual the steps to install the full TexLive packages.
  • Loading branch information
programadordegp2 authored Feb 8, 2025
1 parent d7e63ce commit d0a8e6e
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions doc/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,35 @@ $ bin/up
You should see some log output from the docker containers, indicating that the containers are running.
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.

## Installing all TexLive packages

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:
```bash
bin/shell
```
We are now inside the container's shell. We can check the current version of the packages using the following command:
```bash
tlmgr --version
```
Next, run the following command to install all the libraries:
```bash
tlmgr install scheme-full
```
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.

The last step is to save all changes in the container.
First, we need to know the version number, which can be done with the command:
```bash
cat config/version
```
Then, we update the version in the container using:
```bash
docker commit sharelatex sharelatex/sharelatex:VERSION-with-texlive-full
```
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```.

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.


## Create the first admin account

Expand Down

0 comments on commit d0a8e6e

Please sign in to comment.