diff options
Diffstat (limited to 'docs/versioned_docs/version-v0.23.1/02-Installation')
| -rw-r--r-- | docs/versioned_docs/version-v0.23.1/02-Installation/01-docker.md | 16 | ||||
| -rw-r--r-- | docs/versioned_docs/version-v0.23.1/02-Installation/03-archlinux.md | 77 |
2 files changed, 70 insertions, 23 deletions
diff --git a/docs/versioned_docs/version-v0.23.1/02-Installation/01-docker.md b/docs/versioned_docs/version-v0.23.1/02-Installation/01-docker.md index ab5e7123..c62fbaa5 100644 --- a/docs/versioned_docs/version-v0.23.1/02-Installation/01-docker.md +++ b/docs/versioned_docs/version-v0.23.1/02-Installation/01-docker.md @@ -11,18 +11,18 @@ Create a new directory to host the compose file and env variables. This is where you’ll place the `docker-compose.yml` file from the next step and the environment variables. -For example you could make a new directory called "hoarder-app" with the following command: +For example you could make a new directory called "karakeep-app" with the following command: ``` -mkdir hoarder-app +mkdir karakeep-app ``` ### 2. Download the compose file -Download the docker compose file provided [here](https://github.com/hoarder-app/hoarder/blob/main/docker/docker-compose.yml) directly into your new directory. +Download the docker compose file provided [here](https://github.com/karakeep-app/karakeep/blob/main/docker/docker-compose.yml) directly into your new directory. ``` -wget https://raw.githubusercontent.com/hoarder-app/hoarder/main/docker/docker-compose.yml +wget https://raw.githubusercontent.com/karakeep-app/karakeep/main/docker/docker-compose.yml ``` ### 3. Populate the environment variables @@ -30,7 +30,7 @@ wget https://raw.githubusercontent.com/hoarder-app/hoarder/main/docker/docker-co To configure the app, create a `.env` file in the directory and add this minimal env file: ``` -HOARDER_VERSION=release +KARAKEEP_VERSION=release NEXTAUTH_SECRET=super_random_string MEILI_MASTER_KEY=another_random_string NEXTAUTH_URL=http://localhost:3000 @@ -38,7 +38,7 @@ NEXTAUTH_URL=http://localhost:3000 You **should** change the random strings. You can use `openssl rand -base64 36` in a seperate terminal window to generate the random strings. You should also change the `NEXTAUTH_URL` variable to point to your server address. -Using `HOARDER_VERSION=release` will pull the latest stable version. You might want to pin the version instead to control the upgrades (e.g. `HOARDER_VERSION=0.10.0`). Check the latest versions [here](https://github.com/hoarder-app/hoarder/pkgs/container/hoarder-web). +Using `KARAKEEP_VERSION=release` will pull the latest stable version. You might want to pin the version instead to control the upgrades (e.g. `KARAKEEP_VERSION=0.10.0`). Check the latest versions [here](https://github.com/karakeep-app/karakeep/pkgs/container/karakeep). Persistent storage and the wiring between the different services is already taken care of in the docker compose file. @@ -93,7 +93,7 @@ Go to the [quick sharing page](/quick-sharing) to install the mobile apps and th ## Updating -Updating hoarder will depend on what you used for the `HOARDER_VERSION` env variable. +Updating karakeep will depend on what you used for the `KARAKEEP_VERSION` env variable. - If you pinned the app to a specific version, bump the version and re-run `docker compose up -d`. This should pull the new version for you. -- If you used `HOARDER_VERSION=release`, you'll need to force docker to pull the latest version by running `docker compose up --pull always -d`. +- If you used `KARAKEEP_VERSION=release`, you'll need to force docker to pull the latest version by running `docker compose up --pull always -d`. 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 +``` |
