diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-04-13 16:18:09 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2025-04-13 16:18:09 +0000 |
| commit | ae76f9464f2f64018548f4ddfe7b94b92616c6dd (patch) | |
| tree | add456d6e4039e4843125bffad22fd106c281f8c /docs/versioned_docs/version-v0.23.2/02-Installation/03-archlinux.md | |
| parent | 969e774ac029c9fd2f82678af7981862966b79f2 (diff) | |
| download | karakeep-ae76f9464f2f64018548f4ddfe7b94b92616c6dd.tar.zst | |
docs: Release the new API docs
Diffstat (limited to 'docs/versioned_docs/version-v0.23.2/02-Installation/03-archlinux.md')
| -rw-r--r-- | docs/versioned_docs/version-v0.23.2/02-Installation/03-archlinux.md | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.23.2/02-Installation/03-archlinux.md b/docs/versioned_docs/version-v0.23.2/02-Installation/03-archlinux.md new file mode 100644 index 00000000..23914463 --- /dev/null +++ b/docs/versioned_docs/version-v0.23.2/02-Installation/03-archlinux.md @@ -0,0 +1,95 @@ +# Arch Linux + +## Installation + +> [Karakeep on AUR](https://aur.archlinux.org/packages/karakeep) is not maintained by the karakeep official. + +1. Install karakeep + + ```shell + paru -S karakeep + ``` + +2. (**Optional**) Install optional dependencies + + ```shell + # hoarder-cli: karakeep cli tool + paru -S hoarder-cli + + # ollama: for automatic tagging + sudo pacman -S ollama + + # 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/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 karakeep.target + ``` + + Then visit `http://localhost:3000` and you should be greated with the sign in page. + +## Services and Ports + +`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 +``` + +**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 +``` |
