From f3c525b7f7dd360f654d8621bbf64e31ad5ff48e Mon Sep 17 00:00:00 2001 From: Mohamed Bassem Date: Sun, 13 Apr 2025 16:25:03 +0000 Subject: docs: Revert 0.23.2 docs and just update 0.23.1 instead --- .../02-Installation/03-archlinux.md | 77 +++++++++++++++++----- 1 file changed, 62 insertions(+), 15 deletions(-) (limited to 'docs/versioned_docs/version-v0.23.1/02-Installation/03-archlinux.md') diff --git a/docs/versioned_docs/version-v0.23.1/02-Installation/03-archlinux.md b/docs/versioned_docs/version-v0.23.1/02-Installation/03-archlinux.md index 37ada2fa..23914463 100644 --- a/docs/versioned_docs/version-v0.23.1/02-Installation/03-archlinux.md +++ b/docs/versioned_docs/version-v0.23.1/02-Installation/03-archlinux.md @@ -2,47 +2,94 @@ ## Installation -> [Hoarder on AUR](https://aur.archlinux.org/packages/hoarder) is not maintained by the hoarder official. +> [Karakeep on AUR](https://aur.archlinux.org/packages/karakeep) is not maintained by the karakeep official. -1. Install hoarder +1. Install karakeep ```shell - paru -S hoarder + paru -S karakeep ``` 2. (**Optional**) Install optional dependencies ```shell - # meilisearch: for full text search - paru -S meilisearch + # hoarder-cli: karakeep cli tool + paru -S hoarder-cli # ollama: for automatic tagging - paru -S ollama + sudo pacman -S ollama - # hoarder-cli: hoarder cli tool - paru -S hoarder-cli + # yt-dlp: for download video + sudo pacman -S yt-dlp ``` You can use Open-AI instead of `ollama`. If you use `ollama`, you need to download the ollama model. Please refer to: [https://ollama.com/library](https://ollama.com/library). 3. Set up - Environment variables can be set in `/etc/hoarder/hoarder.env` according to [configuration page](/configuration). **The environment variables that are not specified in `/etc/hoarder/hoarder.env` need to be added by yourself.** + Environment variables can be set in `/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.** 4. Enable service ```shell - sudo systemctl enable --now hoarder.target + sudo systemctl enable --now karakeep.target ``` - Then visit `http://localhost:3000` and you should be greated with the Sign In page. + Then visit `http://localhost:3000` and you should be greated with the sign in page. ## Services and Ports -`hoarder.target` include 3 services: `hoarder-web.service`, `hoarder-works.service`, `hoarder-browser.service`. +`karakeep.target` include 3 services: `karakeep-web.service`, `karakeep-works.service`, `karakeep-browser.service`. + +- `karakeep-web.service`: Provide karakeep webui service, uses `3000` port by default. + +- `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 +``` -- `hoarder-web.service`: Provide hoarder WebUI service, use `3000` port default. +**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.** -- `hoarder-works.service`: Provide hoarder works service, no port. +Or you can copy old hoarder env file to karakeep: +```shell +sudo cp -f /etc/hoarder/hoarder.env /etc/karakeep/karakeep.env +``` -- `hoarder-browser.service`: Provide browser headless service, use `9222` port default. +**7. Start Karakeep** +```shell +sudo systemctl enable --now karakeep.target +``` -- cgit v1.2.3-70-g09d2