diff options
| author | devome <93664269+devome@users.noreply.github.com> | 2025-04-13 02:53:41 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-04-12 19:53:41 +0100 |
| commit | 56e679565741a501fcc73f2ea4f417c111c65c1e (patch) | |
| tree | c704b3be08f39c63b2c498547f00fe199df1d467 | |
| parent | 33641489f9f35d7b346642481294cc0eb25f2ee1 (diff) | |
| download | karakeep-56e679565741a501fcc73f2ea4f417c111c65c1e.tar.zst | |
docs: add Arch Linux karakeep migration instructions (#1218)
* docs: update Arch Linux installation
* docs: add Arch Linux migration instructions
| -rw-r--r-- | docs/docs/02-Installation/03-archlinux.md | 49 |
1 files changed, 48 insertions, 1 deletions
diff --git a/docs/docs/02-Installation/03-archlinux.md b/docs/docs/02-Installation/03-archlinux.md index 0bc4d39d..23914463 100644 --- a/docs/docs/02-Installation/03-archlinux.md +++ b/docs/docs/02-Installation/03-archlinux.md @@ -43,6 +43,53 @@ - `karakeep-web.service`: Provide karakeep webui service, uses `3000` port by default. -- `karakeep-works.service`: Provide karakeep works service, no port. +- `karakeep-workers.service`: Provide karakeep workers service, no port. - `karakeep-browser.service`: Provide browser headless service, uses `9222` port by default. + +Now `karakeep` depends on `meilisearch`, and `karakeep-workers.service` wants `meilisearch.service`, starting `karakeep.target` will start `meilisearch.service` at the same time. + +## How to Migrate from Hoarder to Karakeep + +The PKGBUILD has been fully updated to replace all references to `hoarder` with `karakeep`. If you want to preserve your existing `hoarder` data during the upgrade, please follow the steps below: + +**1. Stop the old services** + +```shell +sudo systemctl stop hoarder-web.service hoarder-worker.service hoarder-browser.service +sudo systemctl disable --now hoarder.target +``` + +**2. Uninstall Hoarder** +After uninstalling, you can manually remove the old `hoarder` user and group if needed. +```shell +paru -R hoarder +``` + +**3. Rename the old data directory** +```shell +sudo mv /var/lib/hoarder /var/lib/karakeep +``` + +**4. Install Karakeep** +```shell +paru -S karakeep +``` + +**5. Fix ownership of the data directory** +```shell +sudo chown -R karakeep:karakeep /var/lib/karakeep +``` + +**6. Set Karakeep** +Edit `/etc/karakeep/karakeep.env` according to [configuration page](/configuration). **The environment variables that are not specified in `/etc/karakeep/karakeep.env` need to be added by yourself.** + +Or you can copy old hoarder env file to karakeep: +```shell +sudo cp -f /etc/hoarder/hoarder.env /etc/karakeep/karakeep.env +``` + +**7. Start Karakeep** +```shell +sudo systemctl enable --now karakeep.target +``` |