diff --git a/docs/Usage/ai-tagging.md b/docs/Usage/ai-tagging.md new file mode 100644 index 0000000..93505c8 --- /dev/null +++ b/docs/Usage/ai-tagging.md @@ -0,0 +1,14 @@ +--- +sidebar_position: 6 +--- + +# AI Tagging + +We've added a new feature in Linkwarden 2.9 that automatically tags your links based on their content. This feature uses a local AI model to analyze the content of your links and can assign tags to links in 2 ways: + +1. **Auto-generate Tags**: When a link is added, Linkwarden will automatically generate and assign tags based on the content of the link. +2. **Using Predefined Tags**: You can also use predefined tags to let Linkwarden auto-assign tags based on the content of the link. + +You can enable this feature in the Settings > Preferences page. + +![AI Tagging Image](/img/ai_tagging.jpeg) diff --git a/docs/self-hosting/ai-worker.md b/docs/self-hosting/ai-worker.md new file mode 100644 index 0000000..c2c1636 --- /dev/null +++ b/docs/self-hosting/ai-worker.md @@ -0,0 +1,16 @@ +--- +sidebar_position: 2 +--- + +# AI Tagging + +The AI Tagging feature uses [Ollama](https://github.com/ollama/ollama) behind the scenes. If you're self-hosting Linkwarden, you need to set up Ollama and pull your preferred model onto your server to use this feature. A lightweight model like the `phi3:mini-4k` is enough for this feature. + +After that, you need to define the `NEXT_PUBLIC_OLLAMA_ENDPOINT_URL` and `OLLAMA_MODEL` environment variables inside your `.env` file. + +Here's an example: + +``` +NEXT_PUBLIC_OLLAMA_ENDPOINT_URL=http://localhost:11434 +OLLAMA_MODEL=phi3:mini-4k +``` diff --git a/docs/self-hosting/environment-variables.md b/docs/self-hosting/environment-variables.md index 2d5dd15..74f7585 100644 --- a/docs/self-hosting/environment-variables.md +++ b/docs/self-hosting/environment-variables.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 3 --- # Environment Variables diff --git a/docs/self-hosting/installation.md b/docs/self-hosting/installation.md index 5f7aec0..65d98f1 100644 --- a/docs/self-hosting/installation.md +++ b/docs/self-hosting/installation.md @@ -132,12 +132,22 @@ $ yarn start ### Troubleshooting - +There are a few common issues that you might encounter when setting up Linkwarden, here are some of them: -#### `Type error: Module '"@prisma/client"' has no exported member...` +
+ `[0] upstream image response failed for https://t2.gstatic.com/faviconV2...` -This error is caused by the `@prisma/client` package not being installed correctly, to fix it, simply run: + This error is caused by the favicon (the website's logo) not being found, it's really not a big deal, but if you want to fix it, you can set an icon to the links that don't have a favicon, or you can just hide the icons. The favicon is the only part that isn't actually stored and is being fetched from the internet every time you load the page. -```bash -$ yarn prisma generate -``` +
+ +
+ `Type error: Module '"@prisma/client"' has no exported member...` + + This error is caused by the `@prisma/client` package not being installed correctly, to fix it, simply run: + + ```bash + $ yarn prisma generate + ``` + +
diff --git a/docs/self-hosting/sso-oauth.md b/docs/self-hosting/sso-oauth.md index 2dde32c..e608520 100644 --- a/docs/self-hosting/sso-oauth.md +++ b/docs/self-hosting/sso-oauth.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 4 --- # SSO/OAuth Integrations diff --git a/docs/self-hosting/upgrading/_category_.json b/docs/self-hosting/upgrading/_category_.json index 46007ac..dd8075c 100644 --- a/docs/self-hosting/upgrading/_category_.json +++ b/docs/self-hosting/upgrading/_category_.json @@ -1,4 +1,4 @@ { "label": "Upgrading", - "position": 4 + "position": 5 } diff --git a/static/img/ai_tagging.jpeg b/static/img/ai_tagging.jpeg new file mode 100644 index 0000000..200ddd3 Binary files /dev/null and b/static/img/ai_tagging.jpeg differ