mirrors/overleaf-toolkit
1
0
Fork 0
mirror of https://github.com/overleaf/toolkit.git synced 2025-04-11 19:58:18 +02:00
Code Activity

Add config option for skipping docker pull before upgrading

Browse source
This commit is contained in:
Jakob Ackermann 2025-01-06 12:43:52 +00:00
parent 7f10105a9b
commit 2fff47d1fe
No known key found for this signature in database
GPG key ID: 30C56800FCA3828A
4 changed files with 28 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
CHANGELOG.md
View file

@ -1,5 +1,10 @@
# Changelog
## 2025-01-06
### Added
- Add new config option for skipping docker pull before upgrading
- Document config options for air-gapped setups
## 2024-11-18
### Added
- When a custom `GIT_BRIDGE_IMAGE` is set, `bin/upgrade` no longer tries to pull the new version, and prompts

32
bin/upgrade
View file

@ -156,22 +156,24 @@ function handle_image_upgrade() {
prompt "Are you following the recovery process?"
fi
echo "Pulling new images"
set_server_pro_image_name "$SEED_IMAGE_VERSION"
docker pull "$IMAGE"
if [[ $GIT_BRIDGE_ENABLED == "true" ]]; then
if [[ -n ${GIT_BRIDGE_IMAGE:-} ]]; then
echo "------------------- WARNING ----------------------"
echo " You're using the custom git bridge image $GIT_BRIDGE_IMAGE"
echo " Before continuing you need to tag the updated image separately, making sure that:"
echo " 1. The Docker image is tagged with the new version: $SEED_IMAGE_VERSION"
echo " 2. The config/overleaf.rc entry GIT_BRIDGE_IMAGE only contains the image name, and not a tag/version."
echo " You wont be able to continue with this upgrade until you've tagged your custom image with $SEED_IMAGE_VERSION"
echo "------------------- WARNING ----------------------"
prompt "Has the custom image been tagged?"
if [[ "${PULL_BEFORE_UPGRADE:-true}" == "true" ]]; then
echo "Pulling new images"
set_server_pro_image_name "$SEED_IMAGE_VERSION"
docker pull "$IMAGE"
if [[ $GIT_BRIDGE_ENABLED == "true" ]]; then
if [[ -n ${GIT_BRIDGE_IMAGE:-} ]]; then
echo "------------------- WARNING ----------------------"
echo " You're using the custom git bridge image $GIT_BRIDGE_IMAGE"
echo " Before continuing you need to tag the updated image separately, making sure that:"
echo " 1. The Docker image is tagged with the new version: $SEED_IMAGE_VERSION"
echo " 2. The config/overleaf.rc entry GIT_BRIDGE_IMAGE only contains the image name, and not a tag/version."
echo " You wont be able to continue with this upgrade until you've tagged your custom image with $SEED_IMAGE_VERSION"
echo "------------------- WARNING ----------------------"
prompt "Has the custom image been tagged?"
fi
set_git_bridge_image_name "$SEED_IMAGE_VERSION"
docker pull "$GIT_BRIDGE_IMAGE"
fi
set_git_bridge_image_name "$SEED_IMAGE_VERSION"
docker pull "$GIT_BRIDGE_IMAGE"
fi
## Offer to stop docker services

2
doc/upgrading.md
View file

@ -16,3 +16,5 @@ If you do choose to switch versions, the script will then walk you through a pro
The whole process looks like this:
![Demonstration of the upgrade script](./img/upgrade-demo.gif)
> Note: For air-gapped setups that manually import docker images, please set `PULL_BEFORE_UPGRADE=false` in your `config/overleaf.rc` file.

4
lib/config-seed/overleaf.rc
View file

@ -41,3 +41,7 @@ NGINX_TLS_LISTEN_IP=127.0.1.1
TLS_PRIVATE_KEY_PATH=config/nginx/certs/overleaf_key.pem
TLS_CERTIFICATE_PATH=config/nginx/certs/overleaf_certificate.pem
TLS_PORT=443
# In Air-gapped setups, skip pulling images
# PULL_BEFORE_UPGRADE=false
# SIBLING_CONTAINERS_PULL=false