From 22cc5a5953b8d34201d8b4a1b3989feae3f106ff Mon Sep 17 00:00:00 2001 From: ThatOneCalculator Date: Tue, 11 Jul 2023 15:05:43 -0700 Subject: [PATCH] docs: :memo: FoundKey migration docs Co-authored-by: Jeder Superscedes #10471 --- CALCKEY.md | 2 +- CHANGELOG.md | 2 +- README.md | 4 ++-- docs/migrate.md | 16 +++++++++------- 4 files changed, 13 insertions(+), 11 deletions(-) diff --git a/CALCKEY.md b/CALCKEY.md index 5a8bbd8ff..619155238 100644 --- a/CALCKEY.md +++ b/CALCKEY.md @@ -137,7 +137,7 @@ - 👍 also triggers generic like/favorite - [Add additional background for acrylic popups if backdrop-filter is unsupported](https://github.com/misskey-dev/misskey/pull/8671) - [Add parameters to MFM rotate](https://github.com/misskey-dev/misskey/pull/8549) -- Many changes from [Foundkey](https://akkoma.dev/FoundKeyGang/Foundkey) +- Many changes from [FoundKey](https://akkoma.dev/FoundKeyGang/FoundKey) - https://akkoma.dev/FoundKeyGang/FoundKey/commit/0ece67b04c3f0365057624c1068808276ccab981: refactor pages/auth.form.vue to composition API - https://akkoma.dev/FoundKeyGang/FoundKey/commit/4bc9610d8bf5af736b5e89e4782395705de45d7d: remove unnecessary joins - https://akkoma.dev/FoundKeyGang/FoundKey/commit/9ee609d70082f7a6dc119a5d83c0e7c5e1208676: enhance privacy of notes diff --git a/CHANGELOG.md b/CHANGELOG.md index 988156a72..b9a998f62 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2704,7 +2704,7 @@ Co-committed-by: naskya Passwords will be automatically re-hashed on sign-in. All new password hashes will be argon2 by default. This uses argon2id and is not configurable. In the very unlikely case someone has more specific needs, a fork is recommended. ChangeLog: Added Co-authored-by: Chloe Kudryavtsev -Breaks Calckey -> Misskey migration, but fixes Foundkey -> Calckey migration +Breaks Calckey -> Misskey migration, but fixes FoundKey -> Calckey migration - Add argon diff --git a/README.md b/README.md index 18b37ae02..a2465cc09 100644 --- a/README.md +++ b/README.md @@ -216,9 +216,9 @@ Please don't use ElasticSearch unless you already have an ElasticSearch setup an - Edit `.config/default.yml`, making sure to fill out required fields. - Also copy and edit `.config/docker_example.env` to `.config/docker.env` if you're using Docker. -## 🚚 Migrating from Misskey to Calckey +## 🚚 Migrating from Misskey/FoundKey to Calckey -For migrating from Misskey v13, Misskey v12, and Foundkey, read [this document](https://codeberg.org/calckey/calckey/src/branch/develop/docs/migrate.md). +For migrating from Misskey v13, Misskey v12, and FoundKey, read [this document](https://codeberg.org/calckey/calckey/src/branch/develop/docs/migrate.md). ## 🌐 Web proxy diff --git a/docs/migrate.md b/docs/migrate.md index ae7df286a..7d5c5639f 100644 --- a/docs/migrate.md +++ b/docs/migrate.md @@ -1,10 +1,11 @@ -# 🚚 Migrating from Misskey to Calckey +# 🚚 Migrating from Misskey/FoundKey to Calckey -The following procedure may not work depending on your environment and version of Misskey. +All the guides below assume you're starting in the root of the repo directory. -**Make sure you** -- **stopped all master and worker processes of Misskey.** -- **have backups of the database before performing any commands.** +### Before proceeding + +- **Ensure you have stopped all master and worker processes of Misskey.** +- **Ensure you have backups of the database before performing any commands.** ## Misskey v13 and above @@ -77,10 +78,11 @@ NODE_ENV=production pnpm run migrate # build using prefered method ``` -## Foundkey +## FoundKey ```sh cd packages/backend +sed -i '12s/^/\/\//' ./migration/1663399074403-resize-comments-drive-file.js LINE_NUM="$(npx typeorm migration:show -d ormconfig.js | grep -n uniformThemecolor1652859567549 | cut -d ':' -f 1)" NUM_MIGRATIONS="$(npx typeorm migration:show -d ormconfig.js | tail -n+"$LINE_NUM" | grep '\[X\]' | wc -l)" @@ -100,4 +102,4 @@ NODE_ENV=production pnpm run migrate ## Reverse -You ***cannot*** migrate back to Misskey from Calckey due to re-hashing passwords on signin with argon2. You can migrate from Calckey to Foundkey, though. +You ***cannot*** migrate back to Misskey from Calckey due to re-hashing passwords on signin with argon2. You can migrate from Calckey to FoundKey, though.