1====== AIchatLocal Plugin ======
2
3---- plugin ----
4description: Adds support for local LLMs with OpenAI-compatible APIs to the AIChat plugin
5author     : Heinrich Krupp
6email      : heinich.krupp@gmail.com
7type       : action, helper
8lastupdate : 2024-11-11
9compatible : Kaos
10depends    : aichat
11conflicts  :
12similar    : aichat
13tags       : !experimental, chatgpt, llm, ai, local, Ollama
14
15downloadurl: https://github.com/doobidoo/dokuwiki-plugin-aichatlocal/zipball/master
16bugtracker : https://github.com/doobidoo/dokuwiki-plugin-aichatlocal/issues
17sourcerepo : https://github.com/doobidoo/dokuwiki-plugin-aichatlocal/
18donationurl:
19
20updatemessage:
21
22screenshot_img : plugin:aichat.png
23
24tags     : ai, llm, chat, local, openai-compatible
25----
26
27===== Additional Plugin Information =====
28
29description: This plugin extends the AIChat plugin to support local Large Language Models (LLMs) that provide an OpenAI-compatible API interface. It enables organizations to use their own LLM deployments while maintaining compatibility with DokuWiki’s AIChat functionality.
30
31===== Installation Instructions =====
32
33  - Install the AIChat plugin if not already installed
34  - Install this plugin using the Plugin Manager
35  - Configure your local LLM endpoint in the Configuration Manager
36  - Select ‘local-chat’ as your model in AIChat settings
37
38===== Configuration =====
39
40The plugin requires minimal configuration:
41  - local_llm_baseurl: The base URL of your OpenAI-compatible API
42  - local_llm_apikey: API key if your local deployment requires authentication
43
44===== Requirements =====
45
46  * DokuWiki
47  * AIChat plugin
48  * PHP 7.4 or higher
49  * Local LLM with OpenAI-compatible API endpoints
50    * Must support /v1/chat/completions endpoint
51    * Should return responses in OpenAI format
52
53===== Features =====
54
55  * Seamless integration with AIChat plugin
56  * Support for local LLM deployments
57  * OpenAI-compatible API support
58  * Configurable base URL and authentication
59  * Token usage tracking (if supported by local LLM)
60  * Error handling and reporting
61
62===== Support =====
63
64  * Report issues on the bugtracker
65  * Join discussions in the DokuWiki forum
66  * Check documentation at https://www.dokuwiki.org/plugin:aichatlocal