Norm 29320a751d
Some checks failed
ci/woodpecker/push/lint-foundkey-js Pipeline was successful
ci/woodpecker/push/lint-client Pipeline failed
ci/woodpecker/push/lint-backend Pipeline failed
ci/woodpecker/push/build Pipeline was successful
ci/woodpecker/push/lint-sw Pipeline failed
ci/woodpecker/push/test Pipeline failed
docs: update migration guide to deal with typeorm hanging on reverts
This seems to be a common occurrence with attempted migrations between different Misskey forks.

This is the best solution that I can come up with; someone who knows more bash could probably make this completely automated.
2023-07-09 06:58:22 +00:00

3.4 KiB

Migrating to FoundKey

Migrating from Misskey to FoundKey is relatively straightforward. However, additional steps are required as there are significant changes between the two projects.


The process will take some time and it's possible something will go wrong. It's highly suggested to make a database dump using pgdump and backing up .config/default.yml and the files/ directory before proceeding any further.


FoundKey has different version requirements compared to Misskey. Before continuing please check if you have the following minimum versions installed:

  • Node (version 18)
  • Postgresql (version 12)

Reverting migrations

If you're migrating from Misskey 12.112.0 or higher, you'll need to revert some database migrations as they have diverged from that point. Specifically, you'll need to revert nsfwDetection1655368940105 and newer migrations.

Run the following to revert those migrations:

cd packages/backend

LINE_NUM="$(npx typeorm migration:show -d ormconfig.js | grep -n nsfwDetection1655368940105 | cut -d ':' -f 1)"
NUM_MIGRATIONS="$(npx typeorm migration:show -d ormconfig.js | tail -n+"$LINE_NUM" | grep '\[X\]' | nl)"

for i in $(seq 1 $NUM_MIGRATIONS); do
	npx typeorm migration:revert -d ormconfig.js || continue

Note: TypeORM might hang when reverting a migration. If it says that the migration was reverted successfully, you can force close TypeORM using Ctrl-C. The script will continue until all of the migrations have been reverted.

Switching repositories

To switch to the FoundKey repository, do the following in your Misskey install location:

git remote set-url origin
git fetch origin

We recommend using a local branch and merging in upstream releases as they get tagged. This allows for easy local customization of your install.

For example, say your local branch is and you want to use release v13.0.0-preview1. To create that branch:

git checkout tags/v13.0.0-preview1 -b

When a new release comes out, simply fetch and merge in the new tag. Here we opt to squash upstream commits as it allows for easy reverts in case something goes wrong.

git fetch -t
git merge tags/v13.0.0-preview2 --squash
  # you are now on the "next" release

Making sure modern Yarn works

FoundKey uses modern Yarn instead of Classic (1.x) using Corepack. To make sure the yarn command will work going forward, run corepack enable.

If you previously had Yarn installed manually you have to remove it and install Corepack:

npm uninstall -g yarn
npm install -g corepack
corepack enable

Rebuilding and running database migrations

This will be pretty much the same as a regular update of Misskey. Note that yarn install may take a while since dependency versions have been updated or removed and we use a newer version of Yarn.

yarn install
NODE_ENV=production yarn build
yarn migrate

If you encounter issues during the build process run yarn clean-all and run the install and build command again.

Restarting your instance

To let the changes take effect restart your instance as usual:

# Systemd
systemctl restart misskey

# OpenRC
rc-service misskey restart

Need help?

If you have any questions or troubles, feel free to contact us on IRC: #foundkey on, port 6697 with SSL