aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMohamed Bassem <me@mbassem.com>2024-12-29 17:44:40 +0000
committerMohamed Bassem <me@mbassem.com>2024-12-29 17:56:56 +0000
commita1c62e5be4212709154337a932ec7ff8920d89a2 (patch)
tree18ac14020c41790718e24db68384909c418026e0
parent27b3f9d17958d76ced902787e387c15db720af0a (diff)
downloadkarakeep-a1c62e5be4212709154337a932ec7ff8920d89a2.tar.zst
docs: Add troubleshooting guide
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yml12
-rw-r--r--docs/docs/12-troubleshooting.md33
-rw-r--r--docs/docs/13-community-projects.md (renamed from docs/docs/12-community-projects.md)0
-rw-r--r--docs/docs/14-Guides/01-legacy-container-upgrade.md (renamed from docs/docs/13-Guides/01-legacy-container-upgrade.md)0
4 files changed, 44 insertions, 1 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index bc9de30d..7b19ef6b 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -7,7 +7,7 @@ body:
value: |
Thanks for taking the time to fill out a bug report!
Please note that this form is for reporting bugs in existing supported functionality.
-
+
If you are reporting something that's not an issue in functionality we've previously supported and/or is simply something different to your expectations, then it may be more appropriate to raise via a feature or support request instead.
- type: textarea
id: description
@@ -59,3 +59,13 @@ body:
placeholder: (eg. v0.18.0)
validations:
required: true
+
+ - type: checkboxes
+ id: confirm-troubleshooting
+ attributes:
+ label: Have you checked the troubleshooting guide?
+ description: |
+ We have a troubleshooting guide that you can find [here](https://docs.hoarder.app/next/troubleshooting). Please check it out as you might find a solution to your problem.
+ options:
+ - label: I have checked the troubleshooting guide and I haven't found a solution to my problem
+ required: true
diff --git a/docs/docs/12-troubleshooting.md b/docs/docs/12-troubleshooting.md
new file mode 100644
index 00000000..15356309
--- /dev/null
+++ b/docs/docs/12-troubleshooting.md
@@ -0,0 +1,33 @@
+# Troubleshooting
+
+## SqliteError: no such table: user
+
+This usually means that there's something wrong with the database setup (more concretely, it means that the database is not initialized). This can be caused by multiple problems:
+1. **Wiped DATA_DIR:** Your `DATA_DIR` got wiped (or the backing storage dir changed). If you did this intentionally, restart the container so that it can re-initalize the database.
+2. **Missing DATA_DIR**: You're not using the default docker compose file, and you forgot to configure the `DATA_DIR` env var. This will result into the database getting set up in a different directory than the one used by the service.
+
+## Chrome Failed to Read DnsConfig
+
+If you see this error in the logs of the chrome container, it's a benign error and you can safely ignore it. Whatever problems you're having, is unrelated to this error.
+
+## AI Tagging not working (when using OpenAI)
+
+Check the logs of the container and this will usually tell you what's wrong. Common problems are:
+1. Typo in the env variable `OPENAI_API_KEY` name resulting into logs saying something like "skipping inference as it's not configured".
+2. You forgot to call `docker compose up` after configuring open ai.
+3. OpenAI requires pre-charging the account with credits before using it, otherwise you'll get an error like "insufficient funds".
+
+## AI Tagging not working (when using Ollama)
+
+Check the logs of the container and this will usually tell you what's wrong. Common problems are:
+1. Typo in the env variable `OLLAMA_BASE_URL` name resulting into logs saying something like "skipping inference as it's not configured".
+2. You forgot to call `docker compose up` after configuring ollama.
+3. You didn't change the `INFERENCE_TEXT_MODEL` env variable, resulting into hoarder attempting to use gpt models with ollama which won't work.
+4. Ollama server is not reachable by the hoarder container. This can be caused by:
+ 1. Ollama server being in a different docker network than the hoarder container.
+ 2. You're using `localhost` as the `OLLAMA_BASE_URL` instead of the actual address of the ollama server. `localhost` points to the container itself, not the docker host. Check this [stackoverflow answer](https://stackoverflow.com/questions/24319662/from-inside-of-a-docker-container-how-do-i-connect-to-the-localhost-of-the-mach) to find how to correctly point to the docker host address instead.
+
+## Crawling not working
+
+Check the logs of the container and this will usually tell you what's wrong. Common problems are:
+1. You changed the name of the chrome container but didn't change the `BROWSER_WEB_URL` env variable.
diff --git a/docs/docs/12-community-projects.md b/docs/docs/13-community-projects.md
index 42424413..42424413 100644
--- a/docs/docs/12-community-projects.md
+++ b/docs/docs/13-community-projects.md
diff --git a/docs/docs/13-Guides/01-legacy-container-upgrade.md b/docs/docs/14-Guides/01-legacy-container-upgrade.md
index 3c86705a..3c86705a 100644
--- a/docs/docs/13-Guides/01-legacy-container-upgrade.md
+++ b/docs/docs/14-Guides/01-legacy-container-upgrade.md