How do I set this up?

[thgilciffart]

I first ran the command git clone https://github.com/overleaf/toolkit.git ./overleaf, and then I did cd overleaf and bin/init, i configure my settings and then i did vim config/docker-compose.override.yml and pasting this --- services: sharelatex: image: sharelatex/sharelatex:ext-ce but then I got this

 ✘ Image sharelatex/sharelatex:ext-ce Error failed to resolve reference "docker...                               1.5s
 ! Image redis:7.4                    Interrupted                                                                1.5s
Error response from daemon: failed to resolve reference "docker.io/sharelatex/sharelatex:ext-ce": docker.io/sharelatex/sharelatex:ext-ce: not found```

[ThexXTURBOXx]

You are trying to set up using a self-built image, but you have not built it yourself beforehand.
If you want to use a precompiled one, you need to use overleafcep/sharelatex:6.0.1-ext-v3.3 instead of sharelatex/sharelatex:ext-ce

[thgilciffart]

Hello I figured how to set it up however the web gui is not working properly for me, here is my script to set it up

git clone https://github.com/yu-i-i/overleaf-cep $HOME/overleaf/extended
git clone https://github.com/overleaf/toolkit $HOME/overleaf/toolkit
(cd $HOME/overleaf/extended/server-ce && make)
$HOME/overleaf/toolkit/bin/init
sed -i 's/PROJECT_NAME=overleaf/PROJECT_NAME=overleaf-extended/' $HOME/overleaf/toolkit/config/overleaf.rc
sed -i 's/SIBLING_CONTAINERS_ENABLED=true/SIBLING_CONTAINERS_ENABLED=false/' $HOME/overleaf/toolkit/config/overleaf.rc
cat >$HOME/overleaf/toolkit/config/docker-compose.override.yml <<'overleaf-extended'
---
services:
  sharelatex:
    image: sharelatex/sharelatex-base:ext-ce
overleaf-extended
$HOME/overleaf/toolkit/bin/up -d

However when I remove the docker compose override 127.0.0.1:80 web gui works.
This was run on a local machine and the firewall is not the issue

[simon4477]

Try removing overleaf-extended from docker-compose.override.yml
Refer to the quick-start guide.

If you are using the pre-built image, your docker-compose.override.yml should look like:

---
services:
  sharelatex:
    image: overleafcep/sharelatex:6.0.1-ext-v3.3

You can get the image name from docker hub.

Also, configure port in overleaf.rc.

Check this guide for environment variables.

First, use bin/up for test run, this way you will see the output in case of any error. When everything is working fine, then you can stop and run bin/up -d.

[thgilciffart]

Whilst your soluton works @simon4477, replacing sharelatex/sharelatex-base:ext-ce with overleafcep/sharelatex:6.0.1-ext-v3.3, I followed the instructions from the quick start guide which told me to clone the repo as I did in line 1, then compile the docker image locally which I did in line 3 and then I used that docker image given by the docker override yaml with

---
services:
  sharelatex:
    image: sharelatex/sharelatex-base:ext-ce

inside. Why does this not work? When I run docker-ps I get this output

CONTAINER ID   IMAGE                               COMMAND                  CREATED         STATUS                   PORTS                  NAMES
d3660a67240d   sharelatex/sharelatex-base:ext-ce   "/sbin/my_init"          3 minutes ago   Up 3 minutes             127.0.0.1:80->80/tcp   sharelatex
5752ef95aae2   redis:7.4                           "docker-entrypoint.s…"   3 minutes ago   Up 3 minutes             6379/tcp               redis
ac043a112fa8   mongo:8.0                           "docker-entrypoint.s…"   3 minutes ago   Up 3 minutes (healthy)   27017/tcp              mongo

Also if I would like it to automatically update how would I do that? Wouldn't it be stuck to $6.0.1$? I tried doing :latest but that didn't work

[simon4477]

There are two ways to use it, 1) use pre-built image from docker hub, 2) build the image yourself and then use it.

The quick start guide is for compiling and building the image yourself.

If you use second method, write the version to /config/version in overleaf toolkit. For example, if your image name in docker-compose.override.yml is sharelatex/sharelatex:6.0.1, you need to write 6.0.1 to /config/version for building.

Your docker-compose.override.yml looks fine and should work. If it's not working, its better to show the logs. You can use bin/logs or bin/logs -f web clsi to get the logs.

If you are using the pre-built image from docker hub, you don't need to clone the repo and build the image. You only need overleaf-toolkit, the image is pulled from docker hub.

As for updating, there is no auto update mechanism. If you are using pre-built image, stop the server using bin/stop, get the image name from docker hub, update it in the docker-compose.override.yml, then start the server again, that's' it. If you are using your own compiled image, you need to fetch the latest repo from github, then rebuild the image, and update docker-compose.override.yml. You can automate the process by writing your own script and a cron job to periodically check for updates.

Always backup your data directory before updating. You can safely delete the backup it if everything works fine after update.

Then image that runs is the one you specify in docker-compose.override.yml, regardless of whether you build it yourself or use the pre-built image.