Merge pull request #63 from linkwarden/dev

Dev

Author: daniel31x13

docs/self-hosting/ai-worker.md

@@ -4,7 +4,13 @@ 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.
+You need to set up an AI provider to use the AI tagging feature in your self-hosted instance of the app. This feature allows you to automatically tag your media files with relevant keywords, making it easier to search and organize your content.
+
+## Supported Providers
+
+### Ollama Provider
+
+You can set up [Ollama](https://github.com/ollama/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.
 
@@ -14,3 +20,28 @@ Here's an example:
 NEXT_PUBLIC_OLLAMA_ENDPOINT_URL=http://localhost:11434
 OLLAMA_MODEL=phi3:mini-4k
 ```
+
+### OpenAI Compatible Provider
+
+You can use an OpenAI-compatible provider for AI tagging by defining the following environment variables in your `.env` file:
+
+```
+CUSTOM_OPENAI_BASE_URL=
+OPENAI_MODEL=
+OPENAI_API_KEY=
+```
+
+Note that if you want to use OpenAI's official API, you don't need to define the `CUSTOM_OPENAI_BASE_URL` variable, as it defaults to OpenAI's API URL. Here's an example of how to set it up:
+
+```
+OPENAI_MODEL=gpt-4o
+OPENAI_API_KEY=YOUR_OPENAI_API_KEY
+```
+
+Another example, to use Gemini:
+
+```
+CUSTOM_OPENAI_BASE_URL=https://generativelanguage.googleapis.com/v1beta
+OPENAI_MODEL=gemini-2.5-flash-preview-04-17
+OPENAI_API_KEY=YOUR_GOOGLE_AI_STUDIO_API_KEY
+```

docs/self-hosting/environment-variables.md

@@ -4,7 +4,13 @@ sidebar_position: 3
 
 # Environment Variables
 
-Here are all the additional variables you can define in the `.env` file for setting up a self-hosted instance:
+Here are all the additional variables you can define in the `.env` file for setting up a self-hosted instance.
+
+:::note For Docker Users
+
+After changing your .env file, a `$ docker compose restart` won't suffice, you'll need to do a `$ docker compose down` and `$ docker compose up -d` to have the new .env variables propagate.
+
+:::
 
 | Environment Variable  | Default | Description                                                                    |
 | --------------------- | ------- | ------------------------------------------------------------------------------ |
@@ -36,10 +42,15 @@ Digital Ocean Spaces uses AWS S3 behind the scenes, so you can also choose to st
 
 ## SMTP Settings
 
-The variables you need to configure to enable password recovery without the admin interfering, email verification, etc...
+The variables you need to configure to enable password recovery without the admin interfering, email verification, etc.
+
+Make sure to define the correct protocol depending on the port you want to use:
+
+- `smtp://` with port 587 (STARTTLS)
+- `smtps://` with port 465 (Implicit SSL/TLS)
 
-| Environment Variable       | Default | Description                                                                                   |
-| -------------------------- | ------- | --------------------------------------------------------------------------------------------- |
-| NEXT_PUBLIC_EMAIL_PROVIDER | -       | If set to true, email will be enabled and you'll need to define the next two variables below. |
-| EMAIL_FROM                 | -       | The email that will send the verification emails.                                             |
-| EMAIL_SERVER               | -       | That sensitive string that starts with `smtp://...` .                                         |
+| Environment Variable       | Default | Description                                                                                        |
+| -------------------------- | ------- | -------------------------------------------------------------------------------------------------- |
+| NEXT_PUBLIC_EMAIL_PROVIDER | -       | If set to true, email will be enabled and you'll need to define the next two variables below.      |
+| EMAIL_FROM                 | -       | The email that will send the verification emails.                                                  |
+| EMAIL_SERVER               | -       | A url-encoded string with your credentials and the smtp server. (`smtp://user:password@host:port`) |

docs/self-hosting/installation.md

@@ -52,7 +52,7 @@ NEXTAUTH_SECRET=VERY_SENSITIVE_SECRET
 POSTGRES_PASSWORD=CUSTOM_POSTGRES_PASSWORD
 ```
 
-The only thing you MUST change here is `NEXTAUTH_SECRET` and `POSTGRES_PASSWORD`, they both should be different secret phrases.
+The only thing you MUST change here is `NEXTAUTH_SECRET` and `POSTGRES_PASSWORD`, they both should be different secret phrases. The phrase should be wrapped in single or double quotes if any special characters are used.
 
 The `NEXTAUTH_URL` should be changed to your domain name _only if you are hosting it somewhere else_.
 
@@ -72,7 +72,7 @@ After a few minutes (depending on your internet connection) you can access Linkw
 
 :::note
 
-The Manual Installation is targeted towards a more technical audience, to take an easier path, go for installation using [Docker](/self-hosting/installation#docker-compose).
+The Manual Installation is targeted towards a more technical audience, to take an easier path, go for installation using [Docker](/self-hosting/installation#docker-).
 
 :::
 

openapi/linkwarden.yaml

@@ -963,7 +963,7 @@ paths:
       parameters:
         - name: id
           in: path
-          description: The ID of the link to be deleted.
+          description: The ID of the link to be retrieved.
           required: true
           schema:
             type: integer