diff options
| author | Mohamed Bassem <me@mbassem.com> | 2026-01-18 15:34:22 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2026-01-18 15:34:22 +0000 |
| commit | 4858d3faaf9cf91bac93c20c9723d2cc868c99b4 (patch) | |
| tree | 5f06b7a7dd318d995a3ddf7d0c60f005228b3b68 /docs/versioned_docs/version-v0.30.0/02-installation | |
| parent | 2fec9ab65bd4f906edfb2a867c38b1308c615a2d (diff) | |
| download | karakeep-4858d3faaf9cf91bac93c20c9723d2cc868c99b4.tar.zst | |
docs: fix relative urls
Diffstat (limited to 'docs/versioned_docs/version-v0.30.0/02-installation')
6 files changed, 13 insertions, 13 deletions
diff --git a/docs/versioned_docs/version-v0.30.0/02-installation/01-docker.md b/docs/versioned_docs/version-v0.30.0/02-installation/01-docker.md index 02dceac3..3fffe75d 100644 --- a/docs/versioned_docs/version-v0.30.0/02-installation/01-docker.md +++ b/docs/versioned_docs/version-v0.30.0/02-installation/01-docker.md @@ -44,7 +44,7 @@ Persistent storage and the wiring between the different services is already take Keep in mind that every time you change the `.env` file, you'll need to re-run `docker compose up`. -If you want more config params, check the config documentation [here](../configuration/environment-variables). +If you want more config params, check the config documentation [here](../03-configuration/01-environment-variables.md). ### 4. Setup OpenAI @@ -57,7 +57,7 @@ To enable automatic tagging, you'll need to configure OpenAI. This is optional t OPENAI_API_KEY=<key> ``` -Learn more about the costs of using openai [here](../administration/openai). +Learn more about the costs of using openai [here](../06-administration/03-openai.md). <details> <summary>If you want to use Ollama (https://ollama.com/) instead for local inference.</summary> @@ -85,11 +85,11 @@ Then visit `http://localhost:3000` and you should be greeted with the Sign In pa ### [Optional] 6. Enable optional features -Check the [configuration docs](../configuration/environment-variables) for extra features to enable such as full page archival, full page screenshots, inference languages, etc. +Check the [configuration docs](../03-configuration/01-environment-variables.md) for extra features to enable such as full page archival, full page screenshots, inference languages, etc. ### [Optional] 7. Setup quick sharing extensions -Go to the [quick sharing page](../using-karakeep/quick-sharing) to install the mobile apps and the browser extensions. Those will help you hoard things faster! +Go to the [quick sharing page](../04-using-karakeep/quick-sharing.md) to install the mobile apps and the browser extensions. Those will help you hoard things faster! ## Updating @@ -98,4 +98,4 @@ Updating Karakeep will depend on what you used for the `KARAKEEP_VERSION` env va - 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 `KARAKEEP_VERSION=release`, you'll need to force docker to pull the latest version by running `docker compose up --pull always -d`. -Note that if you want to upgrade/migrate `Meilisearch` versions, refer to the [troubleshooting](../administration/troubleshooting) page. +Note that if you want to upgrade/migrate `Meilisearch` versions, refer to the [troubleshooting](../06-administration/05-troubleshooting.md) page. diff --git a/docs/versioned_docs/version-v0.30.0/02-installation/03-archlinux.md b/docs/versioned_docs/version-v0.30.0/02-installation/03-archlinux.md index b8433374..de86cdf3 100644 --- a/docs/versioned_docs/version-v0.30.0/02-installation/03-archlinux.md +++ b/docs/versioned_docs/version-v0.30.0/02-installation/03-archlinux.md @@ -27,7 +27,7 @@ 3. Set up - Environment variables can be set in `/etc/karakeep/karakeep.env` according to [configuration page](../configuration/environment-variables). **The environment variables that are not specified in `/etc/karakeep/karakeep.env` need to be added by yourself.** + Environment variables can be set in `/etc/karakeep/karakeep.env` according to [configuration page](../03-configuration/01-environment-variables.md). **The environment variables that are not specified in `/etc/karakeep/karakeep.env` need to be added by yourself.** 4. Enable service @@ -82,7 +82,7 @@ sudo chown -R karakeep:karakeep /var/lib/karakeep ``` **6. Set Karakeep** -Edit `/etc/karakeep/karakeep.env` according to [configuration page](../configuration/environment-variables). **The environment variables that are not specified in `/etc/karakeep/karakeep.env` need to be added by yourself.** +Edit `/etc/karakeep/karakeep.env` according to [configuration page](../03-configuration/01-environment-variables.md). **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 diff --git a/docs/versioned_docs/version-v0.30.0/02-installation/04-kubernetes.md b/docs/versioned_docs/version-v0.30.0/02-installation/04-kubernetes.md index 8cdc96b6..dbd1dc9a 100644 --- a/docs/versioned_docs/version-v0.30.0/02-installation/04-kubernetes.md +++ b/docs/versioned_docs/version-v0.30.0/02-installation/04-kubernetes.md @@ -18,7 +18,7 @@ You should also change the `NEXTAUTH_URL` variable to point to your server addre 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). -To see all available configuration options check the [documentation](../configuration/environment-variables). +To see all available configuration options check the [documentation](../03-configuration/01-environment-variables.md). To configure the neccessary secrets for the application copy the `.secrets_sample` file to `.secrets` and change the sample secrets to your generated secrets. @@ -35,7 +35,7 @@ To enable automatic tagging, you'll need to configure OpenAI. This is optional t OPENAI_API_KEY=<key> ``` -Learn more about the costs of using openai [here](../administration/openai). +Learn more about the costs of using openai [here](../06-administration/03-openai.md). <details> <summary>[EXPERIMENTAL] If you want to use Ollama (https://ollama.com/) instead for local inference.</summary> @@ -103,7 +103,7 @@ If the secret is successfully created you can now configure the Ingress to use T ### [Optional] 6. Setup quick sharing extensions -Go to the [quick sharing page](../using-karakeep/quick-sharing) to install the mobile apps and the browser extensions. Those will help you hoard things faster! +Go to the [quick sharing page](../04-using-karakeep/quick-sharing.md) to install the mobile apps and the browser extensions. Those will help you hoard things faster! ## Updating diff --git a/docs/versioned_docs/version-v0.30.0/02-installation/06-debuntu.md b/docs/versioned_docs/version-v0.30.0/02-installation/06-debuntu.md index 55984728..e500d411 100644 --- a/docs/versioned_docs/version-v0.30.0/02-installation/06-debuntu.md +++ b/docs/versioned_docs/version-v0.30.0/02-installation/06-debuntu.md @@ -71,4 +71,4 @@ During installation, the script created a configuration file for `meilisearch`, ## Still Running Hoarder? -There is a way to upgrade. Please see [Hoarder to Karakeep Migration](../administration/hoarder-to-karakeep-migration) +There is a way to upgrade. Please see [Hoarder to Karakeep Migration](../06-administration/08-hoarder-to-karakeep-migration.md) diff --git a/docs/versioned_docs/version-v0.30.0/02-installation/07-minimal-install.md b/docs/versioned_docs/version-v0.30.0/02-installation/07-minimal-install.md index e5720df1..2702e5aa 100644 --- a/docs/versioned_docs/version-v0.30.0/02-installation/07-minimal-install.md +++ b/docs/versioned_docs/version-v0.30.0/02-installation/07-minimal-install.md @@ -44,4 +44,4 @@ docker run -d \ You **MUST** change the `super_random_string` to a true random string which you can generate with `openssl rand -hex 32`. ::: -Check the [configuration docs](../configuration/environment-variables) for extra features to enable such as full page archival, full page screenshots, inference languages, etc. +Check the [configuration docs](../03-configuration/01-environment-variables.md) for extra features to enable such as full page archival, full page screenshots, inference languages, etc. diff --git a/docs/versioned_docs/version-v0.30.0/02-installation/09-cloud-hosting.md b/docs/versioned_docs/version-v0.30.0/02-installation/09-cloud-hosting.md index 08b9e054..fcbdf50e 100644 --- a/docs/versioned_docs/version-v0.30.0/02-installation/09-cloud-hosting.md +++ b/docs/versioned_docs/version-v0.30.0/02-installation/09-cloud-hosting.md @@ -10,4 +10,4 @@ If you want to use Karakeep without running your own servers, the hosted cloud o 1. Visit [cloud.karakeep.app](https://cloud.karakeep.app) and create an account. 2. Follow the onboarding flow to create your workspace. -3. Install the browser extension or mobile apps from the [quick sharing page](../using-karakeep/quick-sharing) and start saving links immediately. +3. Install the browser extension or mobile apps from the [quick sharing page](../04-using-karakeep/quick-sharing.md) and start saving links immediately. |
