Difference between revisions of "Quick Install - OpenKM 5.1"

From OpenKM Documentation
Jump to: navigation, search
(Created page with '{{TOCright}} __TOC__ In less than five minutes you can install OpenKM and run it on your own server. {{Warning|From OpenKM 5.x there's a property definition in OpenKM.cfg t…')
 
m
 
(6 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
In less than five minutes you can install OpenKM and run it on your own server.
 
In less than five minutes you can install OpenKM and run it on your own server.
  
−
{{Warning|From OpenKM 5.x there's a property definition in [[OpenKM.cfg]] to automatically create the OpenKM database. Once the tables are created, change the '''hibernate.hbm2ddl''' property from '''create''' to '''none'''. Do this after running the application for the first time. If you don't, the repository will be deleted and re-created the next time OpenKM starts.}}
+
{{Warning|From OpenKM 5.1 there's a property definition in [[OpenKM.cfg]] to automatically create the OpenKM database. Once the tables are created, change the '''hibernate.hbm2ddl''' property from '''create''' to '''none'''. Do this after running the application for the first time. If you don't, the repository will be deleted and re-created the next time OpenKM starts.}}
  
−
{{Note|Starting with OpenKM 5.0.3 we recommend to activate '''user.size.cache''' in OpenKM.cfg to experience better performance.}}
+
{{Note|Starting with OpenKM 5.1 we recommend to activate '''user.item.cache''' in Administration configuration to experience better performance.}}
  
 
== Windows ==
 
== Windows ==
Line 17: Line 17:
  
 
=== First login ===
 
=== First login ===
−
* Execute the file ''c:\jboss-4.2.3.GA\bin\run.bat'' to run OpenKM + JBoss application server.
+
* 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]])
 
* 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]])
 
* On a client browser, open the URL http://localhost:8080/OpenKM/.
 
* On a client browser, open the URL http://localhost:8080/OpenKM/.
 
* Log in to OpenKM using user "okmAdmin" with password "admin".
 
* Log in to OpenKM using user "okmAdmin" with password "admin".
 +
* Log out by using the '''File | Exit''' menu
 +
* Stop OpenKM by running the ''C:\jboss-4.2.3.GA\bin\shutdown.bat'' file
 +
* Edit the ''C:\jboss-4.2.3.GA\OpenKM.cfg'' file, changing the '''hibernate.hbm2ddl''' option from '''create''' to '''none'''
 +
* Restart OpenKM by running the ''C:\jboss-4.2.3.GA\bin\run.bat'' file
 
* Enjoy OpenKM!
 
* 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.
 
* Please take a look at http://forum.openkm.com/ if you have any problem or contract professional support at http://www.openkm.com/Contact.
Line 36: Line 40:
  
 
Execute the following command on the terminal
 
Execute the following command on the terminal
 +
 
  $ unzip OpenKM-5.x_JBoss-4.2.3.GA.zip
 
  $ unzip OpenKM-5.x_JBoss-4.2.3.GA.zip
  
Line 45: Line 50:
 
* On a client browser, open the URL http://localhost:8080/OpenKM/.
 
* On a client browser, open the URL http://localhost:8080/OpenKM/.
 
* Log in to OpenKM using user "okmAdmin" with password "admin".
 
* Log in to OpenKM using user "okmAdmin" with password "admin".
 +
* Log out by using the '''File | Exit''' menu
 +
* Stop OpenKM by running the ''/opt/jboss-4.2.3.GA/bin/shutdown.sh'' file
 +
* Edit the ''/opt/jboss-4.2.3.GA/OpenKM.cfg'' file, changing the '''hibernate.hbm2ddl''' option from '''create''' to '''none'''
 +
* Restart OpenKM by running the ''/opt/jboss-4.2.3.GA/bin/run.sh'' file
 
* Enjoy OpenKM!
 
* 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.
 
* 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 OS X ==
 
== Mac OS X ==
−
'''You dont need to install Java for OS X...''' Java is installed by default and shipped with every OS X. The only important thing is to update your version of Java to the latest, through OS X System Software update. This is to ensure you have the latest Java version, especially for OS X 10.6.6 & above, which makes your version of Java(SE) capable of 32bit & 64bit.
+
'''You don't need to install Java for OS X...''' Java is installed by default and shipped with every OS X. The only important thing is to update your version of Java to the latest, through OS X System Software update. This is to ensure you have the latest Java version, especially for OS X 10.6.6 & above, which makes your version of Java(SE) capable of 32bit & 64bit.
  
−
Note: Don't go to the Java or Oracle website to acquire Java. Apple supplies and maintains Java for OS X. This is true as of java 1.6 though this practice might change with Java 1.7. Because Apple maintains their own Java, every Java application in OS X looks and performs like a native cocoa application.
+
Note: Don't go to the Java or Oracle website to acquire Java. Apple supplies and maintains Java for OS X. This is true as of Java 1.6 though this practice might change with Java 1.7. Because Apple maintains their own Java, every Java application in OS X looks and performs like a native cocoa application.
  
 
=== JDK 1.6 for Mac OS X? ===
 
=== JDK 1.6 for Mac OS X? ===
Line 63: Line 71:
  
 
Execute the following 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.'''
 
Execute the following 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.x_JBoss-4.2.3.GA.zip
 
  $ unzip OpenKM-5.x_JBoss-4.2.3.GA.zip
  
Line 72: Line 81:
 
* On a client browser, open the URL http://localhost:8080/OpenKM/.
 
* On a client browser, open the URL http://localhost:8080/OpenKM/.
 
* Log in to OpenKM using user "okmAdmin" with password "admin".
 
* Log in to OpenKM using user "okmAdmin" with password "admin".
 +
* Log out by using the '''File | Exit''' menu
 +
* Stop OpenKM by running the ''/Library/jboss-4.2.3.GA/bin/shutdown.sh'' file
 +
* Edit the ''/Library/jboss-4.2.3.GA/OpenKM.cfg'' file, changing the '''hibernate.hbm2ddl''' option from '''create''' to '''none'''
 +
* Restart OpenKM by running the ''/Library/jboss-4.2.3.GA/bin/run.sh'' file
 
* Enjoy OpenKM!
 
* 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.
 
* Please take a look at http://forum.openkm.com/ if you have any problem or contact professional support at http://www.openkm.com/Contact.
  
 
[[Category: Quick Install]]
 
[[Category: Quick Install]]

Latest revision as of 19:52, 1 December 2012

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


Nota advertencia.png From OpenKM 5.1 there's a property definition in OpenKM.cfg to automatically create the OpenKM database. Once the tables are created, change the hibernate.hbm2ddl property from create to none. Do this after running the application for the first time. If you don't, the repository will be deleted and re-created the next time OpenKM starts.


Nota clasica.png Starting with OpenKM 5.1 we recommend to activate user.item.cache in Administration configuration to experience better performance.

Windows

Install Java JDK 1.6

Go to the Oracle Java download site and select to download the Java Developer Kit (JDK) 6, latest update. The url is http://www.oracle.com/technetwork/java/javase/downloads/index.html (Note that the url or version number may change as time goes by). When the file has been downloaded, execute it to install Java on your system using the setup wizard.

Install OpenKM

Download the OpenKM 5.x + JBoss 4.2.3.GA bundle and uncompress on your file system disk (a good option is to uncompress on C:\). If you experience problems uncompressing OpenKM-5.x_JBoss-4.2.3.GA.zip, try using the WinRAR application to uncompress it.


Nota idea.png Once installed, please read Basic application knowledge and User Guide to familiarize yourself with OpenKM, Application configuration for configuration details, or Administration Guide to become an OpenKM power administator. If you have any problem, take a look at the 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)
  • On a client browser, open the URL http://localhost:8080/OpenKM/.
  • Log in to OpenKM using user "okmAdmin" with password "admin".
  • Log out by using the File | Exit menu
  • Stop OpenKM by running the C:\jboss-4.2.3.GA\bin\shutdown.bat file
  • Edit the C:\jboss-4.2.3.GA\OpenKM.cfg file, changing the hibernate.hbm2ddl option from create to none
  • Restart OpenKM by running the C:\jboss-4.2.3.GA\bin\run.bat file
  • 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. These steps were used to install on Ubuntu but can be used for any other Linux flavor.

Install Java JDK 1.6

Execute the following command on the terminal 

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

Install OpenKM

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

Execute the following command on the terminal 

$ unzip OpenKM-5.x_JBoss-4.2.3.GA.zip

Nota idea.png Once installed, please read Basic application knowledge and User Guide to familiarize yourself 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 the 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)
  • On a client browser, open the URL http://localhost:8080/OpenKM/.
  • Log in to OpenKM using user "okmAdmin" with password "admin".
  • Log out by using the File | Exit menu
  • Stop OpenKM by running the /opt/jboss-4.2.3.GA/bin/shutdown.sh file
  • Edit the /opt/jboss-4.2.3.GA/OpenKM.cfg file, changing the hibernate.hbm2ddl option from create to none
  • Restart OpenKM by running the /opt/jboss-4.2.3.GA/bin/run.sh file
  • 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 OS X

You don't need to install Java for OS X... Java is installed by default and shipped with every OS X. The only important thing is to update your version of Java to the latest, through OS X System Software update. This is to ensure you have the latest Java version, especially for OS X 10.6.6 & above, which makes your version of Java(SE) capable of 32bit & 64bit.

Note: Don't go to the Java or Oracle website to acquire Java. Apple supplies and maintains Java for OS X. This is true as of Java 1.6 though this practice might change with Java 1.7. Because Apple maintains their own Java, every Java application in OS X looks and performs like a native cocoa application.

JDK 1.6 for Mac OS X?

The whole JDK (JRE,JVM, Class Libraries, Development tools such as compiler) are built into every OS X, thus making installation of OpenKM the easiest of all 3 (Win,Linux,MacOS X) platforms - No need to install Java from any website. Just extract & run your OpenKM installation.

Install OpenKM

Download the OpenKM 5.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 OS X GUI, open a new finder window and browse your Macintosh HD, Locate and move/copy OpenKM 5.x + JBoss 4.2.3.GA inside the Library folder.

In OS X, open the Terminal application by browsing through Finder and navigate to Applications/Utilities folder and double click Terminal application.

Execute the following 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.x_JBoss-4.2.3.GA.zip

Nota idea.png Once installed, please read Basic application knowledge and User Guide to familiarize yourself 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 the 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)
  • On a client browser, open the URL http://localhost:8080/OpenKM/.
  • Log in to OpenKM using user "okmAdmin" with password "admin".
  • Log out by using the File | Exit menu
  • Stop OpenKM by running the /Library/jboss-4.2.3.GA/bin/shutdown.sh file
  • Edit the /Library/jboss-4.2.3.GA/OpenKM.cfg file, changing the hibernate.hbm2ddl option from create to none
  • Restart OpenKM by running the /Library/jboss-4.2.3.GA/bin/run.sh file
  • 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.
Retrieved from "https://www.openkm.com/wiki/index.php?title=Quick_Install_-_OpenKM_5.1&oldid=8136"