diff options
18 files changed, 34 insertions, 34 deletions
diff --git a/docs/docs/02-installation/01-docker.md b/docs/docs/02-installation/01-docker.md index e2fb38d6..80739c80 100644 --- a/docs/docs/02-installation/01-docker.md +++ b/docs/docs/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,9 +57,9 @@ 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). -If you want to use a different AI provider (e.g. Ollama for local inference), check out the [different AI providers](../configuration/different-ai-providers) guide. +If you want to use a different AI provider (e.g. Ollama for local inference), check out the [different AI providers](../03-configuration/02-different-ai-providers.md) guide. ### 5. Start the service @@ -73,11 +73,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 @@ -86,4 +86,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/docs/02-installation/03-archlinux.md b/docs/docs/02-installation/03-archlinux.md index b8433374..de86cdf3 100644 --- a/docs/docs/02-installation/03-archlinux.md +++ b/docs/docs/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/docs/02-installation/04-kubernetes.md b/docs/docs/02-installation/04-kubernetes.md index 9014cf22..9daac131 100644 --- a/docs/docs/02-installation/04-kubernetes.md +++ b/docs/docs/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,9 +35,9 @@ 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). -If you want to use a different AI provider (e.g. Ollama for local inference), check out the [different AI providers](../configuration/different-ai-providers) guide. +If you want to use a different AI provider (e.g. Ollama for local inference), check out the [different AI providers](../03-configuration/02-different-ai-providers.md) guide. ### 4. Deploy the service @@ -91,7 +91,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/docs/02-installation/06-debuntu.md b/docs/docs/02-installation/06-debuntu.md index 55984728..e500d411 100644 --- a/docs/docs/02-installation/06-debuntu.md +++ b/docs/docs/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/docs/02-installation/07-minimal-install.md b/docs/docs/02-installation/07-minimal-install.md index e5720df1..2702e5aa 100644 --- a/docs/docs/02-installation/07-minimal-install.md +++ b/docs/docs/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/docs/02-installation/09-cloud-hosting.md b/docs/docs/02-installation/09-cloud-hosting.md index 08b9e054..fcbdf50e 100644 --- a/docs/docs/02-installation/09-cloud-hosting.md +++ b/docs/docs/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. diff --git a/docs/docs/03-configuration/01-environment-variables.md b/docs/docs/03-configuration/01-environment-variables.md index a7f45221..209bd49d 100644 --- a/docs/docs/03-configuration/01-environment-variables.md +++ b/docs/docs/03-configuration/01-environment-variables.md @@ -92,7 +92,7 @@ Either `OPENAI_API_KEY` or `OLLAMA_BASE_URL` need to be set for automatic taggin | Name | Required | Default | Description | | ------------------------------------ | -------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| OPENAI_API_KEY | No | Not set | The OpenAI key used for automatic tagging. More on that in [here](../administration/openai). | +| OPENAI_API_KEY | No | Not set | The OpenAI key used for automatic tagging. More on that in [here](../06-administration/03-openai.md). | | OPENAI_BASE_URL | No | Not set | If you just want to use OpenAI you don't need to pass this variable. If, however, you want to use some other openai compatible API (e.g. azure openai service), set this to the url of the API. | | OPENAI_PROXY_URL | No | Not set | HTTP proxy server URL for OpenAI API requests (e.g., `http://proxy.example.com:8080`). | | OPENAI_SERVICE_TIER | No | Not set | Set to `auto`, `default`, or `flex`. Flex processing provides lower costs in exchange for slower response times and occasional resource unavailability. See [OpenAI Flex Processing](https://platform.openai.com/docs/guides/flex-processing) and [Chat Service Tier](https://platform.openai.com/docs/api-reference/chat/object#chat-object-service_tier) for more details. | diff --git a/docs/docs/04-using-karakeep/import.md b/docs/docs/04-using-karakeep/import.md index 59e82647..3bf07cae 100644 --- a/docs/docs/04-using-karakeep/import.md +++ b/docs/docs/04-using-karakeep/import.md @@ -45,7 +45,7 @@ All the URLs in the bookmarks file will be added automatically, you will not be Importing bookmarks using the CLI requires some technical knowledge and might not be very straightforward for non-technical users. Don't hesitate to ask questions in github discussions or discord though. ::: -If you can get your bookmarks in a text file with one link per line, you can use the following command to import them using the [karakeep cli](../integrations/command-line): +If you can get your bookmarks in a text file with one link per line, you can use the following command to import them using the [karakeep cli](../05-integrations/02-command-line.md): ``` while IFS= read -r url; do diff --git a/docs/docs/06-administration/08-hoarder-to-karakeep-migration.md b/docs/docs/06-administration/08-hoarder-to-karakeep-migration.md index 4e309408..689c730d 100644 --- a/docs/docs/06-administration/08-hoarder-to-karakeep-migration.md +++ b/docs/docs/06-administration/08-hoarder-to-karakeep-migration.md @@ -19,7 +19,7 @@ You can also change the `HOARDER_VERSION` environment variable but if you do so ## Migrating a Baremetal Installation -If you previously used the [Debian/Ubuntu install script](../installation/debuntu) to install Hoarder, there is an option to migrate your installation to Karakeep. +If you previously used the [Debian/Ubuntu install script](../02-installation/06-debuntu.md) to install Hoarder, there is an option to migrate your installation to Karakeep. ```bash bash karakeep-linux.sh migrate 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. diff --git a/docs/versioned_docs/version-v0.30.0/03-configuration/01-environment-variables.md b/docs/versioned_docs/version-v0.30.0/03-configuration/01-environment-variables.md index 23a6f3b9..f02063a7 100644 --- a/docs/versioned_docs/version-v0.30.0/03-configuration/01-environment-variables.md +++ b/docs/versioned_docs/version-v0.30.0/03-configuration/01-environment-variables.md @@ -92,7 +92,7 @@ Either `OPENAI_API_KEY` or `OLLAMA_BASE_URL` need to be set for automatic taggin | Name | Required | Default | Description | | ------------------------------------ | -------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| OPENAI_API_KEY | No | Not set | The OpenAI key used for automatic tagging. More on that in [here](../administration/openai). | +| OPENAI_API_KEY | No | Not set | The OpenAI key used for automatic tagging. More on that in [here](../06-administration/03-openai.md). | | OPENAI_BASE_URL | No | Not set | If you just want to use OpenAI you don't need to pass this variable. If, however, you want to use some other openai compatible API (e.g. azure openai service), set this to the url of the API. | | OPENAI_PROXY_URL | No | Not set | HTTP proxy server URL for OpenAI API requests (e.g., `http://proxy.example.com:8080`). | | OLLAMA_BASE_URL | No | Not set | If you want to use ollama for local inference, set the address of ollama API here. | diff --git a/docs/versioned_docs/version-v0.30.0/04-using-karakeep/import.md b/docs/versioned_docs/version-v0.30.0/04-using-karakeep/import.md index 59e82647..3bf07cae 100644 --- a/docs/versioned_docs/version-v0.30.0/04-using-karakeep/import.md +++ b/docs/versioned_docs/version-v0.30.0/04-using-karakeep/import.md @@ -45,7 +45,7 @@ All the URLs in the bookmarks file will be added automatically, you will not be Importing bookmarks using the CLI requires some technical knowledge and might not be very straightforward for non-technical users. Don't hesitate to ask questions in github discussions or discord though. ::: -If you can get your bookmarks in a text file with one link per line, you can use the following command to import them using the [karakeep cli](../integrations/command-line): +If you can get your bookmarks in a text file with one link per line, you can use the following command to import them using the [karakeep cli](../05-integrations/02-command-line.md): ``` while IFS= read -r url; do diff --git a/docs/versioned_docs/version-v0.30.0/06-administration/08-hoarder-to-karakeep-migration.md b/docs/versioned_docs/version-v0.30.0/06-administration/08-hoarder-to-karakeep-migration.md index 4e309408..689c730d 100644 --- a/docs/versioned_docs/version-v0.30.0/06-administration/08-hoarder-to-karakeep-migration.md +++ b/docs/versioned_docs/version-v0.30.0/06-administration/08-hoarder-to-karakeep-migration.md @@ -19,7 +19,7 @@ You can also change the `HOARDER_VERSION` environment variable but if you do so ## Migrating a Baremetal Installation -If you previously used the [Debian/Ubuntu install script](../installation/debuntu) to install Hoarder, there is an option to migrate your installation to Karakeep. +If you previously used the [Debian/Ubuntu install script](../02-installation/06-debuntu.md) to install Hoarder, there is an option to migrate your installation to Karakeep. ```bash bash karakeep-linux.sh migrate |