Difference between revisions of "Installation Guide"

From OpenKM Documentation
Jump to: navigation, search
 
(22 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 17: Line 20:
 
** [[Download OpenKM]]
 
** [[Download OpenKM]]
 
** [[OpenKM configuration]]
 
** [[OpenKM configuration]]
*** [[Tomcat mail configuration]]
 
*** [[jBPM3 mail configuration]]
 
 
*** [[Application configuration]]
 
*** [[Application configuration]]
 
** [[Configure Tomcat service]]  
 
** [[Configure Tomcat service]]  
Line 27: Line 28:
 
** [[Change default okmAdmin password]]
 
** [[Change default okmAdmin password]]
 
** [[Administring users]]
 
** [[Administring users]]
** [[Create password validator]]  
+
* [[Troubleshooting]]
 +
* [[Error codes]]
 
|}
 
|}
 
</div>  
 
</div>  
Line 40: Line 42:
 
*** [[MySQL - OpenKM 5.0 | OpenKM 5.0]]
 
*** [[MySQL - OpenKM 5.0 | OpenKM 5.0]]
 
*** [[MySQL - OpenKM 4.1 | OpenKM 4.1]]
 
*** [[MySQL - OpenKM 4.1 | OpenKM 4.1]]
 +
*** [[MySQL Tunning]]
 
** [[PostgreSQL]]  
 
** [[PostgreSQL]]  
 
*** [[PostgreSQL - OpenKM 6.2 | OpenKM 6.2]]  
 
*** [[PostgreSQL - OpenKM 6.2 | OpenKM 6.2]]  
 
*** [[PostgreSQL - OpenKM 5.0 | OpenKM 5.0]]  
 
*** [[PostgreSQL - OpenKM 5.0 | OpenKM 5.0]]  
 
*** [[PostgreSQL - OpenKM 4.1 | OpenKM 4.1]]  
 
*** [[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]]
 
** [[Other DBMS]]
 
|}
 
|}
Line 59: Line 66:
 
|}
 
|}
 
</div>
 
</div>
 
 
  
  
 
|-
 
|-
| width="33%" valign="top" class="openkm_hubbox" | <div class="openkm_hubtitle">'''Basic steps'''</div> <div class="openkm_boxcontents">
+
| width="33%" valign="top" class="openkm_hubbox" | <div class="openkm_hubtitle">'''Security'''</div> <div class="openkm_boxcontents">
 
{| cellpadding="3" style="margin: 0pt;"
 
{| cellpadding="3" style="margin: 0pt;"
 
|-
 
|-
 
| valign="top" | [[Image:User.png]]<br>  
 
| valign="top" | [[Image:User.png]]<br>  
 
|  
 
|  
* [[Software and hardware requirements]]
+
* [[OpenKM authentication]]
* [[OpenKM installation]]
+
** [[Active Directory]]  
** [[Java installation]]
+
*** [[Active Directory - OpenKM 6.2| OpenKM 6.2]]  
** [[Download OpenKM]]
+
*** [[Active Directory - OpenKM 5.1| OpenKM 5.1]]
** [[OpenKM configuration]]
+
*** [[Active Directory - OpenKM 5.0| OpenKM 5.0]]
*** [[Tomcat mail configuration]]
+
*** [[Active Directory - OpenKM 4.1| OpenKM 4.1]]
*** [[jBPM3 mail configuration]]
+
** [[Open Directory]]
*** [[Application configuration]]
+
** [[ClearOS LDAP]]
** [[Configure Tomcat service]]  
+
** [[LDAP examples]]
*** [[Tomcat native libraries]]  
+
** [[Kerberos]]
*** [[Several Tomcats in the same server]]  
+
** [[Central Authentication Service - OpenKM 6.2|Central Authentication Service (CAS)]]
*** [[Change Tomcat timezone]]
 
** [[Test OpenKM installation]]
 
** [[Change default okmAdmin password]]
 
** [[Administring users]]
 
 
** [[Create password validator]]  
 
** [[Create password validator]]  
 
|}
 
|}
 
</div>  
 
</div>  
| width="33%" valign="top" class="openkm_hubbox" | <div class="openkm_hubtitle">'''Database'''</div> <div class="openkm_boxcontents">
+
| width="33%" valign="top" class="openkm_hubbox" | <div class="openkm_hubtitle">'''Mail'''</div> <div class="openkm_boxcontents">
 
