Difference between revisions of "Installation Guide"

From OpenKM Documentation
Jump to: navigation, search
 
(54 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
OpenKM allows for centralizing all the company's information in a single access point, guarantying the security of the data. In this way, only authorized users can have access to specific data. At the same time, it provides a complete audit service. OpenKM is a Web 2.0 application that works with Internet Explorer, Firefox, Safari and Opera. In addition, periodic backups avoid information losses.
+
<div style="padding: 1em; border: 2px solid #01456f; background-color: #FFFAF0; border-radius: 20px; -moz-border-radius: 20px; vertical-align: top;">
 +
<div style="text-align: center; font-size: 175%; border: 1px solid #01456f; padding: 0.5em; margin-bottom: 5px; background-color: #008fcb; border-radius: 10px; -moz-border-radius: 10px; color:white;">'''Installation guide'''</div>
 +
 
 +
OpenKM allows for centralizing all the company's information in a single access point, guaranteeing the security of the data. In this way, only authorized users can access specific data. At the same time, it provides a complete audit service. OpenKM is a Web 2.0 application that works with Internet Explorer, Firefox, Safari and Opera. In addition, periodic backups avoid information losses.
  
 
This new version entails the following improvements: workflow (jBPM), a dashboard with information on the repository activities, push services (queries programmed by the user), support for WebDAV, download documents converted to PDF, information on the repository space used by the user, preview of videos and images, web administration, new languages, and the insertion of any document format (configurable), as well as the possibility of a default language.
 
This new version entails the following improvements: workflow (jBPM), a dashboard with information on the repository activities, push services (queries programmed by the user), support for WebDAV, download documents converted to PDF, information on the repository space used by the user, preview of videos and images, web administration, new languages, and the insertion of any document format (configurable), as well as the possibility of a default language.
Line 5: Line 8:
 
However, one of the most relevant functions to mention is the indexing of the most common types of files: text, Office, Office 2007, OpenOffice, PDF, HTML, XML, MP3, JPEG, etc. Its powerful search engine indexes all documents making it easy to find any information.
 
However, one of the most relevant functions to mention is the indexing of the most common types of files: text, Office, Office 2007, OpenOffice, PDF, HTML, XML, MP3, JPEG, etc. Its powerful search engine indexes all documents making it easy to find any information.
  
 +
{| width="100%" cellspacing="10" align="center" class="openkm_table"
 +
|-
 +
| width="33%" valign="top" class="openkm_hubbox" | <div class="openkm_hubtitle">'''Basic steps'''</div> <div class="openkm_boxcontents">
 +
{| cellpadding="3" style="margin: 0pt;"
 +
|-
 +
| valign="top" | [[Image:User.png]]<br>
 +
|
 
* [[Software and hardware requirements]]
 
* [[Software and hardware requirements]]
 
* [[OpenKM installation]]
 
* [[OpenKM installation]]
Line 10: Line 20:
 
** [[Download OpenKM]]
 
** [[Download OpenKM]]
 
** [[OpenKM configuration]]
 
** [[OpenKM configuration]]
−
*** [[Tomcat mail configuration]]
 
−
*** [[jBPM configuration]]
 
 
*** [[Application configuration]]
 
*** [[Application configuration]]
−
** [[Configure Tomcat service]] [[File:Padlock.gif]]
+
** [[Configure Tomcat service]]  
−
*** [[Tomcat native libraries]] [[File:Padlock.gif]]
+
*** [[Tomcat native libraries]]  
−
*** [[Several Tomcats in the same server]] [[File:Padlock.gif]]
+
*** [[Several Tomcats in the same server]]  
−
** [[Changing OpenKM timeout session]]
+
*** [[Change Tomcat timezone]]
 
** [[Test OpenKM installation]]
 
** [[Test OpenKM installation]]
 
** [[Change default okmAdmin password]]
 
** [[Change default okmAdmin password]]
 
** [[Administring users]]
 
** [[Administring users]]
−
** [[Create password validator]] [[File:Padlock.gif]]
+
* [[Troubleshooting]]
 +
* [[Error codes]]
 +
|}
 +
</div>
 +
| width="33%" valign="top" class="openkm_hubbox" | <div class="openkm_hubtitle">'''Database'''</div> <div class="openkm_boxcontents">
 +
{| cellpadding="3" style="margin: 0pt;"
 +
|-
 +
| valign="top" | [[Image:User.png]]<br>
 +
|
 +
* [[Using OpenKM with other databases]]
 +
** [[MySQL]]
 +
*** [[MySQL - OpenKM 6.2 | OpenKM 6.2]]
 +
*** [[MySQL - OpenKM 5.0 | OpenKM 5.0]]
 +
*** [[MySQL - OpenKM 4.1 | OpenKM 4.1]]
 +
*** [[MySQL Tunning]]
 +
** [[PostgreSQL]]
 +
*** [[PostgreSQL - OpenKM 6.2 | OpenKM 6.2]]
 +
*** [[PostgreSQL - OpenKM 5.0 | OpenKM 5.0]]
 +
*** [[PostgreSQL - OpenKM 4.1 | OpenKM 4.1]]
 +
** [[SQL Server]]
 +
*** [[SQL Server - OpenKM 6.2 | OpenKM 6.2]]
 +
*** [[SQL Server - OpenKM 5.0 | OpenKM 5.0]]
 +
 
 +
** [[Other DBMS]]
 +
|}
 +
</div>
 +
| width="33%" valign="top" class="openkm_hubbox" | <div class="openkm_hubtitle">'''Previsualization'''</div> <div class="openkm_boxcontents_small">
 +
{| cellpadding="3" style="margin: 0pt;"
 +
|-
 +
| valign="top" | [[Image:User.png]]  
 +
|
 
* [[Previsualization]]
 
* [[Previsualization]]
 +
** [[OpenOffice.org]]
 +
** [[SWFTools]]
 +
** [[Antivirus]]
 +
** [[Acme CAD Converter]]
 +
|}
 +
</div>
 +
 +
 +
|-
 +
| width="33%" valign="top" class="openkm_hubbox" | <div class="openkm_hubtitle">'''Security'''</div> <div class="openkm_boxcontents">
 +
{| cellpadding="3" style="margin: 0pt;"
 +
|-
 +
| valign="top" | [[Image:User.png]]<br>
 +
|
 +
* [[OpenKM authentication]]
 +
** [[Active Directory]]
 +
*** [[Active Directory - OpenKM 6.2| OpenKM 6.2]]
 +
*** [[Active Directory - OpenKM 5.1| OpenKM 5.1]]
 +
*** [[Active Directory - OpenKM 5.0| OpenKM 5.0]]
 +
*** [[Active Directory - OpenKM 4.1| OpenKM 4.1]]
 +
** [[Open Directory]]
 +
** [[ClearOS LDAP]]
 +
** [[LDAP examples]]
 +
** [[Kerberos]]
 +
** [[Central Authentication Service - OpenKM 6.2|Central Authentication Service (CAS)]]
 +
** [[Create password validator]]
 +
|}
 +
</div>
 +
| width="33%" valign="top" class="openkm_hubbox" | <div class="openkm_hubtitle">'''Mail'''</div> <div class="openkm_boxcontents">
 +
{| cellpadding="3" style="margin: 0pt;"
 +
|-
 +
| valign="top" | [[Image:User.png]]<br>
 +
|
 +
* [[Tomcat mail configuration]]
 
* [[Notification and subscription messages]]
 
* [[Notification and subscription messages]]
−
* [[OpenKM authentication]] [[File:Padlock.gif]]
+
* [[jBPM3 mail configuration]]
−
** [[Active Directory]] [[File:Padlock.gif]]
+
|}
−
*** [[Active Directory OpenKM 6.2| OpenKM 6.2]] [[File:Padlock.gif]]
+
</div>
−
*** [[Active Directory OpenKM 5.1| OpenKM 5.1]] [[File:Padlock.gif]]
+
| width="33%" valign="top" class="openkm_hubbox" | <div class="openkm_hubtitle">'''Third-party software'''</div> <div class="openkm_boxcontents_small">
−
*** [[Active Directory OpenKM 5.0| OpenKM 5.0]] [[File:Padlock.gif]]
+
{| cellpadding="3" style="margin: 0pt;"
−
*** [[Active Directory OpenKM 4.1| OpenKM 4.1]]
+
|-
−
** [[Open Directory]] [[File:Padlock.gif]]
+
| valign="top" | [[Image:User.png]]  
−
** [[Central Authentication Service]]
+
|
−
** [[LDAP and Active Directory user examples]]
 
−
* [[Repository configuration]]
 
−
* [[Indexing configuration]] [[File:Padlock.gif]]
 
 
* [[Third-party software integration]]
 
* [[Third-party software integration]]
−
** [[Apache]]  
+
** [[Apache]]
−
*** [[Third-party_software_integration:_Apache_SSL_and_more|Apache SSL and more]] [[File:Padlock.gif]]
+
*** [[Third-party_software_integration:_Apache_SSL_and_more|Apache SSL and more]]
 +
*** [[Open SSL]]
 +
** [[Nginx]]
 
** [[OCR]]
 
** [[OCR]]
 
*** [[Tesseract]]
 
*** [[Tesseract]]
 
*** [[Cuneiform]]
 
*** [[Cuneiform]]
−
** [[OpenOffice.org]]
+
|}
−
** [[SWFTools]]
+
</div>
−
** [[Antivirus]]
+
 
−
** [[Acme CAD Converter]]
+
 
−
* [[Repository backup]]
+
|-
−
** [[Backup scripts]] [[File:Padlock.gif]]
+
| width="33%" valign="top" class="openkm_hubbox" | <div class="openkm_hubtitle">'''General'''</div> <div class="openkm_boxcontents">
−
** [[Backup restoring]] [[File:Padlock.gif]]
+
{| cellpadding="3" style="margin: 0pt;"
−
** [[Disaster recovering]] [[File:Padlock.gif]]
+
|-
−
* [[Repository mirroring]] [[File:Padlock.gif]]
+
| valign="top" | [[Image:User.png]]<br>
 +
|
 
* [[WebDAV access]]
 
* [[WebDAV access]]
 
* [[Property Groups]]
 
* [[Property Groups]]
 
* [[Property Groups definition]]
 
* [[Property Groups definition]]
 
* [[Creating templates]]
 
* [[Creating templates]]
−
** [[Creating PDF templates|PDF]] [[File:Padlock.gif]]
+
** [[Creating PDF templates|PDF]]  
−
** [[Creating OpenOffice templates|OpenOffice]] [[File:Padlock.gif]]
+
** [[Creating OpenOffice templates|OpenOffice]]
−
** [[Creating Text templates|Text]] [[File:Padlock.gif]]
+
** [[Creating Text templates|Text]]  
−
* [[Troubleshooting]]
+
|}
−
* [[Error codes]]
+
</div>
−
* [[Using OpenKM with other databases]]
+
| width="33%" valign="top" class="openkm_hubbox" | <div class="openkm_hubtitle">'''Backup'''</div> <div class="openkm_boxcontents">
−
** [[MySQL]]
+
{| cellpadding="3" style="margin: 0pt;"
−
*** [[MySQL-OpenKM 6.2 | OpenKM 6.2]]
+
|-
−
*** [[MySQL-OpenKM 5.0 | OpenKM 5.0]]
+
| valign="top" | [[Image:User.png]]<br>
−
*** [[MySQL-OpenKM 4.1 | OpenKM 4.1]]
+
|
−
** [[PostgreSQL]] [[File:Padlock.gif]]
+
* [[Repository backup]]
−
*** [[PostgreSQL-OpenKM 6.2 | OpenKM 6.2]] [[File:Padlock.gif]]  
+
** [[Backup scripts]]  
−
*** [[PostgreSQL-OpenKM 5.0 | OpenKM 5.0]] [[File:Padlock.gif]]
+
** [[Backup restoring]]  
−
*** [[PostgreSQL-OpenKM 4.1 | OpenKM 4.1]] [[File:Padlock.gif]]
+
** [[Disaster recovering]]
−
** [[Other DBMS]]
+
|}
 +
</div>
 +
| width="33%" valign="top" class="openkm_hubbox" | <div class="openkm_hubtitle">'''Advanced configuration'''</div> <div class="openkm_boxcontents_small">
 +
{| cellpadding="3" style="margin: 0pt;"
 +
|-
 +
| valign="top" | [[Image:User.png]]  
 +
|  
 +
* [[Indexing configuration]]  
 +
* [[Repository mirroring]]
 
* [[Thesaurus]]
 
* [[Thesaurus]]
 
** [[Thesaurus full example]]
 
** [[Thesaurus full example]]
Line 73: Line 153:
 
** [[Automatic key extraction full example]]
 
** [[Automatic key extraction full example]]
 
** [[Creating automatic key extraction training files]]
 
** [[Creating automatic key extraction training files]]
−
* [[Experimental features]]
 
 
* [[Community extensions]]
 
* [[Community extensions]]
 +
* [[Enable automation]]
 +
|}
 +
</div>
 +
 +
 +
|}
  
−
== OpenKM 5.x and older ==
+
== OpenKM 5.1 and older ==
 +
* [[Basic application knowledge with JBoss]]
 +
** [[Changing OpenKM timeout session]]
 
* [[JBoss mail configuration]]
 
* [[JBoss mail configuration]]
 
* [[Configure JBoss service]]
 
* [[Configure JBoss service]]
Line 83: Line 170:
 
** [[Securing JBoss]]
 
** [[Securing JBoss]]
 
** [[Adding APR to JBoss]]
 
** [[Adding APR to JBoss]]
−
** [[Debugging OpenKM with jboss]]
+
** [[Debugging OpenKM with JBoss]]
−
* [[Test OpenKM installation with jboss]]
+
* [[Test OpenKM installation with JBoss]]
−
* [[OpenKM jboss Authentication]]
+
* [[OpenKM JBoss Authentication]]
 +
* [[Repository configuration]]
 +
* [[Central Authentication Service - OpenKM 5.1|Central Authentication Service]]
 +
* [[Experimental features]]
 +
* [[LDAP and Active Directory user examples]]
 +
 
 
[[Category: Installation Guide]]
 
[[Category: Installation Guide]]

Latest revision as of 20:34, 14 November 2013

Installation guide

OpenKM allows for centralizing all the company's information in a single access point, guaranteeing the security of the data. In this way, only authorized users can access specific data. At the same time, it provides a complete audit service. OpenKM is a Web 2.0 application that works with Internet Explorer, Firefox, Safari and Opera. In addition, periodic backups avoid information losses.

This new version entails the following improvements: workflow (jBPM), a dashboard with information on the repository activities, push services (queries programmed by the user), support for WebDAV, download documents converted to PDF, information on the repository space used by the user, preview of videos and images, web administration, new languages, and the insertion of any document format (configurable), as well as the possibility of a default language.

However, one of the most relevant functions to mention is the indexing of the most common types of files: text, Office, Office 2007, OpenOffice, PDF, HTML, XML, MP3, JPEG, etc. Its powerful search engine indexes all documents making it easy to find any information.

Basic steps
User.png
Database
User.png
Previsualization
User.png


Security
User.png
Mail
User.png
Third-party software
User.png


General
User.png
Backup
User.png
Advanced configuration
User.png


OpenKM 5.1 and older

Retrieved from "https://www.openkm.com/wiki/index.php?title=Installation_Guide&oldid=10904"