Quick Install

In less than five minutes you can install OpenKM and run on your own server.

From OpenKM 5.x there's a property definition in OpenKM.cfg to create automatically database. Once the tables are created, change the hibernate.hbm2ddl property from create to none. Do it after first time running, in other case all repository it'll be deleted and created in next OpenKM starting.

Starting with OpenKM 5.0.3 we recommend to activate user.size.cache in OpenKM.cfg to experience a better performance.

Windows

Install Java JDK 1.6

Go to the Sun download site and select the Java Developer Kit (JDK) 6 Update 18. The url is http://java.sun.com/javase/downloads/index.jsp (note this url or version number could be changed since the moment we insert in this wiki). When file has been downloaded, execute it and you’ll install Java on your system with the application wizard.

Install OpenKM

Download OpenKM 5.0.x + JBoss 4.2.3.GA bundle and uncompress on your file system disk (a good option is to uncompress on c:\). If you experiment some problems uncompressing OpenKM-5.0.x-JBoss-4.2.3.GA.zip, try to install WinRAR application to uncompress it.

Once installed, please read Basic application knowledge and User Guide to familiarize with OpenKM, Application configuration for configuration details, or Administration Guide to become a OpenKM power administator. If you have any problem, take a look at Troubleshooting section.

First login

• Execute the file c:\jboss-4.2.3.GA\bin\run.bat to run OpenKM + JBoss application server.
• If you want your OpenKM installation to be accessed from other computers add the -b 0.0.0.0 command line parameter (see Basic application knowledge)
• Open on a client browser the URL http://localhost:8080/OpenKM/.
• Autenticate to OpenKM using user "okmAdmin" with password "admin".
• Enjoy OpenKM!
• Please take a look at http://forum.openkm.com/ if you have any problem or contract professional support at http://www.openkm.com/Contact.

Linux

There’re several ways to install it, we use to install in Ubuntu but can be used any other Linux flavor.

Install Java JDK 1.6

Execute on terminal the command

$ sudo aptitude install sun-java6-bin sun-java6-jdk sun-java6-jre

Install OpenKM

Download OpenKM 5.0.x + JBoss 4.2.3.GA bundle and uncompress on your file system disk (a good option is to uncompress under /opt/).

Execute on terminal the command

$ unzip OpenKM-5.0.x-JBoss-4.2.3.GA.zip

Once installed, please read Basic application knowledge and User Guide to familiarize with OpenKM, Application configuration for configuration details, or Administration Guide to become a OpenKM power administator. If you have any problem, take a look at Troubleshooting section.

First login

• Execute the file /opt/jboss-4.2.3.GA/bin/run.sh to run OpenKM + JBoss application server.
• If you want your OpenKM installation to be accessed from other computers add the -b 0.0.0.0 command line parameter (see Basic application knowledge)
• Open on a client browser the URL http://localhost:8080/OpenKM/.
• Autenticate to OpenKM using user "okmAdmin" with password "admin".
• Enjoy OpenKM!
• Please take a look at http://forum.openkm.com/ if you have any problem or contract professional support at http://www.openkm.com/Contact.

Mac OSX

You dont need to install Java for OSX... Java is installed by default and shipped in every OSX. The only important thing is you update your version of Java to the latest, through OSX System Software update, this is to ensure you got the latest Java version, specially in OSX 10.6.6 & above, which make your version of Java(SE) capable of 32bit & 64bit.

Note: Don't attempt to go to Java or Sun website to acquire java. Apple Supplies and maintain Java for OSX... this is true as of java 1.6 though this practice might change once java 1.7 came out, Bec. Apple maintain their own java... every Java application in OSX looks and perform like native cocoa application.

JDK 1.6 for Mac OSX?

The whole JDK (JRE,JVM, Class Libraries, Development tools such as compiler) are built in to every OSX, thus making installation of OpenKM the easiest of all 3(Win,Linux,MacOSX) Platform - No need to install Java from any website, Extract & Run your OpenKM installation.

Install OpenKM

Download OpenKM 5.0.x + JBoss 4.2.3.GA bundle and uncompress on your file system disk (a good option is to uncompress under /Library) or alternatively copy, move by OSX GUI, open a new finder window and browse your Macintosh HD, Locate and move/copy OpenKM 5.0.x + JBoss 4.2.3.GA inside the Library folder.

In OSX, Open Terminal application by browsing through Finder and navigate to Applications/Utilities folder and double click Terminal application.

Execute the command on the terminal OR alternatively, just double click the zip file you have copied/moved in the finder and it will extract itself! Same result and no need to type or use Terminal commands.

$ unzip OpenKM-5.0.x-JBoss-4.2.3.GA.zip

Once installed, please read Basic application knowledge and User Guide to familiarize with OpenKM, Application configuration for configuration details, or Administration Guide to become a OpenKM power administrator. If you have any problem, take a look at Troubleshooting section.

First login

• Execute the file /Library/jboss-4.2.3.GA/bin/run.sh to run OpenKM + JBoss application server.
• If you want your OpenKM installation to be accessed from other computers add the -b 0.0.0.0 as command line parameter Ex. run.sh -b 0.0.0.0 (see Basic application knowledge)
• Open on a client browser and enter http://localhost:8080/OpenKM/ .
• Autenticate to OpenKM using user "okmAdmin" with password "admin".
• Enjoy OpenKM!
• Please take a look at http://forum.openkm.com/ if you have any problem or contact professional support at http://www.openkm.com/Contact.