Skip to content

Commit

Permalink
Merge pull request #51 from linkwarden/dev
Browse files Browse the repository at this point in the history
v2.9.0 docs
  • Loading branch information
daniel31x13 authored Jan 6, 2025
2 parents 1a65e72 + f981455 commit e15ae53
Show file tree
Hide file tree
Showing 7 changed files with 49 additions and 9 deletions.
14 changes: 14 additions & 0 deletions docs/Usage/ai-tagging.md
Original file line number Diff line number Diff line change
@@ -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)
16 changes: 16 additions & 0 deletions docs/self-hosting/ai-worker.md
Original file line number Diff line number Diff line change
@@ -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
```
2 changes: 1 addition & 1 deletion docs/self-hosting/environment-variables.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 2
sidebar_position: 3
---

# Environment Variables
Expand Down
22 changes: 16 additions & 6 deletions docs/self-hosting/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: -->
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...`
<details>
<summary>`[0] upstream image response failed for https://t2.gstatic.com/faviconV2...`</summary>

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
```
</details>

<details>
<summary>`Type error: Module '"@prisma/client"' has no exported member...`</summary>

This error is caused by the `@prisma/client` package not being installed correctly, to fix it, simply run:

```bash
$ yarn prisma generate
```

</details>
2 changes: 1 addition & 1 deletion docs/self-hosting/sso-oauth.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 3
sidebar_position: 4
---

# SSO/OAuth Integrations
Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosting/upgrading/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Upgrading",
"position": 4
"position": 5
}
Binary file added static/img/ai_tagging.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e15ae53

Please sign in to comment.