ltlapy/iceshrimp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[docs] Update firefish migration guide

Browse source
This commit is contained in:
Laura Hausmann 2024-09-06 02:22:31 +02:00
parent 648bac3140
commit e723dc2a03
No known key found for this signature in database
GPG key ID: D044E84C5BE01605
1 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/migrate.md
View file

@ -6,12 +6,17 @@ Before proceeding, please **ensure you have an up-to-date backup of the database
First, follow Firefish's [downgrade guide](https://firefish.dev/firefish/firefish/-/blob/downgrade/docs/downgrade.md) to get back to v1.0.5-rc. First, follow Firefish's [downgrade guide](https://firefish.dev/firefish/firefish/-/blob/downgrade/docs/downgrade.md) to get back to v1.0.5-rc.
### Docker ### Docker
To begin, run `docker exec -it firefish_web /bin/bash` to get a shell in the main container. First, stop the container by running `docker compose down`.
Now, add a patch that will make sure migrations revert correctly: `curl -s https://iceshrimp.dev/iceshrimp/iceshrimp/raw/branch/dev/docs/firefish-redis.patch | git apply --ignore-whitespace`. Now, run `docker-compose run --rm --entrypoint '/bin/bash' web` to get a shell in the main container.
### Bare metal ### Bare metal
While in the root directory of your cloned firefish repository, run `curl -s https://iceshrimp.dev/iceshrimp/iceshrimp/raw/branch/dev/docs/firefish-redis.patch | git apply --ignore-whitespace`. This patch makes sure migrations revert correctly. First, stop the service. If using systemd, run `sudo systemctl stop firefish.service`.
Now, `cd` into the root of your firefish repository.
## Applying the migrations patch
To make sure migrations revert correctly, run `curl -s https://iceshrimp.dev/iceshrimp/iceshrimp/raw/branch/dev/docs/firefish-redis.patch | git apply --ignore-whitespace`. This will patch two built JS files related to redis. The patch is ephemeral, once you complete the migration process it will no longer apply. Iceshrimp-JS has the patch built in.
## Reverting the migrations ## Reverting the migrations
To begin, run `cd packages/backend` to switch to the backend workspace. To begin, run `cd packages/backend` to switch to the backend workspace.