> For the complete documentation index, see [llms.txt](https://help.glpi-project.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.glpi-project.org/glpi-12/tools/knowledge-base.md).

# Knowledge base

The GLPI knowledge base has two main targets:

* Gather internal knowledge for technicians;
* Provide information in the form of a public FAQ to allow users to resolve simple problems themselves.

{% hint style="success" %}
Only articles in the public FAQ are visible to users of the simplified interface. Other items are only visible to technicians via the standard interface.
{% endhint %}

Each knowledge base article must have one or more targets, whether they are entities, groups, profiles, or users, to be readable.

As long as an article has no target, it is only visible to its author, is marked as `Not published` <i class="fa-eye-slash">:eye-slash:</i> and appears in the `Unpublished articles` ![](https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-41f512b6e048e1193a317bc154cd5d87cb81c25e%2Fimage%20\(17\).png?alt=media)table on the knowledge base homepage.

It is also possible to attach documents to knowledge base articles.

{% hint style="info" %}

* Targeting applies in the same way whether the article is in the FAQ or only in the knowledge base.
* You can publish an article for everyone by targeting the root entity. Other [permissions](file:///#autorisations) options are available.
* An article can be made visible for a defined period by specifying a start and end date.
  {% endhint %}

{% hint style="warning" %}
Items that should not be interpreted when displayed can be defined with the preformatted style (`<pre>` in HTML). Tags like `<VirtualHost>` can therefore be inserted and will be displayed. Other HTML tags (`<TAG>...</TAG>`) may disappear during editing; to have full visibility of the text, you can switch to HTML mode where all elements will be visible. The browser may also dynamically modify content (case changes, tag additions) during editing.
{% endhint %}

***

## Article Creation

* From **`Tools`** > **`Knowledge Base`**, click **`+ Add`** at the top of the screen.

<figure><img src="https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-1a2bf17efbaf03527c1f7f9a3162b5cdae27dea1%2Fkb-add.png?alt=media" alt=""><figcaption><p>Creation of an article</p></figcaption></figure>

On this page, you can add:

* An icon (from a predefined list or you can add your own icons)
* A title
* Content
* Translates
* A visibility-focused program

### Formatting

The **`/`** command allows you to display the different available options:

* Heading (1, 2, and 3)
* Bullet list
* Numbered list
* Quote
* Code block
* Table
* Separator
* Image
* Video

You can also format your text by highlighting the text and using the contextual toolbar:

<div align="left"><figure><img src="https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-6fc1daa2a4095c0558bce889ebbd8b461bb6e061%2Fformatting-bar.png?alt=media" alt=""><figcaption></figcaption></figure></div>

or using shortcuts:

| Shortcut | Effect    |
| -------- | --------- |
| CTRL + b | Bold      |
| CTRL + i | Italic    |
| CTRL + u | Underline |
| CTRL + e | Code      |

### Add / Unlink a document

{% stepper %}
{% step %}

#### Add

It is possible to add a document from your computer or link an existing document.

* Click **`+ Add a document`**
* Select **`Upload a file`** to choose one from your computer or **`Link a document`** to choose one from the document library. If you upload a document from your computer, you can add a description (optional).

<figure><img src="https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-f6b16c526bd32fccf1688f9951f6bcaa444ca4c1%2Fkb-add-doc.png?alt=media" alt=""><figcaption><p>Upload a document</p></figcaption></figure>

<figure><img src="https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-d2346d4f2ffd430587119ae907d8bbbbf37f1bc0%2Fkb-link-doc.png?alt=media" alt=""><figcaption><p>Link an existing doc</p></figcaption></figure>
{% endstep %}

{% step %}

#### Unlink

* To unlink a document, click the cross next to the document in question, then click **`Unlink`**.

<figure><img src="https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-00096b0416c81e6c5b130c2e0c6a6707067a4367%2Fkb-unlink-doc.png?alt=media" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

### Link / Unlink an item

{% stepper %}
{% step %}

#### Link

It is possible to link a GLPI item (application, computer, incident, etc.).

* Click **`Link to another`** item
* Select the desired item from the dropdown list.

{% hint style="info" %}
You can link multiple items of different types.
{% endhint %}

<figure><img src="https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-f952f97732088521100117ad10a93f4880ff55c7%2Fkb-link-element.png?alt=media" alt=""><figcaption><p>Link an item</p></figcaption></figure>
{% endstep %}

{% step %}

#### Unlink

* To unlink an item, click the cross next to the item in question, then click **`Unlink`**.

<figure><img src="https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-83c3a61db94353ece566749ff08e8121b2e037cb%2Fkb-unlink-element.png?alt=media" alt=""><figcaption><p>unlink an item</p></figcaption></figure>
{% endstep %}
{% endstepper %}

### Add / Delete a translation

{% stepper %}
{% step %}

#### Add

* To translate an article, click Translation below the article title.
* Select the desired language.
* Translate the title.
* Proceed with the document translation.
* Click **`Save`**.

<figure><img src="https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-e887a9abe51bb07937191820c3aba27703006d7a%2Fkb-add-translation.png?alt=media" alt=""><figcaption><p>Add a translation for an article</p></figcaption></figure>
{% endstep %}

{% step %}

#### Delete

* To delete a translation, click Translations.
* Select the desired language.
* Click the trash can.

<figure><img src="https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-f0d9c464d0462b38266fe73f13611d9094aa23ba%2Fkb-delete-translation.png?alt=media" alt=""><figcaption><p>Delete a translation for an article</p></figcaption></figure>
{% endstep %}
{% endstepper %}

***

## Article Management

Article management is done via the article's <i class="fa-ellipsis-vertical">:ellipsis-vertical:</i> menu.

<figure><img src="https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-f4933931eb0f78a2458f7a6d0b0363254d742b7f%2Fkb-options.png?alt=media" alt=""><figcaption><p>Management menu</p></figcaption></figure>

### History and Restoration

#### History

Allows you to view the modifications made by authorized users (translation, article modification, document addition, etc.).

<figure><img src="https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-43547aa73f4eb477dd9e9f414321f06130d42a47%2Fkb-history.png?alt=media" alt=""><figcaption></figcaption></figure>

#### Restoration

From the history, you can view the content of a version that interests you. The changes made will appear on the article using color coding:

* **Green**: the **new** values
* **Red**: the **deleted** values
* **Gray**: **unchanged** values

<figure><img src="https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-7e5c4ace897efc387b3ab468b740e42ef5eb93e1%2Fkb-restore.png?alt=media" alt=""><figcaption><p>Article restoration</p></figcaption></figure>

You will then be able to click the restore icon <img src="https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-94008577c2da0478e8fd228f134d6feeefd1907a%2Frestore.png?alt=media" alt="" data-size="line"> to load the article with that version.

### Comments

Add comments for the desired article. This comment will be visible from the article by clicking on **Comment** under the article title.

### Service Catalog

From this menu, it is possible to:

* Show this article in the service catalog
* **Pin it** to the top of the service catalog
* Display a description
* Classify this article in a **category**

<figure><img src="https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-d02248e6e5da30fc63cbb8cf1e1545736c62119a%2Fkb-catalog-services.png?alt=media" alt=""><figcaption><p>Services catolog options</p></figcaption></figure>

### Permissions

Permissions identify who can view the article. You can select entities, groups, profiles, or users.

<figure><img src="https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-e9cc7a031460eefbb5197c147d6552d10cc3f218%2Fkb-permissions.png?alt=media" alt=""><figcaption><p>Permissions</p></figcaption></figure>

You can also display additional options for groups and profiles that will allow you to indicate the entity in which the article will be visible.

<div align="left"><figure><img src="https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-2359e5aff85ee9b232c3d5d459702ecef39122d3%2Fkb-options-permissions.png?alt=media" alt="" width="536"><figcaption></figcaption></figure></div>

### Sharing

Sharing, on the other hand, allows you to transmit an article from the knowledge base via a public link. This link will be viewable by anyone who has the link (provided they also have access to the subnet where your GLPI instance is located. For local addresses, only users with access to the local network will be able to view the shared article. For public instances, the link will be viewable by everyone).

You can copy the link using the <i class="fa-copy">:copy:</i> icon or regenerate a link using <i class="fa-arrows-rotate-reverse">:arrows-rotate-reverse:</i>.

<figure><img src="https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-3ac62ca57c5aaa2f1ed14e852561e26a2842526e%2Fkb-share.png?alt=media" alt=""><figcaption><p>Sharing an article</p></figcaption></figure>

### Schedule Visibility

You can schedule visibility for an article by indicating start and end dates.

* If only the start date is set, the article will be visible from that date with no end limit.
* If only the end date is indicated, the article will be visible from the day of its publication until the indicated end date.

<figure><img src="https://304570660-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fuys4bnfAs7Oe2yWUUh3p%2Fuploads%2Fgit-blob-d219d0f32d0af86db7912774a2b178c411b7d8f1%2Fkb-visibility.png?alt=media" alt=""><figcaption><p>Visibility of the article</p></figcaption></figure>

### Add to Favorites

Adding to favorites allows for quick retrieval when navigating the knowledge base.

### Add to FAQ

Adding to the FAQ allows you to add an article visible from the simplified interface.

### Delete an Article

Deleting the article results in its permanent deletion. You will not be able to undo this.

***

## Search options

The knowledge base search engine provides operators for complex search: `+ - ~ < > * ” ” ()`.

<table><thead><tr><th width="277">Expression</th><th>Description</th></tr></thead><tbody><tr><td><code>+</code></td><td>word must be there</td></tr><tr><td><code>-</code></td><td>word must not be there</td></tr><tr><td><code>*</code></td><td>truncate suffix</td></tr><tr><td><code>" "</code></td><td>contained sequence must be searched literally</td></tr><tr><td><code>&#x3C; ></code></td><td>define order on search elements</td></tr><tr><td><code>()</code></td><td>group when using &#x3C; and ></td></tr></tbody></table>

**Examples** :

<table><thead><tr><th width="288">Example</th><th>Description</th></tr></thead><tbody><tr><td><code>printer failure</code></td><td>Search lines containing at least one of these words</td></tr><tr><td><code>+printer +failure</code></td><td>Search lines containing both words</td></tr><tr><td><code>+mail thunderbird</code></td><td>Search lines containing word <em>mail</em> but rank higher lines containing also word <em>thunderbird</em></td></tr><tr><td><code>+mail -outlook</code></td><td>Search lines containing word <em>mail</em> but not word <em>outlook</em></td></tr><tr><td><code>+mail +(>thunderbird &#x3C;outlook)</code></td><td>Search lines containing word <em>mail</em> and <em>thunderbird</em>, or <em>mail</em> and <em>outlook</em>, in any order, but rank <em>mail thunderbird</em> higher than <em>mail outlook</em></td></tr><tr><td><code>open*</code></td><td>Search lines containing words such as <em>openoffice</em>, <em>openwriter</em>, <em>openbar</em>, <em>openphp</em>...</td></tr><tr><td><code>"openoffice suite"</code></td><td>Search lines containing exactly sentence <em>openoffice suite</em></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.glpi-project.org/glpi-12/tools/knowledge-base.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
