diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/02-Installation/03-archlinux.md | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/docs/docs/02-Installation/03-archlinux.md b/docs/docs/02-Installation/03-archlinux.md index 37ada2fa..0bc4d39d 100644 --- a/docs/docs/02-Installation/03-archlinux.md +++ b/docs/docs/02-Installation/03-archlinux.md @@ -2,47 +2,47 @@ ## 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`. -- `hoarder-web.service`: Provide hoarder WebUI service, use `3000` port default. +- `karakeep-web.service`: Provide karakeep webui service, uses `3000` port by default. -- `hoarder-works.service`: Provide hoarder works service, no port. +- `karakeep-works.service`: Provide karakeep works service, no port. -- `hoarder-browser.service`: Provide browser headless service, use `9222` port default. +- `karakeep-browser.service`: Provide browser headless service, uses `9222` port by default. |