Skip to content
Home
›
OpenKM 8.2
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Select language
English
Español
Hardware and software requirements
Hardware and software requirements
Thirdparty software requirements
Installation
Installation
Installing on Ubuntu and Debian
Installing on RedHat and CentOS
Installing on Windows
Using the installer
Using Docker
Installing on a pristine Tomcat
Database
Database
Configuring MySQL and MariaDB
Configuring MySQL and MariaDB
MySQL tuning
Change MySQL data directory
MySQL 8 throubleshooting
Configuring Oracle
Configuring PostgreSQL
Configuring SQL Server
Configuring Hikari pool
Backup and restore
Backup and restore
Backup health check
Linux backup and restore with BorgBackup
Linux backup and restore with rdiff-backup tool
Linux backup and restore with Duplicity
Linux backup and restore with rsync
Linux backup with LFTP
Cluster configuration
Sharding configuration
Instance replication
How to move to another server
Security best practices
Setup
Setup
Antivirus configuration
Cleaning older activity log data
Configuring Apache HTTP Reverse-Proxy
Configuring Apache HTTPS Reverse-Proxy
Configuring Apache HTTP Reverse-Proxy ( Windows )
Configuring Nginx HTTP Reverse-Proxy
Configuring Apache HTTP to rewrite old OpenKM URL
Configuring Lucene Analyzer
Configuring CADViewer
Configuring OCR engine
Configuring OpenSSL
Configuring mail
Configuring Tomcat memory utilization
Configuring Tomcat port
Configuring Tomcat session timeout
Configuring Tomcat timezone
Configuring openkm.xml
Configuring ONLYOFFICE
Configuring Collabora Online
Configuring safe trash purge
Configuring search highlighter
Configuring Tomcat to work behind an Internet proxy
Configuring VidSigner
Change repository home
Change default role names
Enable extensions
LDAP configuration
LDAP configuration
OpenLDAP example with URL base at login
Active Directory example with referral enabled
Active Directory example with login based on filtering users by roles
Active Directory basic configuration
Active Directory advanced configuration
Active Directory mixed configuration
Active Directory mixed configuration with LDAP synced
LDAP best practices for filtering users and roles
ClearOS LDAP configuration
LDAP troubleshooting
Log configuration
LibreOffice configuration
Security configuration
Configuring Two Factor Authentication
Configuring document expiration
Configuring CIFS
Cache configuration
Configuring email digital signature
Configuring anonymous user
Configuring chatbot
Prometheus configuration
Configuring Content Replication between two OpenKM instances
Troubleshooting
Troubleshooting
Server configuration
Server configuration
RedHat and Oracle Linux issues
Client configuration
Best practices for reporting issues
Administration guide
Administration guide
Configuration parameters
Configuration parameters
Recommended configuration parameters
Preview parameters
LDAP configuration parameters
User interface configuration parameters
AI configuration parameters
Workflow configuration parameters
Notification configuration parameters
Document version numeration configuration
Password validation configuration
Switch application to read-only mode
Security configuration parameters
Extensions configuration parameters
Performance configuration parameters
LibreOffice configuration parameters
CSV configuration parameters
Antivirus configuration parameters
Other configuration parameters
Experimental configuration parameters
AutoCAD configuration parameters
FTP configuration parameters
Two factor authentication configuration parameters
Multi-tenant configuration parameters
File plan
Search configuration parameters
MIME types
Statistics
Metadata
Metadata
Metadata XML definition
Metadata XML definition
Metadata fields
Metadata fields
Metadata Checkbox field
Metadata Iframe field
Metadata Script
Metadata Select field
Metadata Separator field
Metadata Suggestbox field
Metadata Text field
Metadata TextArea field
Metadata Validator element
Metadata Option element
Metadata Input field
Metadata Matrix field
Metadata VerticalPanel field
Metadata HorizontalPanel field
Metadata Security element
Metadata internationalization
Manage users and roles
Manage users and roles
Manage users
Manage users
Manage user mail accounts
Manage roles
Logged users
Message queue
Profiles
Profiles
Profile General tab
Profile Components tab
Profile Menu tab
Profile Notification tab
Profile Other tab
Relation types
CSS
Reports
Reports
Reports pack
Activity log
Automation
Automation
Built-in Automation Validator plugins
Built-in Automation Action plugins
Stamp
AI Prompt
Crontab
Crontab
Built-in crontab tasks
OCR templates
OCR templates
Built-in OCR Validation Control plugins
Built-in OCR Data Capture plugins
Languages
Languages
Language translations
How to create a new translation
Utilities
Utilities
Admin permissions
AI chat test
AI chatbot Log
Cache stats
Check email
Check text extraction
Clean conversion cache
Create support zip
Content store migration
Custom actions
Database import
Database delta sync
Database query
Download tokens
Execute JAR
Hibernate stats
JWT secret key management
LDAP Search
List indexes
LogCat
MCP Client Stats
MCP Server Stats
Missing text extractions
Model Pricing
Orphan Files
Password encryption
Plugins
Plugins
Built-in Antivirus plugins
Built-in Autocomplete Form plugins
Built-in Document Converter plugins
Built-in Dashboard Chart plugins
Built-in Field Validator plugins
Built-in Default Form Values plugins
Built-in FormInterceptor plugins
Built-in Form Validator plugins
Built-in NodePaginator plugins
Built-in NodeProperties plugins
Built-in Search plugins
Built-in Option Select plugins
Built-in Report plugins
Built-in Rest plugins
Built-in Suggestbox plugins
Built-in Suggestion Analyzer plugins
Built-in Text extractor plugins
Built-in Version Number Adapter plugins
Profiling stats
Purge data
Purge RAG Nodes
Purge trashes
RAG Chat Test
RAG Vector Store Browser
Rebuild checksums
Rebuild dashboard chart stats
Rebuild indexes
Repository encryption migration
Repository checker
Repository export
Repository import
Server plugins
Scripting
Shards
Shard Migration
Shorten URLs
System properties
Workflow
Workflow
Workflow forms definition
Workflow forms definition
Workflow fields
Workflow fields
Workflow Button field
Workflow Download field
Workflow Validator element
Workflow Node element
Workflow Upload field
Workflow Checkbox field
Workflow Input field
Workflow Select field
Workflow Separator field
Workflow Suggestbox field
Workflow Text field
Workflow TextArea field
Workflow Option element
Workflow VerticalPanel field
Workflow HorizontalPanel field
User guide
User guide
Quick start
Essential fundamentals
Plan your data organization
Working with the menu bar
Working with the toolbar
Working with desktop
Working with search
Working with Lucene queries
Working with the dashboard
User email signature
Activity log extension
AutoCAD preview extension
Digital Signature viewer extension
Document expiration extension
Extra tab workspace extension
External preview extension
External tab document extension
External tab folder extension
External tab mail extension
External tab record extension
External widget dashboard extension
HTML editor extension
Forum extension
Stamp extension
Workflow extension
Using OpenKM from external applications
Update guide
Update guide
Changelog
Updater utility
Updater utility
Updater utility english video
Updater utility spanish video
Tomcat update
Manual update
Oracle Java to Temurin
Changes from version 8.1
Development
Development
Personal development environment
Configuring IDE from a clean Eclipse
Configuring Maven in your OS
Eclipse tips
Eclipse known troubleshooting
Development tips
Profiling application
Application version compatibility table
LLM context files
Creating a JAR file with Eclipse
Creating plugins
Creating plugins
Register a new plugin
Creating your own AI prompt plugin
Creating your own Antivirus Analyzer plugin
Creating your own Automation Action
Creating your own Automation Validation
Creating your own Crontab plugin
Creating your own Autocomplete Form plugin
Creating your own Dashboard Chart plugin
Creating your own Default Form Values
Creating your own Document Converter
Creating your own Form Validator plugin
Creating your own FormInterceptor plugin
Creating your own NodePaginator plugin
Creating your own NodeProperties plugin ( customize search results objects )
Creating your own OCR Validation Control plugin
Creating your own OCR Data Capture plugin
Creating your own Option Select Values plugin
Creating your own Principal Adapter
Creating your own Report plugin
Creating your own Rest Plugin ( extending REST API )
Creating your own Search plugin
Creating your own security access manager
Creating your own Stack Metadata Adapter ( deprecated )
Creating your own Suggestion Analyzer
Creating your own Suggestbox plugin
Creating your own Text extractor
Creating your own Version Number Adapter
Creating templates
Creating templates
Creating LibreOffice templates
Creating PDF template
Creating Text templates
Creating your own login module
Creating your own parameters
Creating your own password validator
Creating your own reports
Creating your own reports
Introducing to reports based on SQL
Introducing to reports based on Java
Reports with parameters
Reports with parameters
Params form fields
Params form fields
Params fields
Params fields
Params Validator element
Params Input field
Params Suggestbox field
Params Checkbox field
Params TextArea field
Params Select field
Params Separator field
Params Text field
Database stuff
Webservices
Webservices
RESTful
RESTful
Swagger
RestClient sample
PHP Samples
Integrate preview with other web applications
Samples
Samples
Scripting samples
Scripting samples
Script - Basic samples
Script - Compact documents with size equals to 0
Script - Convert TIF to PDF
Script - Count all children subfolder
Script - Exporter
Script - Export repository folder to server as a ZIP file
Script - Folders deep
Script - Import data from CSV file
Script - Purge all folders into some parent
Script - Purge all users trashes
Script - Put documents from folder and descendants into pending text extraction queue
Script - Read PDF form fields
Script - Recursive character renaming
Script - Recursive repository traversal
Script - Recursive change security
Script - Security change at low level
Script samples for automation
Script samples for automation
Script for automation - Autonumeric
Script for automation - Set unique document name based on metadata
Crontab samples
Crontab samples
Crontab sample - Basic file system document importer
Crontab sample - Document importer with metadata values
Contab sample - Generate HTML report
Crontab task - XML importer
Variables by automation event
Vault of stuff
Vault of stuff
Convert Exchange Legacy DN
Download document with direct link
Import document with bash script using REST
Creating users from scripts
API description
API description
OKMActivity
OKMAuth
OKMBookmark
OKMDashboard
OKMDocument
OKMFolder
OKMImport
OKMMail
OKMNode
OKMNote
OKMNotification
OKMProperty
OKMPropertyGroup
OKMRecord
OKMRelation
OKMReport
OKMRepository
OKMSearch
OKMStamp
OKMStats
OKMTask
OKMUserConfig
OKMWorkflow
Commons classes
Commons classes
ArchiveUtils
AutomationUtils
ConfigSrv
DbSessionManager
ExecutionUtils
FileLogger
FileUtils
FormatUtil
GeneralUtils
ISO8601
LegacySrv
MailUtils
PathUtils
PDFUtils
PrincipalUtils
ShardUtils
StackTraceUtils
TemplateUtils
WorkflowUtils
Database description
Advanced samples
Advanced samples
Custom actions in KCenter
Custom UI template
Form UI template
Security Provider
Set unique document name based on metadata
Tab UI content extension
Tab UI content extension using KCenter methods
Select theme
Dark
Light
Auto
Select language
English
Español
Webservices
OpenKM exposes an API via Web services:
RESTful
.