{| cellpadding="3" style="margin: 0pt;"
 
{| cellpadding="3" style="margin: 0pt;"
 
|-
 
|-
 
| valign="top" | [[Image:User.png]]<br>  
 
| valign="top" | [[Image:User.png]]<br>  
 
|
 
|
* [[Using OpenKM with other databases]]
+
* [[Tomcat mail configuration]]
** [[MySQL]]
+
* [[Notification and subscription messages]]
*** [[MySQL - OpenKM 6.2 | OpenKM 6.2]]
+
* [[jBPM3 mail configuration]]
*** [[MySQL - OpenKM 5.0 | OpenKM 5.0]]
 
*** [[MySQL - OpenKM 4.1 | OpenKM 4.1]]
 
** [[PostgreSQL]]
 
*** [[PostgreSQL - OpenKM 6.2 | OpenKM 6.2]]
 
*** [[PostgreSQL - OpenKM 5.0 | OpenKM 5.0]]
 
*** [[PostgreSQL - OpenKM 4.1 | OpenKM 4.1]]
 
** [[Other DBMS]]
 
 
|}
 
|}
 
</div>  
 
</div>  
| width="33%" valign="top" class="openkm_hubbox" | <div class="openkm_hubtitle">'''Previsualization'''</div> <div class="openkm_boxcontents_small">
+
| width="33%" valign="top" class="openkm_hubbox" | <div class="openkm_hubtitle">'''Third-party software'''</div> <div class="openkm_boxcontents_small">
 
{| cellpadding="3" style="margin: 0pt;"
 
{| cellpadding="3" style="margin: 0pt;"
 
|-
 
|-
 
| valign="top" | [[Image:User.png]]  
 
| valign="top" | [[Image:User.png]]  
 
|  
 
|  
* [[Previsualization]]
 
** [[OpenOffice.org]]
 
** [[SWFTools]]
 
** [[Antivirus]]
 
** [[Acme CAD Converter]]
 
|}
 
</div>
 
 
 
 
|}
 
 
 
 
 
 
== OpenKM 6.2 ==
 
 
 
* [[Notification and subscription messages]]
 
* [[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]]
 
** [[LDAP and Active Directory user examples]]
 
* [[Repository configuration]]
 
* [[Indexing configuration]]
 
 
* [[Third-party software integration]]
 
* [[Third-party software integration]]
** [[Apache]]  
+
** [[Apache]]
 
*** [[Third-party_software_integration:_Apache_SSL_and_more|Apache SSL and more]]
 
*** [[Third-party_software_integration:_Apache_SSL_and_more|Apache SSL and more]]
 
*** [[Open SSL]]
 
*** [[Open SSL]]
 +
** [[Nginx]]
 
** [[OCR]]
 
** [[OCR]]
 
*** [[Tesseract]]
 
*** [[Tesseract]]
 
*** [[Cuneiform]]
 
*** [[Cuneiform]]
 +
|}
 +
</div>
  
* [[Repository backup]]
+
 
** [[Backup scripts]]
+
|-
** [[Backup restoring]]
+
| width="33%" valign="top" class="openkm_hubbox" | <div class="openkm_hubtitle">'''General'''</div> <div class="openkm_boxcontents">
** [[Disaster recovering]]
+
{| cellpadding="3" style="margin: 0pt;"
* [[Repository mirroring]]
+
|-
 +
| valign="top" | [[Image:User.png]]<br>
 +
|
 
* [[WebDAV access]]
 
* [[WebDAV access]]
 
* [[Property Groups]]
 
* [[Property Groups]]
Line 159: Line 128:
 
** [[Creating OpenOffice templates|OpenOffice]]
 
** [[Creating OpenOffice templates|OpenOffice]]
 
** [[Creating Text templates|Text]]  
 
** [[Creating Text templates|Text]]  
* [[Troubleshooting]]
+
|}
* [[Error codes]]
+
</div>
 
+
| width="33%" valign="top" class="openkm_hubbox" | <div class="openkm_hubtitle">'''Backup'''</div> <div class="openkm_boxcontents">
 
+
{| cellpadding="3" style="margin: 0pt;"
 
+
|-
 
+
| valign="top" | [[Image:User.png]]<br>
 
+
|
 
+
* [[Repository backup]]
 
+
** [[Backup scripts]]
 +
** [[Backup restoring]]  
 +
** [[Disaster recovering]]
 +
|}
 +
</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 175: Line 155:
 
* [[Community extensions]]
 
* [[Community extensions]]
 
* [[Enable automation]]
 
* [[Enable automation]]
 +
|}
 +
</div>
 +
 +
 +
|}
  
 
== OpenKM 5.1 and older ==
 
== OpenKM 5.1 and older ==
Line 188: Line 173:
 
* [[Test OpenKM installation with JBoss]]
 
* [[Test OpenKM installation with JBoss]]
 
* [[OpenKM JBoss Authentication]]
 
* [[OpenKM JBoss Authentication]]
* [[Central Authentication Service]]
+
* [[Repository configuration]]
 +
* [[Central Authentication Service - OpenKM 5.1|Central Authentication Service]]
 
* [[Experimental features]]
 
* [[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
Database
Previsualization


Security
Mail
Third-party software


General
Backup
Advanced configuration


OpenKM 5.1 and older