hippofish/docs/notice-for-admins.md

Unreleased

For Docker/Podman users

• You only need to pull the new container image (docker/podman pull) to upgrade your server, so we assume that many of you don't update the code (git pull --ff), but it's still worth noting here that we have renamed docker-compose.yml to docker-compose.example.yml in the repository, and docker-compose.yml is now set to be untracked by git.
  • Since docker-compose.yml may be edited by users (e.g., change port number, add reverse proxy), it shouldn't have been tracked by git in the first place.
  • If you want to update the repository (git pull --ff), please take the following steps to keep your docker-compose.yml:
    1. Backup (make a copy) your docker-compose.yml

       cp docker-compose.yml /tmp/my-docker-compose.yml
       

    2. Restore the original docker-compose.yml so it doesn't conflict with the upstream changes

       git checkout -- docker-compose.yml
       

    3. Pull the new code

       git switch main
       git pull --ff
       

    4. Bring back your docker-compose.yml

       mv /tmp/my/docker-compose.yml docker-compose.yml
       

  • If any modifications are needed to docker-compose.yml in the future, we will provide a notice.

v20240214

For systemd/pm2 users

• Required Rust version has been bumped from v1.70 to v1.74.

  cargo --version  # check version
  rustup update    # update version
  

v20240213

For systemd/pm2 users

• packages/backend/native-utils can be removed.

  • This directory was removed in the repository, but it's not completely removed from your system by git pull --ff, because some folders like packages/backend/native-utils/built are not tracked by git.

  rm --recursive --force packages/backend/native-utils
  

v20240206

For all users

• The git repository has been moved, so please update the git remote url.

  git remote set-url origin https://firefish.dev/firefish/firefish.git
  

For systemd/pm2 users

• Required Rust version has been bumped from v1.68 to v1.70.
• libvips is no longer required (unless your server os is *BSD), so you may uninstall it from your system. Make sure to execute the following commands after that:

  pnpm clean-npm
  pnpm install
  

For Docker/Podman users

• The image tag has been changed to registry.firefish.dev/firefish/firefish:latest, so please update docker-compose.yml.