Upstream Sync

A Vercel / Zeabur Deployment

If you deployed your project according to the one-click deployment steps in the README, you may have noticed that you are always prompted with "updates available." This is because Vercel defaults to creating a new project for you instead of forking the original project, which prevents accurate update detection. We recommend following these steps to redeploy:

• Delete the original repository;
• Use the <kbd>Fork</kbd> button in the top right corner of the page to fork the original project;
• Redeploy on Vercel.

Enable Automatic Updates

After forking the project, due to Github's limitations, you need to manually enable Workflows on the Actions page of your forked project and start the Upstream Sync Action. Once enabled, you can set up automatic updates to occur every hour.

If you encounter a sync failure, you need to manually click "Update Branch" once.

B Docker Deployment

Upgrading the Docker deployment version is very simple, you just need to redeploy the latest LobeHub image. Here are the commands required to perform these steps:

Assuming the LobeHub container is named lobehub, use the following commands to stop and remove the currently running LobeHub container:

docker stop lobehub
docker rm lobehub

Pull the Latest LobeHub Image

Use the following command to pull the latest Docker image for LobeHub:

docker pull lobehub/lobehub

Restart the Docker Container

Redeploy the LobeHub container using the newly pulled image:

docker run -d -p 3210:3210 \
  -e OPENAI_API_KEY=sk-xxxx \
  -e OPENAI_PROXY_URL=https://api-proxy.com/v1 \
  --name lobehub \
  lobehub/lobehub

Ensure that you have sufficient permissions to stop and remove the container before executing these commands, and that Docker has sufficient permissions to pull the new image.

<Callout type={'tip'}> If I redeploy, will I lose my local chat records?

No need to worry, you won't. All of LobeHub's chat records are stored in your local browser. Therefore, when redeploying LobeHub using Docker, your chat records will not be lost. </Callout>

If you wish to automate the above steps, you can follow the method below and use Crontab scheduling to complete it. The specific steps are as follows.

First, create a lobe.env configuration file with various environment variables, for example:

OPENAI_API_KEY=sk-xxxx
OPENAI_PROXY_URL=https://api-proxy.com/v1
OPENAI_MODEL_LIST=-gpt-4,-gpt-4-32k,-gpt-3.5-turbo-16k,gpt-3.5-turbo-1106=gpt-3.5-turbo-16k,gpt-4-0125-preview=gpt-4-turbo,gpt-4-vision-preview=gpt-4-vision

Then, you can use the following script to automate the update:

#!/bin/bash
# auto-update-lobehub.sh

# Set up proxy (optional)
export https_proxy=http://127.0.0.1:7890 http_proxy=http://127.0.0.1:7890 all_proxy=socks5://127.0.0.1:7890

# Pull the latest image and store the output in a variable
output=$(docker pull lobehub/lobehub:latest 2>&1)

# Check if the pull command was executed successfully
if [ $? -ne 0 ]; then
  exit 1
fi

# Check if the output contains a specific string
echo "$output" | grep -q "Image is up to date for lobehub/lobehub:latest"

# If the image is already up to date, do nothing
if [ $? -eq 0 ]; then
  exit 0
fi

echo "Detected lobehub update"

# Remove the old container
echo "Removed: $(docker rm -f lobehub)"

# Run the new container(Please change the path to the env file)
echo "Started: $(docker run -d --network=host --env-file /path/to/lobe.env --name=lobehub --restart=always lobehub/lobehub)"

# Print the update time and version
echo "Update time: $(date)"
echo "Version: $(docker inspect lobehub/lobehub:latest | grep 'org.opencontainers.image.version' | awk -F'"' '{print $4}')"

# Clean up unused images
docker images | grep 'lobehub/lobehub' | grep -v 'latest' | awk '{print $3}' | xargs -r docker rmi > /dev/null 2>&1
echo "Removed old images."

<Callout type={'warning'}> This script can be used in Crontab, but please ensure that your Crontab can find the correct Docker command. It is recommended to use absolute paths. </Callout>

Configure Crontab to execute the script every 5 minutes:

Configure Crontab to automatically execute scripts

The following command configures Crontab to execute scripts every 5 minutes, or as often as you like:

*/5 * * * * /path/to/auto-update-lobehub.sh >> /path/to/auto-update-lobehub.log 2>&1