Difference between revisions of "Quick Start Guide"

From OpenKM Documentation
Jump to: navigation, search
(Created page with 'In this document you will learn basic OpenKM usage. For a more detailed information, please read the User Guide.')
 
(→‎Access OpenKM from other computers)
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
{{TOCright}} __TOC__
 +
 
In this document you will learn basic OpenKM usage. For a more detailed information, please read the [[User Guide]].
 
In this document you will learn basic OpenKM usage. For a more detailed information, please read the [[User Guide]].
 +
 +
== Required software ==
 +
OpenKM is a web application and need a web browser to use it, but also need some software installed in the client to obtain a best user experience.
 +
 +
* '''Flash Browser Plugin''': This is needed to view document previsualizations.
 +
* '''Java Browser Plugin''': Required for several OpenKM features like: Simple Scanner, Massive Uploader and Live Edit.
 +
 +
== Creating new users ==
 +
Once your OpenKM installation is completed and administrator user is provided. If you log into OpenKM with this administrator user you will see a tab called '''Administration''' which have several configuration options. '''Be careful because some of these options may hurt your OpenKM installation'''. The '''Users''' icon is used to access user management. Here you can create new users and roles.
 +
 +
{{Warning|Every user in OpenKM need to have '''ROLE_USER''' or '''ROLE_ADMIN''' roles.}}
 +
 +
{{Note|Learn more about users [[User administration]].}}
 +
 +
== User profiles ==
 +
With user profiles you can configure what elements and features present in OpenKM should be enabled or not. By default there is only one profile ('''Administration''' >  '''Profiles''') called '''Default''' which is assigned to every OpenKM user. You can create several profiles and only enable the needed menus and buttons to every one so users with lower skills may have less options. After the profile is created you can assign it to users ('''Administration''' >  '''Users''').
 +
 +
{{Note|Learn more about user profiles at [[Profiles]] and [[User administration]].}}
 +
 +
== Extension management ==
 +
By default none of the Professional Extensions are enabled unless you requested them. Some of these extensions may have special requirements (for example AutoCAD extension). Once the extensions have been installed they are enabled in the user profile. This way you can create several profiles and decide which extensions should be enabled in each one.
 +
 +
{{Note|Learn more about extensions at [[User Guide#Professional_extensions|User Guide: Professional extensions]].}}
 +
 +
== Application support ==
 +
If you have any question or problem, please make a support request. To make a request, please log as administrator and go to '''Administration''' > '''Home'''. In '''Support''' section you will see an URL to access the proper support site.
 +
 +
== Access OpenKM from other computers ==
 +
Stop Tomcat, edit $TOMCAT_HOME/conf/server.xml and change:
 +
 +
<source lang="xml">
 +
<Connector port="8080" address="127.0.0.1" protocol="HTTP/1.1"
 +
          connectionTimeout="20000"
 +
          redirectPort="8443" />
 +
</source>
 +
 +
By:
 +
 +
<source lang="xml">
 +
<Connector port="8080" address="0.0.0.0" protocol="HTTP/1.1"
 +
          connectionTimeout="20000"
 +
          redirectPort="8443" />
 +
</source>
 +
 +
Start Tomcat again.
 +
 +
{{Note|OpenKM Community support is provided by the community using http://forum.openkm.com. OpenKM Professional support is provided by OpenKM Staff.}}

Latest revision as of 17:54, 28 January 2013

In this document you will learn basic OpenKM usage. For a more detailed information, please read the User Guide.

Required software

OpenKM is a web application and need a web browser to use it, but also need some software installed in the client to obtain a best user experience.

  • Flash Browser Plugin: This is needed to view document previsualizations.
  • Java Browser Plugin: Required for several OpenKM features like: Simple Scanner, Massive Uploader and Live Edit.

Creating new users

Once your OpenKM installation is completed and administrator user is provided. If you log into OpenKM with this administrator user you will see a tab called Administration which have several configuration options. Be careful because some of these options may hurt your OpenKM installation. The Users icon is used to access user management. Here you can create new users and roles.


Nota advertencia.png Every user in OpenKM need to have ROLE_USER or ROLE_ADMIN roles.


Nota clasica.png Learn more about users User administration.

User profiles

With user profiles you can configure what elements and features present in OpenKM should be enabled or not. By default there is only one profile (Administration > Profiles) called Default which is assigned to every OpenKM user. You can create several profiles and only enable the needed menus and buttons to every one so users with lower skills may have less options. After the profile is created you can assign it to users (Administration > Users).


Nota clasica.png Learn more about user profiles at Profiles and User administration.

Extension management

By default none of the Professional Extensions are enabled unless you requested them. Some of these extensions may have special requirements (for example AutoCAD extension). Once the extensions have been installed they are enabled in the user profile. This way you can create several profiles and decide which extensions should be enabled in each one.


Nota clasica.png Learn more about extensions at User Guide: Professional extensions.

Application support

If you have any question or problem, please make a support request. To make a request, please log as administrator and go to Administration > Home. In Support section you will see an URL to access the proper support site.

Access OpenKM from other computers

Stop Tomcat, edit $TOMCAT_HOME/conf/server.xml and change: 

<Connector port="8080" address="127.0.0.1" protocol="HTTP/1.1"
           connectionTimeout="20000"
           redirectPort="8443" />

By: 

<Connector port="8080" address="0.0.0.0" protocol="HTTP/1.1"
           connectionTimeout="20000"
           redirectPort="8443" />

Start Tomcat again.


Nota clasica.png OpenKM Community support is provided by the community using http://forum.openkm.com. OpenKM Professional support is provided by OpenKM Staff.

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