xref: /plugin/dokullm/README.md (revision aa0fd8edffafd18a5a4092c22190e5301b24c887)
1# DokuLLM - LLM Integration Plugin for DokuWiki
2
3A comprehensive DokuWiki plugin that integrates Large Language Model capabilities with semantic search through ChromaDB. This plugin enables advanced text processing directly within the DokuWiki editing environment while maintaining content in a vector database for intelligent content discovery.
4
5## Key Features
6
7### AI-Powered Text Processing
8- **Content Creation**: Generate reports and documents with AI assistance
9- **Text Comparison**: Highlight differences between document versions
10- **Custom Prompts**: Process text with user-defined instructions
11- **Template Integration**: Use predefined templates for consistent formatting
12
13### Semantic Search & Document Management
14- **Vector Storage**: Store document embeddings in ChromaDB for semantic search
15- **Intelligent Chunking**: Smart document splitting with metadata preservation
16- **Update Optimization**: Timestamp-based checking to avoid reprocessing unchanged files
17- **Direct Retrieval**: Access documents by ID with rich metadata extraction
18
19### DokuWiki Integration
20- **Editor Toolbar**: Seamless integration with DokuWiki's editing interface
21- **Page Templates**: Smart template handling with automatic metadata insertion
22- **Copy Functionality**: Enhanced page duplication with template awareness
23- **Context Management**: Provide examples and templates as processing context
24
25## Architecture
26
27The plugin consists of several key components:
28- **Frontend**: JavaScript toolbar integrated into DokuWiki's editor
29- **Backend**: PHP plugin handling AJAX requests and LLM communication
30- **Database**: ChromaDB client for vector storage and semantic search
31- **CLI Tools**: Command-line interface for batch document processing
32
33## Requirements
34- DokuWiki installation
35- PHP 7.4 or higher
36- ChromaDB server
37- Ollama for local embedding generation (optional)
38- Access to LLM API (OpenAI-compatible)
39
40## Installation
411. Clone or download the plugin to your DokuWiki plugins directory
422. Configure the plugin settings in DokuWiki's configuration manager
433. Set up ChromaDB and Ollama services
444. Configure connection settings through the DokuWiki admin interface
45
46Note: Configuration has been moved from the deprecated `config.php` to the standard DokuWiki configuration files (`conf/default.php` and `conf/metadata.php`).
47
48## Configuration
49The plugin is configurable through multiple levels:
50- DokuWiki plugin settings interface
51- `config.php` for service endpoints
52- `conf/default.php` for default values
53- Language files for localization
54
55## License
56GPL 2.0
57
58## Author
59Costin Stroie <costinstroie@eridu.eu.org>
60