Open-Xchange - User contributions [en]

AppSuite:Documents Installation Guide 7.10.2 and earlier

2019-08-22T13:50:54Z

Mhollmichel:

{{Version|7.8.3}}

= Download & Installation OX Documents =

=== General Information ===

OX Documents are browser based, cloud ready, text, spreadsheet and presentation products that can work with Microsoft Office and OpenOffice documents in a lossless way. And you can also collaborate with other people to edit shared documents on various devices.

Learn more about the highlights of OX Spreadsheet here: [http://software.open-xchange.com/products/appsuite/doc/OX_Spreadsheet_Product_Guide.pdf OX Spreadsheet Product Guide].

== Requirements ==

See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.

OX Documents needs to be installed in an OX App Suite configuration with a [[AppSuite:Grizzly|backend based on Grizzly]] (including hazelcast as installed and activated by default).

For compatibility with the legacy MS binary format files (.DOC, .XLS, .PPT) and for printing functionality in OX Text the document converter components (incl. readerengine) are required. These are not available in the Community Version of OX AppSuite.

== Mandatory Modules ==

Additional functional modules need to be installed separately:

* The Document Converter API: See [[AppSuite:DocumentConverterAPIInstall|Document converter API installation instructions]]

== Installation ==

The OX Documents deployment consists of the packages <tt>open-xchange-documents-backend</tt> and <tt>open-xchange-documents-ui</tt>. The <tt>open-xchange-documents-backend</tt> package also requires and installs these packages:

* <tt>open-xchange-realtime-core</tt>
* <tt>open-xchange-realtime-json</tt>
* <tt>open-xchange-file-distribution</tt>
* <tt>open-xchange-sessionstorage-hazelcast</tt>

=== Redhat Enterprise Linux 6 or CentOS 6 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}
$ yum install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Redhat Enterprise Linux 7 or CentOS 7 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ yum install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 8.0 ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 9.0 (valid from v7.10) ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== SUSE Linux Enterprise Server 12 ===

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ zypper ref
$ zypper install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Univention Corporate Server ===

OX Text for OX App Suite for UCS is available in the Univention App Center. Please check the UMC module App Center for the installation of the OX Documents at your already available environment.

== Printing and legacy MS binary formats Editing ==

For .DOC/.XLS/.PPT and/or printing support from OX Documents the Document Converter and readerengine components have to be installed separately (license key required)

* See [[AppSuite:DocumentConverterInstall|Document converter / readerengine installation instructions]]

== Monitoring ==

OX Documents offers runtime information via JMX about the document editors as well as the OX Documentconverter. This [[AppSuite:DocumentsMonitoring|article]] guides to the information how to access JMX data, configure and use Jolokia and integrate with munin.

== Configuration ==

=== Permissions ===

To enable the OX Documents Applications for OX Drive the associated permission has to be set.

The default setting for all users is changed in the file '''documents.properties''' in the directory ''/opt/open-xchange/etc''.

After installation the functionality is disabled:
<pre>
# Enables or disables the "text" module capability globally.
# com.openexchange.capability.text=true

# Enables or disables the "spreadsheet" module capability globally.
# com.openexchange.capability.spreadsheet=true

# Enables or disables the "presentation" module capability globally.
# com.openexchange.capability.presentation=true

</pre>

The following line enables the functionality:
<pre>
# Enables or disables the "text" module capability globally.
com.openexchange.capability.text=true
</pre>

Starting with 7.6.2, you can disable the text portal app. In '''permissions.properties''':
<pre>
permissions=textportaldisabled
</pre>

=== Collaboration on shared documents ===

If OX Documents functionality is used for guest users in a cluster of application servers, this setting needs to be adjusted to false in order to also have guest sessions available in the distributed storage.

in ''/opt/open-xchange/etc/sharing.properties''

<pre>
# Specifies whether guest sessions are treated as transient or not. Transient
# sessions are only held in the short-term session containers, and are not put
# into the distributed session storage. Defaults to "true".
com.openexchange.share.transientSessions=false
</pre>

com.openechange.share.transientSessions has to be set to false.

=== Spell Checking===

OX Text and OX Presentation use ''hunspell'' for spell checking functionality.
By default Spellchecking is enabled in ''/opt/open-xchange/etc/settings/office.properties''
with the following entry
<pre>
# Determines whether online spelling is enabled for office documents.
# Possible values: true|false
# If this property is missing true is taken.
io.ox/office//module/spellingEnabled=true
</pre>

After installation of the ''hunspell'' package for your platform the shared library and the US English dictionaries are available. Please check the file location the pkg files were installed into. (For instance on CentOS, use rpm -q –filesbypkg hunspell and verify the path of the lib files to be configured below)
Also verify that the Hunspell dictonary is present and not renamed to "myspell" etc.. if the dictionary is renamed, you will have to use that in the config below.

Additional dictionaries are published for your platform as packages hunspell-de-de, hunspell-fr, ...

Spell checking has to be configured in the file ''/opt/open-xchange/etc/hunspell.properties''.
The values for the shared library file and dictionary path have to be set according to the platform.

This example shows the values for Debian:

<pre>
# The name and location of the hunspell library
# Default value: "/usr/lib/x86_64-linux-gnu/libhunspell-1.3.so.0"
com.openexchange.spellchecker.hunspell.library=/usr/lib/x86_64-linux-gnu/libhunspell-1.4.so.0
# The location of the dictionaries
# Default value: "/usr/share/hunspell"
com.openexchange.spellchecker.hunspell.dictionaries=/usr/share/hunspell
</pre>

If spellchecking is enabled and the library path or dictionary path is wrong a warning is logged.

If a language is not supported by a hunspell dictionary (or produces error messages in the console log) myspell dictionaries are a working alternative.

=== Templates ===

OX Documents support different levels to provide document templates for users.

A number of ready-to-use templates for letters, memos, resumes, home budget, presentations, etc is included with the system. These templates are made available in a directory at each system node by installation of the package open-xchange-documents-templates. The path to this directory is defined in the office.properties file

<pre>
# Defines the absolute path where document templates are located inside the local (!) file system.
# The templates are displayed in the documents applications.
# If this property is missing a default '/opt/open-xchange/templates/documents' is taken.
io.ox/office//module/templatePath = /opt/open-xchange/templates/documents
</pre>

The content in the directory specified by the path must comply to the following rules:

<pre>
/opt/open-xchange/templates/documents
|
----> text [application type]
| |
| ----> en-US [language-region]
| |
| ----> en [language fallback, en is also fallback for all other non-convered languages]
| |
| ----> de-DE
| |
| ----> de
| |
| ----> common [language independent, used in addition to the language specific ones]
|
----> spreadsheet
|
----> presentation
</pre>

A context administrator can additionally provide global templates for all users in the same context.
If logged in with this role folders can be added to or removed from the list of global template folders. For regular users the list is displayed without the permission to modify it.

[[File:template-folder.png|border|600px|caption]]

Users can create and manage their own templates. These user templates are stored and retrieved from the user’s root folder (“My files”). In addition to the root folder the user can define more template folders, sub-folders or even external folders in the “Documents” section of the “Settings” menu. This helps to organize templates and allows cleanup of the root folder by removal of templates.

=== Documents in Tabs ===

OX Documents based on Appsuite 7.10.2 opens new documents in new tabs in the browser by default.

To disable this feature an stay in the single tab mode you have to set the attribute 'openInSingleTab' in as-config.yml

<pre>
# Override certain settings
default:
host: all
openInSingleTab: true
</pre>

For installations of OX Spreadsheet based on Appsuite 7.8.0 and 7.8.1 please see [http://oxpedia.org/wiki/index.php?title=AppSuite:Spreadsheet_Installation_Guide_7_8_1 here] for different installation modes.

AppSuite:Documents Installation Guide 7103

2019-07-11T12:36:47Z

Mhollmichel: /* Documents Collaboration Server (DCS) */

{{Version|7.10.3}}

= Download & Installation OX Documents =

=== General Information ===

OX Documents are browser based, cloud ready, text, spreadsheet and presentation products that can work with Microsoft Office and OpenOffice documents in a lossless way. And you can also collaborate with other people to edit shared documents on various devices.

== Requirements ==

See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details. Additionally there is the support of websockets proxy by the webserver required, this is e.g. available in Apache 2.4.5 and higher.

OX Documents needs to be installed in an OX App Suite configuration with a [[AppSuite:Grizzly|backend based on Grizzly]] (including hazelcast as installed and activated by default).

For compatibility with the legacy MS binary format files (.DOC, .XLS, .PPT) and for printing functionality in OX Text the document converter components (incl. readerengine) are required. These are not available in the Community Version of OX AppSuite.

== Mandatory Modules ==

Additional functional modules need to be installed separately:

* The Document Converter API: See [[AppSuite:DocumentConverterAPIInstall|Document converter API installation instructions]]

== Installation ==

The OX Documents deployment consists of the packages <tt>open-xchange-documents-backend</tt> and <tt>open-xchange-documents-ui</tt>. The <tt>open-xchange-documents-backend</tt> package also requires and installs these packages:

* <tt>open-xchange-file-distribution</tt>
* <tt>open-xchange-sessionstorage-hazelcast</tt>

The following Packages are no longer needed (since 7.10.3)
* <tt>open-xchange-realtime-core</tt>
* <tt>open-xchange-realtime-json</tt>

=== Redhat Enterprise Linux 6 or CentOS 6 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}
$ yum install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Redhat Enterprise Linux 7 or CentOS 7 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ yum install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 8.0 ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 9.0 (valid from v7.10) ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== SUSE Linux Enterprise Server 12 ===

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ zypper ref
$ zypper install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Univention Corporate Server ===

OX Text for OX App Suite for UCS is available in the Univention App Center. Please check the UMC module App Center for the installation of the OX Documents at your already available environment.

== Documents Collaboration Service ==

With 7.10.3 the Documents Collaboration Service has been introduced.

The Documents Collaboration Service needs to be installed, configured and run. It supports collaboration across Middleware nodes but is also mandatory for a small (even single node) environments.
The server can be run as one additional service (JVM) or for larger deployments several instances can be clustered.
The implementation is based on Spring Boot and uses the Java-based messaging server Apache ActiveMQ.

Note:
For upgrades from earlier versions than 7.10.2 the hazelcast cluster requires a complete shutdown, since the internal OX Documents data has changed. A rolling upgrade is not possible.

=== Documents Collaboration Server (DCS) ===

prepare documents-collaboration repo as described above.

The DCS will be installed via the package:
<pre>
open-xchange-documents-collaboration
</pre>

Target directory is /usr/share/open-xchange-documents-collaboration

Configuration file is /etc/documents-collaboration/dcs.properties. The following entries need to be reviewed and values adjusted to the setup. 
Configure bind host IP and JMS Port to listen to
<pre>
dcs.host = 192.168.10.25 # Interface of the DCS node
dcs.port = 61616
</pre>

A DCS writes its connection data to a database for discovery by middleware nodes. The appropriate database schema for the DCS as well as appropriate database access data for the DCS user need to be set prior to starting up the DCS for the first time.

The appropriate database connection properties to be used by the DCS itself need to be set at the configuration file /etc/documents-collaboration/dcs.properties:

<pre>
db.host=192.168.10.172
db.port=3306
db.schema=dcsdb
db.username=db_user
db.password=db_password
</pre>

After setting these database related properties within the /etc/documents-collaboration/dcs.properties file, the admin needs to call the /usr/share/open-xchange-documents-collaboration/bin/initdcsdb.sh script as super user of the system.

Database related settings made in the /etc/documents-collaboration/dcs.properties file are read by this script first and taken as defaults. Nevertheless, each default value can be overwritten by the admin via the command line. Passwords need to be set by the admin via the command line in every case for security reasons.

If all database properties have been set correctly within the /etc/documents-collaboration/dcs.properties file, a valid call to the /usr/share/open-xchange-documents-collaboration/bin/initdcsdb.sh script is e.g. the following one:

<pre>
sudo /usr/share/open-xchange-documents-collaboration/bin/initdcsdb.sh -a --dcsdb-pass=db_password --mysql-root-passwd=mysql_password
</pre>

The default logging path is set in //etc//documents-collaboration/logback-spring.xml and points to //var//log//open-xchange//documents-collaboration//documents-collaboration.log

The DCS Service will be started with
systemctl start open-xchange-documents-collaboration.service

A command line tool allows to check the values in the database
<pre>
# /usr/share/open-xchange-documents-collaboration/bin/documents-collaboration-admin.sh -l
+---------------------+---------------+---------------+---------+
| ID | Host | Interface | JMSPort |
+---------------------+---------------+---------------+---------+
| 192.168.10.25:61616 | 192.168.10.25 | 192.168.10.25 | 61616 |
+---------------------+---------------+---------------+---------+
</pre>

===Middleware node===

no new pkg repo, no new pkgs required for middleware

Discovery of the DCS service is configured in documents-collaboration-client.properties.
Add the appropriate values to access the dcsdb Database as set for the DCS above:
<pre>
com.openexchange.dcs.client.database.connectionURL=jdbc:mysql://192.168.10.172:3306/dcsdb
com.openexchange.dcs.client.database.userName=db_user
com.openexchange.dcs.client.database.password=db_password
</pre>

A command line tool allows to check the values in the database
<pre>
$ /opt/open-xchange/sbin/documents-collaboration-admin -l
+---------------------+---------------+---------------+---------+
| ID | Host | Interface | JMSPort |
+---------------------+---------------+---------------+---------+
| 192.168.10.25:61616 | 192.168.10.25 | 192.168.10.25 | 61616 |
+---------------------+---------------+---------------+---------+
</pre>

===Apache configuration===

The Apache module proxy_wstunnel has to be enable

<pre>
a2enmod proxy_wstunnel
</pre>

and the apache configuration needs to be enhanced by:

<pre>
<Proxy balancer://oxcluster_ws>
Order Deny,Allow
Allow from all
BalancerMember ws://localhost:8009 timeout=1900 smax=0 ttl=60 retry=60 loadfactor=50 keepalive=On route=OX1
ProxySet stickysession=JSESSIONID|jsessionid scolonpathdelim=On
SetEnv proxy-initial-not-pooled
SetEnv proxy-sendchunked
</Proxy>

ProxyPass /appsuite/rt2 balancer://oxcluster_ws/rt2
</pre>

== Printing and legacy MS binary formats Editing ==

For .DOC/.XLS/.PPT and/or printing support from OX Documents the Document Converter and readerengine components have to be installed separately (license key required)

* See [[AppSuite:DocumentConverterInstall|Document converter / readerengine installation instructions]]

== Monitoring ==

OX Documents offers runtime information via JMX about the document editors as well as the OX Documentconverter. This [[AppSuite:DocumentsMonitoring|article]] guides to the information how to access JMX data, configure and use Jolokia and integrate with munin.

== Configuration ==

=== Permissions ===

To enable the OX Documents Applications for OX Drive the associated permission has to be set.

The default setting for all users is changed in the file '''documents.properties''' in the directory ''/opt/open-xchange/etc''.

After installation the functionality is disabled:
<pre>
# Enables or disables the "text" module capability globally.
# com.openexchange.capability.text=true

# Enables or disables the "spreadsheet" module capability globally.
# com.openexchange.capability.spreadsheet=true

# Enables or disables the "presentation" module capability globally.
# com.openexchange.capability.presentation=true

</pre>

The following line enables the functionality:
<pre>
# Enables or disables the "text" module capability globally.
com.openexchange.capability.text=true
</pre>

Starting with 7.6.2, you can disable the text portal app. In '''permissions.properties''':
<pre>
permissions=textportaldisabled
</pre>

=== Collaboration on shared documents ===

If OX Documents functionality is used for guest users in a cluster of application servers, this setting needs to be adjusted to false in order to also have guest sessions available in the distributed storage.

in ''/opt/open-xchange/etc/sharing.properties''

<pre>
# Specifies whether guest sessions are treated as transient or not. Transient
# sessions are only held in the short-term session containers, and are not put
# into the distributed session storage. Defaults to "true".
com.openexchange.share.transientSessions=false
</pre>

com.openechange.share.transientSessions has to be set to false.

=== Spell Checking===

OX Text and OX Presentation use ''hunspell'' for spell checking functionality.
By default Spellchecking is enabled in ''/opt/open-xchange/etc/settings/office.properties''
with the following entry
<pre>
# Determines whether online spelling is enabled for office documents.
# Possible values: true|false
# If this property is missing true is taken.
io.ox/office//module/spellingEnabled=true
</pre>

After installation of the ''hunspell'' package for your platform the shared library and the US English dictionaries are available. Please check the file location the pkg files were installed into. (For instance on CentOS, use rpm -q –filesbypkg hunspell and verify the path of the lib files to be configured below)
Also verify that the Hunspell dictonary is present and not renamed to "myspell" etc.. if the dictionary is renamed, you will have to use that in the config below.

Additional dictionaries are published for your platform as packages hunspell-de-de, hunspell-fr, ...

Spell checking has to be configured in the file ''/opt/open-xchange/etc/hunspell.properties''.
The values for the shared library file and dictionary path have to be set according to the platform.

This example shows the values for Debian:

<pre>
# The name and location of the hunspell library
# Default value: "/usr/lib/x86_64-linux-gnu/libhunspell-1.3.so.0"
com.openexchange.spellchecker.hunspell.library=/usr/lib/x86_64-linux-gnu/libhunspell-1.4.so.0
# The location of the dictionaries
# Default value: "/usr/share/hunspell"
com.openexchange.spellchecker.hunspell.dictionaries=/usr/share/hunspell
</pre>

If spellchecking is enabled and the library path or dictionary path is wrong a warning is logged.

If a language is not supported by a hunspell dictionary (or produces error messages in the console log) myspell dictionaries are a working alternative.

=== Templates ===

OX Documents support different levels to provide document templates for users.

A number of ready-to-use templates for letters, memos, resumes, home budget, presentations, etc is included with the system. These templates are made available in a directory at each system node by installation of the package open-xchange-documents-templates. The path to this directory is defined in the office.properties file

<pre>
# Defines the absolute path where document templates are located inside the local (!) file system.
# The templates are displayed in the documents applications.
# If this property is missing a default '/opt/open-xchange/templates/documents' is taken.
io.ox/office//module/templatePath = /opt/open-xchange/templates/documents
</pre>

The content in the directory specified by the path must comply to the following rules:

<pre>
/opt/open-xchange/templates/documents
|
----> text [application type]
| |
| ----> en-US [language-region]
| |
| ----> en [language fallback, en is also fallback for all other non-convered languages]
| |
| ----> de-DE
| |
| ----> de
| |
| ----> common [language independent, used in addition to the language specific ones]
|
----> spreadsheet
|
----> presentation
</pre>

A context administrator can additionally provide global templates for all users in the same context.
If logged in with this role folders can be added to or removed from the list of global template folders. For regular users the list is displayed without the permission to modify it.

[[File:template-folder.png|border|600px|caption]]

Users can create and manage their own templates. These user templates are stored and retrieved from the user’s root folder (“My files”). In addition to the root folder the user can define more template folders, sub-folders or even external folders in the “Documents” section of the “Settings” menu. This helps to organize templates and allows cleanup of the root folder by removal of templates.

For installations of OX Spreadsheet based on Appsuite 7.8.0 and 7.8.1 please see [http://oxpedia.org/wiki/index.php?title=AppSuite:Spreadsheet_Installation_Guide_7_8_1 here] for different installation modes.

AppSuite:Documents Installation Guide 7103

2019-06-19T11:24:19Z

Mhollmichel: /* Middleware node */

{{Version|7.10.3}}

= Download & Installation OX Documents =

=== General Information ===

OX Documents are browser based, cloud ready, text, spreadsheet and presentation products that can work with Microsoft Office and OpenOffice documents in a lossless way. And you can also collaborate with other people to edit shared documents on various devices.

== Requirements ==

See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details. Additionally there is the support of websockets proxy by the webserver required, this is e.g. available in Apache 2.4.5 and higher.

OX Documents needs to be installed in an OX App Suite configuration with a [[AppSuite:Grizzly|backend based on Grizzly]] (including hazelcast as installed and activated by default).

For compatibility with the legacy MS binary format files (.DOC, .XLS, .PPT) and for printing functionality in OX Text the document converter components (incl. readerengine) are required. These are not available in the Community Version of OX AppSuite.

== Mandatory Modules ==

Additional functional modules need to be installed separately:

* The Document Converter API: See [[AppSuite:DocumentConverterAPIInstall|Document converter API installation instructions]]

== Installation ==

The OX Documents deployment consists of the packages <tt>open-xchange-documents-backend</tt> and <tt>open-xchange-documents-ui</tt>. The <tt>open-xchange-documents-backend</tt> package also requires and installs these packages:

* <tt>open-xchange-file-distribution</tt>
* <tt>open-xchange-sessionstorage-hazelcast</tt>

The following Packages are no longer needed (since 7.10.3)
* <tt>open-xchange-realtime-core</tt>
* <tt>open-xchange-realtime-json</tt>

=== Redhat Enterprise Linux 6 or CentOS 6 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}
$ yum install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Redhat Enterprise Linux 7 or CentOS 7 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ yum install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 8.0 ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 9.0 (valid from v7.10) ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== SUSE Linux Enterprise Server 12 ===

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ zypper ref
$ zypper install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Univention Corporate Server ===

OX Text for OX App Suite for UCS is available in the Univention App Center. Please check the UMC module App Center for the installation of the OX Documents at your already available environment.

== Documents Collaboration Service ==

With 7.10.3 the Documents Collaboration Service has been introduced.

The Documents Collaboration Service needs to be installed, configured and run. It supports collaboration across Middleware nodes but is also mandatory for a small (even single node) environments.
The server can be run as one additional service (JVM) or for larger deployments several instances can be clustered.
The implementation is based on Spring Boot and uses the Java-based messaging server Apache ActiveMQ.

Note:
For upgrades from earlier versions than 7.10.2 the hazelcast cluster requires a complete shutdown, since the internal OX Documents data has changed. A rolling upgrade is not possible.

=== Documents Collaboration Server (DCS) ===

prepare documents-collaboration repo as described above.

The DCS will be installed via the package:
<pre>
open-xchange-documents-collaboration-server
</pre>

Target directory is /usr/share/open-xchange-documents-collaboration

Configuration file is /etc/documents-collaboration/dcs.properties. The following entries need to be reviewed and values adjusted to the setup. 
Configure bind host IP and JMS Port to listen to
<pre>
dcs.host = 192.168.10.25 # Interface of the DCS node
dcs.port = 61616
</pre>

A DCS writes its connection data to a database for discovery by middleware nodes
<pre>
db.host=192.168.10.172
db.port=3306
db.schema=dcsdb
db.username=db_user
db.password=db_password
</pre>
For management of DCS hosts the database used by the middleware can be configured.

The default logging path is set in //etc//documents-collaboration/logback-spring.xml and points to //var//log//open-xchange//documents-collaboration//documents-collaboration.log

The DCS Service will be started with
systemctl start open-xchange-documents-collaboration.service

A command line tool allows to check the values in the database
<pre>
# /usr/share/open-xchange-documents-collaboration/bin/documents-collaboration-admin.sh -l
+---------------------+---------------+---------------+---------+
| ID | Host | Interface | JMSPort |
+---------------------+---------------+---------------+---------+
| 192.168.10.25:61616 | 192.168.10.25 | 192.168.10.25 | 61616 |
+---------------------+---------------+---------------+---------+
</pre>

===Middleware node===

no new pkg repo, no new pkgs required for middleware

Discovery of the DCS service is configured in documents-collaboration-client.properties.
Add the appropriate values to access the dcsdb Database as set for the DCS above:
<pre>
com.openexchange.dcs.client.database.connectionURL=jdbc:mysql://192.168.10.172:3306/dcsdb
com.openexchange.dcs.client.database.userName=db_user
com.openexchange.dcs.client.database.password=db_password
</pre>

A command line tool allows to check the values in the database
<pre>
$ /opt/open-xchange/sbin/documents-collaboration-admin -l
+---------------------+---------------+---------------+---------+
| ID | Host | Interface | JMSPort |
+---------------------+---------------+---------------+---------+
| 192.168.10.25:61616 | 192.168.10.25 | 192.168.10.25 | 61616 |
+---------------------+---------------+---------------+---------+
</pre>

===Apache configuration===

The Apache module proxy_wstunnel has to be enable

<pre>
a2enmod proxy_wstunnel
</pre>

and the apache configuration needs to be enhanced by:

<pre>
<Proxy balancer://oxcluster_ws>
Order Deny,Allow
Allow from all
BalancerMember ws://localhost:8009 timeout=1900 smax=0 ttl=60 retry=60 loadfactor=50 keepalive=On route=OX1
ProxySet stickysession=JSESSIONID|jsessionid scolonpathdelim=On
SetEnv proxy-initial-not-pooled
SetEnv proxy-sendchunked
</Proxy>

ProxyPass /appsuite/rt2 balancer://oxcluster_ws/rt2
</pre>

== Printing and legacy MS binary formats Editing ==

For .DOC/.XLS/.PPT and/or printing support from OX Documents the Document Converter and readerengine components have to be installed separately (license key required)

* See [[AppSuite:DocumentConverterInstall|Document converter / readerengine installation instructions]]

== Monitoring ==

OX Documents offers runtime information via JMX about the document editors as well as the OX Documentconverter. This [[AppSuite:DocumentsMonitoring|article]] guides to the information how to access JMX data, configure and use Jolokia and integrate with munin.

== Configuration ==

=== Permissions ===

To enable the OX Documents Applications for OX Drive the associated permission has to be set.

The default setting for all users is changed in the file '''documents.properties''' in the directory ''/opt/open-xchange/etc''.

After installation the functionality is disabled:
<pre>
# Enables or disables the "text" module capability globally.
# com.openexchange.capability.text=true

# Enables or disables the "spreadsheet" module capability globally.
# com.openexchange.capability.spreadsheet=true

# Enables or disables the "presentation" module capability globally.
# com.openexchange.capability.presentation=true

</pre>

The following line enables the functionality:
<pre>
# Enables or disables the "text" module capability globally.
com.openexchange.capability.text=true
</pre>

Starting with 7.6.2, you can disable the text portal app. In '''permissions.properties''':
<pre>
permissions=textportaldisabled
</pre>

=== Collaboration on shared documents ===

If OX Documents functionality is used for guest users in a cluster of application servers, this setting needs to be adjusted to false in order to also have guest sessions available in the distributed storage.

in ''/opt/open-xchange/etc/sharing.properties''

<pre>
# Specifies whether guest sessions are treated as transient or not. Transient
# sessions are only held in the short-term session containers, and are not put
# into the distributed session storage. Defaults to "true".
com.openexchange.share.transientSessions=false
</pre>

com.openechange.share.transientSessions has to be set to false.

=== Spell Checking===

OX Text and OX Presentation use ''hunspell'' for spell checking functionality.
By default Spellchecking is enabled in ''/opt/open-xchange/etc/settings/office.properties''
with the following entry
<pre>
# Determines whether online spelling is enabled for office documents.
# Possible values: true|false
# If this property is missing true is taken.
io.ox/office//module/spellingEnabled=true
</pre>

After installation of the ''hunspell'' package for your platform the shared library and the US English dictionaries are available. Please check the file location the pkg files were installed into. (For instance on CentOS, use rpm -q –filesbypkg hunspell and verify the path of the lib files to be configured below)
Also verify that the Hunspell dictonary is present and not renamed to "myspell" etc.. if the dictionary is renamed, you will have to use that in the config below.

Additional dictionaries are published for your platform as packages hunspell-de-de, hunspell-fr, ...

Spell checking has to be configured in the file ''/opt/open-xchange/etc/hunspell.properties''.
The values for the shared library file and dictionary path have to be set according to the platform.

This example shows the values for Debian:

<pre>
# The name and location of the hunspell library
# Default value: "/usr/lib/x86_64-linux-gnu/libhunspell-1.3.so.0"
com.openexchange.spellchecker.hunspell.library=/usr/lib/x86_64-linux-gnu/libhunspell-1.4.so.0
# The location of the dictionaries
# Default value: "/usr/share/hunspell"
com.openexchange.spellchecker.hunspell.dictionaries=/usr/share/hunspell
</pre>

If spellchecking is enabled and the library path or dictionary path is wrong a warning is logged.

If a language is not supported by a hunspell dictionary (or produces error messages in the console log) myspell dictionaries are a working alternative.

=== Templates ===

OX Documents support different levels to provide document templates for users.

A number of ready-to-use templates for letters, memos, resumes, home budget, presentations, etc is included with the system. These templates are made available in a directory at each system node by installation of the package open-xchange-documents-templates. The path to this directory is defined in the office.properties file

<pre>
# Defines the absolute path where document templates are located inside the local (!) file system.
# The templates are displayed in the documents applications.
# If this property is missing a default '/opt/open-xchange/templates/documents' is taken.
io.ox/office//module/templatePath = /opt/open-xchange/templates/documents
</pre>

The content in the directory specified by the path must comply to the following rules:

<pre>
/opt/open-xchange/templates/documents
|
----> text [application type]
| |
| ----> en-US [language-region]
| |
| ----> en [language fallback, en is also fallback for all other non-convered languages]
| |
| ----> de-DE
| |
| ----> de
| |
| ----> common [language independent, used in addition to the language specific ones]
|
----> spreadsheet
|
----> presentation
</pre>

A context administrator can additionally provide global templates for all users in the same context.
If logged in with this role folders can be added to or removed from the list of global template folders. For regular users the list is displayed without the permission to modify it.

[[File:template-folder.png|border|600px|caption]]

Users can create and manage their own templates. These user templates are stored and retrieved from the user’s root folder (“My files”). In addition to the root folder the user can define more template folders, sub-folders or even external folders in the “Documents” section of the “Settings” menu. This helps to organize templates and allows cleanup of the root folder by removal of templates.

For installations of OX Spreadsheet based on Appsuite 7.8.0 and 7.8.1 please see [http://oxpedia.org/wiki/index.php?title=AppSuite:Spreadsheet_Installation_Guide_7_8_1 here] for different installation modes.

AppSuite:Documents Installation Guide 7103

2019-06-19T11:18:44Z

Mhollmichel: /* Requirements */

{{Version|7.10.3}}

= Download & Installation OX Documents =

=== General Information ===

OX Documents are browser based, cloud ready, text, spreadsheet and presentation products that can work with Microsoft Office and OpenOffice documents in a lossless way. And you can also collaborate with other people to edit shared documents on various devices.

== Requirements ==

See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details. Additionally there is the support of websockets proxy by the webserver required, this is e.g. available in Apache 2.4.5 and higher.

OX Documents needs to be installed in an OX App Suite configuration with a [[AppSuite:Grizzly|backend based on Grizzly]] (including hazelcast as installed and activated by default).

For compatibility with the legacy MS binary format files (.DOC, .XLS, .PPT) and for printing functionality in OX Text the document converter components (incl. readerengine) are required. These are not available in the Community Version of OX AppSuite.

== Mandatory Modules ==

Additional functional modules need to be installed separately:

* The Document Converter API: See [[AppSuite:DocumentConverterAPIInstall|Document converter API installation instructions]]

== Installation ==

The OX Documents deployment consists of the packages <tt>open-xchange-documents-backend</tt> and <tt>open-xchange-documents-ui</tt>. The <tt>open-xchange-documents-backend</tt> package also requires and installs these packages:

* <tt>open-xchange-file-distribution</tt>
* <tt>open-xchange-sessionstorage-hazelcast</tt>

The following Packages are no longer needed (since 7.10.3)
* <tt>open-xchange-realtime-core</tt>
* <tt>open-xchange-realtime-json</tt>

=== Redhat Enterprise Linux 6 or CentOS 6 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}
$ yum install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Redhat Enterprise Linux 7 or CentOS 7 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ yum install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 8.0 ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 9.0 (valid from v7.10) ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== SUSE Linux Enterprise Server 12 ===

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ zypper ref
$ zypper install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Univention Corporate Server ===

OX Text for OX App Suite for UCS is available in the Univention App Center. Please check the UMC module App Center for the installation of the OX Documents at your already available environment.

== Documents Collaboration Service ==

With 7.10.3 the Documents Collaboration Service has been introduced.

The Documents Collaboration Service needs to be installed, configured and run. It supports collaboration across Middleware nodes but is also mandatory for a small (even single node) environments.
The server can be run as one additional service (JVM) or for larger deployments several instances can be clustered.
The implementation is based on Spring Boot and uses the Java-based messaging server Apache ActiveMQ.

Note:
For upgrades from earlier versions than 7.10.2 the hazelcast cluster requires a complete shutdown, since the internal OX Documents data has changed. A rolling upgrade is not possible.

=== Documents Collaboration Server (DCS) ===

prepare documents-collaboration repo as described above.

The DCS will be installed via the package:
<pre>
open-xchange-documents-collaboration-server
</pre>

Target directory is /usr/share/open-xchange-documents-collaboration

Configuration file is /etc/documents-collaboration/dcs.properties. The following entries need to be reviewed and values adjusted to the setup. 
Configure bind host IP and JMS Port to listen to
<pre>
dcs.host = 192.168.10.25 # Interface of the DCS node
dcs.port = 61616
</pre>

A DCS writes its connection data to a database for discovery by middleware nodes
<pre>
db.host=192.168.10.172
db.port=3306
db.schema=dcsdb
db.username=db_user
db.password=db_password
</pre>
For management of DCS hosts the database used by the middleware can be configured.

The default logging path is set in //etc//documents-collaboration/logback-spring.xml and points to //var//log//open-xchange//documents-collaboration//documents-collaboration.log

The DCS Service will be started with
systemctl start open-xchange-documents-collaboration.service

A command line tool allows to check the values in the database
<pre>
# /usr/share/open-xchange-documents-collaboration/bin/documents-collaboration-admin.sh -l
+---------------------+---------------+---------------+---------+
| ID | Host | Interface | JMSPort |
+---------------------+---------------+---------------+---------+
| 192.168.10.25:61616 | 192.168.10.25 | 192.168.10.25 | 61616 |
+---------------------+---------------+---------------+---------+
</pre>

===Middleware node===

no new pkg repo, no new pkgs required for middleware

Discovery of the DCS service is configured in documents-collaboration-client.properties.
Add the appropriate values to access the dcsdb Database as set for the DCS above:
<pre>
com.openexchange.dcs.client.database.connectionURL=jdbc:mysql://192.168.10.172:3306/dcsdb
com.openexchange.dcs.client.database.userName=db_user
com.openexchange.dcs.client.database.password=db_password
</pre>

A command line tool allows to check the values in the database
<pre>
$ /opt/open-xchange/sbin/documents-collaboration-admin -l
+---------------------+---------------+---------------+---------+
| ID | Host | Interface | JMSPort |
+---------------------+---------------+---------------+---------+
| 192.168.10.25:61616 | 192.168.10.25 | 192.168.10.25 | 61616 |
+---------------------+---------------+---------------+---------+
</pre>

== Printing and legacy MS binary formats Editing ==

For .DOC/.XLS/.PPT and/or printing support from OX Documents the Document Converter and readerengine components have to be installed separately (license key required)

* See [[AppSuite:DocumentConverterInstall|Document converter / readerengine installation instructions]]

== Monitoring ==

OX Documents offers runtime information via JMX about the document editors as well as the OX Documentconverter. This [[AppSuite:DocumentsMonitoring|article]] guides to the information how to access JMX data, configure and use Jolokia and integrate with munin.

== Configuration ==

=== Permissions ===

To enable the OX Documents Applications for OX Drive the associated permission has to be set.

The default setting for all users is changed in the file '''documents.properties''' in the directory ''/opt/open-xchange/etc''.

After installation the functionality is disabled:
<pre>
# Enables or disables the "text" module capability globally.
# com.openexchange.capability.text=true

# Enables or disables the "spreadsheet" module capability globally.
# com.openexchange.capability.spreadsheet=true

# Enables or disables the "presentation" module capability globally.
# com.openexchange.capability.presentation=true

</pre>

The following line enables the functionality:
<pre>
# Enables or disables the "text" module capability globally.
com.openexchange.capability.text=true
</pre>

Starting with 7.6.2, you can disable the text portal app. In '''permissions.properties''':
<pre>
permissions=textportaldisabled
</pre>

=== Collaboration on shared documents ===

If OX Documents functionality is used for guest users in a cluster of application servers, this setting needs to be adjusted to false in order to also have guest sessions available in the distributed storage.

in ''/opt/open-xchange/etc/sharing.properties''

<pre>
# Specifies whether guest sessions are treated as transient or not. Transient
# sessions are only held in the short-term session containers, and are not put
# into the distributed session storage. Defaults to "true".
com.openexchange.share.transientSessions=false
</pre>

com.openechange.share.transientSessions has to be set to false.

=== Spell Checking===

OX Text and OX Presentation use ''hunspell'' for spell checking functionality.
By default Spellchecking is enabled in ''/opt/open-xchange/etc/settings/office.properties''
with the following entry
<pre>
# Determines whether online spelling is enabled for office documents.
# Possible values: true|false
# If this property is missing true is taken.
io.ox/office//module/spellingEnabled=true
</pre>

After installation of the ''hunspell'' package for your platform the shared library and the US English dictionaries are available. Please check the file location the pkg files were installed into. (For instance on CentOS, use rpm -q –filesbypkg hunspell and verify the path of the lib files to be configured below)
Also verify that the Hunspell dictonary is present and not renamed to "myspell" etc.. if the dictionary is renamed, you will have to use that in the config below.

Additional dictionaries are published for your platform as packages hunspell-de-de, hunspell-fr, ...

Spell checking has to be configured in the file ''/opt/open-xchange/etc/hunspell.properties''.
The values for the shared library file and dictionary path have to be set according to the platform.

This example shows the values for Debian:

<pre>
# The name and location of the hunspell library
# Default value: "/usr/lib/x86_64-linux-gnu/libhunspell-1.3.so.0"
com.openexchange.spellchecker.hunspell.library=/usr/lib/x86_64-linux-gnu/libhunspell-1.4.so.0
# The location of the dictionaries
# Default value: "/usr/share/hunspell"
com.openexchange.spellchecker.hunspell.dictionaries=/usr/share/hunspell
</pre>

If spellchecking is enabled and the library path or dictionary path is wrong a warning is logged.

If a language is not supported by a hunspell dictionary (or produces error messages in the console log) myspell dictionaries are a working alternative.

=== Templates ===

OX Documents support different levels to provide document templates for users.

A number of ready-to-use templates for letters, memos, resumes, home budget, presentations, etc is included with the system. These templates are made available in a directory at each system node by installation of the package open-xchange-documents-templates. The path to this directory is defined in the office.properties file

<pre>
# Defines the absolute path where document templates are located inside the local (!) file system.
# The templates are displayed in the documents applications.
# If this property is missing a default '/opt/open-xchange/templates/documents' is taken.
io.ox/office//module/templatePath = /opt/open-xchange/templates/documents
</pre>

The content in the directory specified by the path must comply to the following rules:

<pre>
/opt/open-xchange/templates/documents
|
----> text [application type]
| |
| ----> en-US [language-region]
| |
| ----> en [language fallback, en is also fallback for all other non-convered languages]
| |
| ----> de-DE
| |
| ----> de
| |
| ----> common [language independent, used in addition to the language specific ones]
|
----> spreadsheet
|
----> presentation
</pre>

A context administrator can additionally provide global templates for all users in the same context.
If logged in with this role folders can be added to or removed from the list of global template folders. For regular users the list is displayed without the permission to modify it.

[[File:template-folder.png|border|600px|caption]]

Users can create and manage their own templates. These user templates are stored and retrieved from the user’s root folder (“My files”). In addition to the root folder the user can define more template folders, sub-folders or even external folders in the “Documents” section of the “Settings” menu. This helps to organize templates and allows cleanup of the root folder by removal of templates.

For installations of OX Spreadsheet based on Appsuite 7.8.0 and 7.8.1 please see [http://oxpedia.org/wiki/index.php?title=AppSuite:Spreadsheet_Installation_Guide_7_8_1 here] for different installation modes.

AppSuite:DocumentViewer

2018-11-26T09:31:09Z

Mhollmichel:

= OX Document Viewer =

== Product Description ==

The OX Document Viewer delivers plugin-free document viewing capabilities for Microsoft Office (.docx, .doc, .rtf, .pptx, .ppt, .xlsx, xls) and OpenDocument (.odt, .ods, .odp, .odg) file types as well as for the Portable Document Format (.pdf).
It extends OX App Suite with content thumbnails and preview capabilities.

== Requirements ==

OX Document Viewer requires a 64bit system. 32bit systems are not supported.

See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.

The OX Document Viewer deployment consists of two functional modules, that need to be installed separately: the '''readerengine''' component and the '''Document Viewer''' component.

=== ReaderEngine ===

See [[AppSuite:ReaderEngineInstall|Readerengine installation instructions]]

=== Document Viewer ===

See [[AppSuite:DocumentConverterAPIInstall|Document converter API installation instructions]]

See [[AppSuite:DocumentConverterInstall|Document converter installation instructions]]

For a more detailed guide explaining different installation variants visit the [[AppSuite:DocumentConverter_Installation_Guide|Installation Guide]]

== Installation ==

=== Redhat Enterprise Linux 6 or CentOS 6 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|documentconverter-api|office-web|open-xchange-pdftool}}
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|documentconverter|readerengine}}

$ yum install readerengine open-xchange-documentconverter

=== Redhat Enterprise Linux 7 or CentOS 7 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|documentconverter-api|office-web|open-xchange-pdftool}}
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|documentconverter|readerengine}}

$ yum install readerengine open-xchange-documentconverter

=== Debian GNU/Linux 8.0 (Jessie) ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|documentconverter-api|office-web|open-xchange-pdftool}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|documentconverter|readerengine}}

$ apt-get update
$ apt-get install readerengine open-xchange-documentconverter

=== Debian GNU/Linux 9.0 (Stretch) ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|documentconverter-api|office-web|open-xchange-pdftool}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|documentconverter|readerengine}}

$ apt-get update
$ apt-get install readerengine open-xchange-documentconverter

=== SUSE Linux Enterprise Server 12 ===

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|documentconverter-api|office-web|open-xchange-pdftool}}
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|documentconverter|readerengine}}

$ zypper ref
$ zypper install readerengine open-xchange-documentconverter

== Configuration ==
To enable document viewing for OX Drive the associated permission has to be set.

The default setting for all users is changed in the file '''permissions.properties''' in the directory ''/opt/open-xchange/etc''.

After installation the functionality is disabled:
<pre>
# Default permissions for all users
permissions=
</pre>

The following line enables the functionality:
<pre>
# Default permissions for all users
permissions=document_preview
</pre>

If there are already some permissions in this file, add ''document_preview'' separated with a comma.

Further settings for the underlying readerengine are located in the file '''documentconverter.properties''' located in the directory "/opt/open-xchange/etc" as described below.

Note: Document conversion service and OX App Suite backend may be run on different nodes. See the configuration item ''com.openexchange.documentconverter.RemoteBaseUrl'' for details.

{{AppSuite:ReaderEngineConfig}}

== Caches ==

Conversion results are cached as images for thumbnail/preview/viewer. There are caches in the backend filestore and at each documentconverter involved.

=== Caching Strategy ===

Starting with the 7.4.1 release the .../documentconverter/readerengine.cache directory is persistent and kept alive between OX backend shutdowns/startups.

In addition a backend configured as a remote document converton service this service is able to act as a remote cache server. Similar to setting the 'RemoteBaseURL' within the documentconverter properties of the 'client' backends wrt. the documentconverter functionality, it is now possible to set RemoteCacheURLs. The lookup of converter results happens as follows:

* the lookup of a cache entry is based upon the unique checksum of the source file as well as some conversion properties (e.g. target format, target size etc.)

* if a converter backend is not able to find a cache entry within its runtime structures, the local - now persistent - readerengine.cache directory is looked up for a cache entry to be recreated from filesystem

* if there's still no cache entry available and one or more RemoteCacheURLs are set, each given CacheURL Host is tried to retrieve a valid cache entry from

* if a remote cache entry is found, this entry is added to the local cache of the requesting converter

* if no remote cache entry can be found, the conversion is done locally, a cache entry is created locally (persistent) and also transferred to the first entry of the RemoteCacheURLs, acting as a master cache server in this case

=== Cleaning Caches ===

In case you want to clean the caches follow these two steps.

Use the command line tool for each affected context:

/opt/open-xchange/sbin/clearpreviewcache -c <CONTEXT ID>

Furthermore remove the content of the documentconverter cache directory manually at each conversion node. Before cleaning/removing the documentconverter cache directory, the OX backend node running the documentconverter, should be shut down in order to properly recreate the runtime information for the local cache. The local documentconverter cache location is defined by the following configuration property:

/opt/open-xchange/etc/documentconverter.properties

<pre>
# The directory, containing the cache for persistent, huge job data at runtime
# Default value: "/var/spool/open-xchange/documentconverter/readerengine.cache"
com.openexchange.documentconverter.cacheDir=/var/spool/open-xchange/documentconverter/readerengine.cache
</pre>

After the cleanup of both caches new conversions will be triggered for
thumbnails, previews and viewer images.

AppSuite:DocumentViewer

2018-11-15T10:59:17Z

Mhollmichel: /* Redhat Enterprise Linux 6 or CentOS 6 */

= OX Document Viewer =

== Product Description ==

The OX Document Viewer delivers plugin-free document viewing capabilities for Microsoft Office (.docx, .doc, .rtf, .pptx, .ppt, .xlsx, xls) and OpenDocument (.odt, .ods, .odp, .odg) file types as well as for the Portable Document Format (.pdf).
It extends OX App Suite with content thumbnails and preview capabilities.

== Requirements ==

OX Document Viewer requires a 64bit system. 32bit systems are not supported.

See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.

The OX Document Viewer deployment consists of two functional modules, that need to be installed separately: the '''readerengine''' component and the '''Document Viewer''' component.

=== ReaderEngine ===

See [[AppSuite:ReaderEngineInstall|Readerengine installation instructions]]

=== Document Viewer ===

See [[AppSuite:DocumentConverterAPIInstall|Document converter API installation instructions]]

See [[AppSuite:DocumentConverterInstall|Document converter installation instructions]]

For a more detailed guide explaining different installation variants visit the [[AppSuite:DocumentConverter_Installation_Guide|Installation Guide]]

== Installation ==

=== Redhat Enterprise Linux 6 or CentOS 6 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|documentconverter-api|office-web|open-xchange-pdftool}}
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|documentconverter|readerengine}}

$ yum install readerengine open-xchange-documentconverter

=== Redhat Enterprise Linux 7 or CentOS 7 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|documentconverter-api|office-web}}
{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|documentconverter|readerengine}}

$ yum install readerengine open-xchange-documentconverter

=== Debian GNU/Linux 8.0 (Jessie) ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|documentconverter-api|office-web}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|documentconverter|readerengine}}

$ apt-get update
$ apt-get install readerengine open-xchange-documentconverter

=== Debian GNU/Linux 9.0 (Stretch) ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|documentconverter-api|office-web}}
{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianStretch|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|documentconverter|readerengine}}

$ apt-get update
$ apt-get install readerengine open-xchange-documentconverter

=== SUSE Linux Enterprise Server 12 ===

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|documentconverter-api|office-web}}
{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|pc3n=ldbaccount|pc3v=[CUSTOMERID:PASSWORD]|documentconverter|readerengine}}

$ zypper ref
$ zypper install readerengine open-xchange-documentconverter

== Configuration ==
To enable document viewing for OX Drive the associated permission has to be set.

The default setting for all users is changed in the file '''permissions.properties''' in the directory ''/opt/open-xchange/etc''.

After installation the functionality is disabled:
<pre>
# Default permissions for all users
permissions=
</pre>

The following line enables the functionality:
<pre>
# Default permissions for all users
permissions=document_preview
</pre>

If there are already some permissions in this file, add ''document_preview'' separated with a comma.

Further settings for the underlying readerengine are located in the file '''documentconverter.properties''' located in the directory "/opt/open-xchange/etc" as described below.

Note: Document conversion service and OX App Suite backend may be run on different nodes. See the configuration item ''com.openexchange.documentconverter.RemoteBaseUrl'' for details.

{{AppSuite:ReaderEngineConfig}}

== Caches ==

Conversion results are cached as images for thumbnail/preview/viewer. There are caches in the backend filestore and at each documentconverter involved.

=== Caching Strategy ===

Starting with the 7.4.1 release the .../documentconverter/readerengine.cache directory is persistent and kept alive between OX backend shutdowns/startups.

In addition a backend configured as a remote document converton service this service is able to act as a remote cache server. Similar to setting the 'RemoteBaseURL' within the documentconverter properties of the 'client' backends wrt. the documentconverter functionality, it is now possible to set RemoteCacheURLs. The lookup of converter results happens as follows:

* the lookup of a cache entry is based upon the unique checksum of the source file as well as some conversion properties (e.g. target format, target size etc.)

* if a converter backend is not able to find a cache entry within its runtime structures, the local - now persistent - readerengine.cache directory is looked up for a cache entry to be recreated from filesystem

* if there's still no cache entry available and one or more RemoteCacheURLs are set, each given CacheURL Host is tried to retrieve a valid cache entry from

* if a remote cache entry is found, this entry is added to the local cache of the requesting converter

* if no remote cache entry can be found, the conversion is done locally, a cache entry is created locally (persistent) and also transferred to the first entry of the RemoteCacheURLs, acting as a master cache server in this case

=== Cleaning Caches ===

In case you want to clean the caches follow these two steps.

Use the command line tool for each affected context:

/opt/open-xchange/sbin/clearpreviewcache -c <CONTEXT ID>

Furthermore remove the content of the documentconverter cache directory manually at each conversion node. Before cleaning/removing the documentconverter cache directory, the OX backend node running the documentconverter, should be shut down in order to properly recreate the runtime information for the local cache. The local documentconverter cache location is defined by the following configuration property:

/opt/open-xchange/etc/documentconverter.properties

<pre>
# The directory, containing the cache for persistent, huge job data at runtime
# Default value: "/var/spool/open-xchange/documentconverter/readerengine.cache"
com.openexchange.documentconverter.cacheDir=/var/spool/open-xchange/documentconverter/readerengine.cache
</pre>

After the cleanup of both caches new conversions will be triggered for
thumbnails, previews and viewer images.

AppSuite:ImageConverterMonitoring

2018-06-04T06:22:46Z

Mhollmichel: /* OX Documentconverter */

= OX Imageconverter Monitoring =

== General ==

The Open-Xchange JMX offers the ability to fetch runtime information of the Java virtual machine, and about the Open-Xchange Middleware (aka groupware backend) including Imageconverter.

For general information about the JMX interface see: [[OX_monitoring_interface]]

The usage of Jolokia to access monitoring data is described in the article [[Jolokia]]

Plugins are available for integration in the munin monitoring framework: [[OX_munin_scripts]]

== OX Imageconverter ==

Monitoring data for Imageconverter can be obtained after installation of the package open-xchange-munin-scripts-jolokia. It uses Jolokia if available and configured.

Here is a list of sample data provided by
<pre>
# /opt/open-xchange/sbin/showruntimestats --port 9995 -a

AppSuite:ImageConverterMonitoring

2018-06-04T06:22:07Z

Mhollmichel: /* OX Documentconverter */

= OX Imageconverter Monitoring =

== General ==

The Open-Xchange JMX offers the ability to fetch runtime information of the Java virtual machine, and about the Open-Xchange Middleware (aka groupware backend) including Imageconverter.

For general information about the JMX interface see: [[OX_monitoring_interface]]

The usage of Jolokia to access monitoring data is described in the article [[Jolokia]]

Plugins are available for integration in the munin monitoring framework: [[OX_munin_scripts]]

== OX Documentconverter ==

Monitoring data for OX Documentconverter can be obtained after installation of the package open-xchange-munin-scripts-jolokia. It uses Jolokia if available and configured.

Here is a list of sample data provided by
<pre>
# /opt/open-xchange/sbin/showruntimestats --port 9995 -a

AppSuite:ImageConverterMonitoring

2018-06-04T06:18:28Z

Mhollmichel: Created page with "= OX Imageconverter Monitoring = == General == The Open-Xchange JMX offers the ability to fetch runtime information of the Java virtual machine, and about the Open-Xchange M..."

= OX Imageconverter Monitoring =

== General ==

The Open-Xchange JMX offers the ability to fetch runtime information of the Java virtual machine, and about the Open-Xchange Middleware (aka groupware backend) including Imageconverter.

For general information about the JMX interface see: [[OX_monitoring_interface]]

The usage of Jolokia to access monitoring data is described in the article [[Jolokia]]

Plugins are available for integration in the munin monitoring framework: [[OX_munin_scripts]]

== OX Documentconverter ==

Monitoring data for OX Documentconverter can be obtained after installation of the package open-xchange-munin-scripts-jolokia. It uses Jolokia if available and configured.

Here is a list of sample data provided by
<pre>
# /opt/open-xchange/sbin/showruntimestats --port 9998 -y

AppSuite:ImageConverter Install

2018-06-04T06:14:42Z

Mhollmichel: /* Permissions */

= Download & Installation Imageconverter =

=== General Information ===

OX App Suite displays images (photos and graphics) in many different ways as

* Thumbnails
* Icons
* Images embedded in documents
* in Emails
* in an own pop-up window.

The image processing is done by the OX Middleware and not by a dedicated service, so that the middleware might consume a lot of cpu time just to convert images to different target formats. Furthermore the OX Middleware does not cache images for a longer time. Only thumbnails get cached, either by the database or file system based. These images get converted into the required formats (e.g. jpeg, png) when demanded by an user action in the user Interface.

With OX App Suite 7.10 there is an alternative to process images by the OX Middleware. The image conversion and delivery can be delegated to an extra service, the Ox ImageConverter server.

The separation of the ImageConverter service has the following advantages:

Configuration and usage of one or more separate storages
Performance improvements via persistent cache
Pre-rendering of pre-defined formats and sizes (defaults are auto:200x150, auto:480x320, auto:640x480, auto:800x600, auto:1280x720, auto:1920x1080") if resolution of the source image allows this.
Best matching size will be delivered without new conversion, if an image is requested by the Middleware
Browser is able to cache those images
No limits for image sizes
The default target format is specified by configured, predefined formats. By using the 'auto' (beside 'jpg' or 'png') target format, opaque source images are converted to JPEG target images and transparent images are converted to PNG target images.
Reduce load of OX Middleware

== Requirements ==

See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.

== Mandatory Modules ==

Additional functional modules need to be installed separately:

* The Image Converter Client: See [[AppSuite:ImageConverterClientInstall|Image converter client installation instructions]]

== Installation ==

The Image Converter deployment consists of the package <tt>open-xchange-imageconverter-server</tt>.

=== Redhat Enterprise Linux 6 or CentOS 6 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|imageconverter}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|imageconverter/updates}}
$ yum install open-xchange-imageconverter-server

=== Redhat Enterprise Linux 7 or CentOS 7 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|imageconverter}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|imageconverter/updates}}

$ yum install open-xchange-imageconverter-server

=== Debian GNU/Linux 8.0 ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|imageconverter}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|imageconverter/updates}}

$ apt-get update
$ apt-get install open-xchange-imageconverter-server

=== SUSE Linux Enterprise Server 12 ===

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|imageconverter}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|imageconverter/updates}}

$ zypper ref
$ zypper install open-xchange-imageconverter-server

== Monitoring ==

Image Converter offers runtime information via JMX about the Image Converter. This [[AppSuite:ImageConverterMonitoring|article]] guides to the information how to access JMX data, configure and use Jolokia and integrate with munin.

== Configuration ==

=== Permissions ===

Since the ImageConverter service uses the FileItemService, which itself needs a dedicated filestore and a dedicated database schema, the following steps need to be performed by the admin prior to starting the ImageConverter WebService

Create a directory for the FileItemService filestore(s) with OS commands, that is writable for the user, running the OX backends:

$ mkdir -p /var/opt/fisstore

Register the FileItemService filestore(s) via the OX admin command registerfilestore after installation: "${OX_SBIN}/registerfilestore" -A oxadminmaster -P ${AS_ADMINMASTER_PASS} -t file:///var/opt/fisstore

Enter the id(s) of the FileItemService filestore(s) (put into the configdb database by using the registerfilestore command) into the fileitem.properties configuration file
Create a new, empty database schema to be used by the FileItemService:

$ ${OX_IMAGECONVERTER_SBIN}/initfileitemdb" -i --fileitemdb-pass="${AS_DB_PASS}" --fileitemdb-user=openexchange --fileitemdb-host=localhost --fileitemdb-port=3306 --fileitemdb-dbname=fileitemdb

The ImageConverter itself currently relies on the external ImageMagick framework, so that this package has to be installed on the node, the ImageConverter is running on

The following property files finally need to be adjusted on the ImageConverter node to ensure correct runtime behavior of the ImageConverter implementation

* fileitem.properties
* imageconverter.properties

AppSuite:ImageConverterClientInstall

2018-06-03T18:44:37Z

Mhollmichel: Created page with "= Description = The Image Converter Client is necessary to use Imageconverter Server functionality from the Appsuite. {{InstallPlugin|pluginname=open-xchange-imageconverter..."

= Description =

The Image Converter Client is necessary to use Imageconverter Server functionality from the Appsuite.

{{InstallPlugin|pluginname=open-xchange-imageconverter-client|toplevel=products|sopath=appsuite/stable/imageconverter|version=App Suite|reponame=imageconverter}}

== Configuration ==

Adjust middleware configuration property to access the ImageConverter server:
/opt/open-xchange/etc/imageconverter-client.properties: com.openexchange.imageconverter.client.remoteImageConverterUrl=http://<host>:8005/imageconverter

[[Category:AppSuite]]
[[Category:Administrator]]

AppSuite:ImageConverter Install

2018-05-28T13:08:47Z

Mhollmichel: Created page with "= Download & Installation Imageconverter = === General Information === OX App Suite displays images (photos and graphics) in many different ways as * Thumbnails * Icons * I..."

= Download & Installation Imageconverter =

=== General Information ===

OX App Suite displays images (photos and graphics) in many different ways as

* Thumbnails
* Icons
* Images embedded in documents
* in Emails
* in an own pop-up window.

The image processing is done by the OX Middleware and not by a dedicated service, so that the middleware might consume a lot of cpu time just to convert images to different target formats. Furthermore the OX Middleware does not cache images for a longer time. Only thumbnails get cached, either by the database or file system based. These images get converted into the required formats (e.g. jpeg, png) when demanded by an user action in the user Interface.

With OX App Suite 7.10 there is an alternative to process images by the OX Middleware. The image conversion and delivery can be delegated to an extra service, the Ox ImageConverter server.

The separation of the ImageConverter service has the following advantages:

Configuration and usage of one or more separate storages
Performance improvements via persistent cache
Pre-rendering of pre-defined formats and sizes (defaults are auto:200x150, auto:480x320, auto:640x480, auto:800x600, auto:1280x720, auto:1920x1080") if resolution of the source image allows this.
Best matching size will be delivered without new conversion, if an image is requested by the Middleware
Browser is able to cache those images
No limits for image sizes
The default target format is specified by configured, predefined formats. By using the 'auto' (beside 'jpg' or 'png') target format, opaque source images are converted to JPEG target images and transparent images are converted to PNG target images.
Reduce load of OX Middleware

== Requirements ==

See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.

== Mandatory Modules ==

Additional functional modules need to be installed separately:

* The Image Converter Client: See [[AppSuite:ImageConverterClientInstall|Image converter client installation instructions]]

== Installation ==

The Image Converter deployment consists of the package <tt>open-xchange-imageconverter-server</tt>.

=== Redhat Enterprise Linux 6 or CentOS 6 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|imageconverter}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|imageconverter/updates}}
$ yum install open-xchange-imageconverter-server

=== Redhat Enterprise Linux 7 or CentOS 7 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|imageconverter}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|imageconverter/updates}}

$ yum install open-xchange-imageconverter-server

=== Debian GNU/Linux 8.0 ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|imageconverter}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|imageconverter/updates}}

$ apt-get update
$ apt-get install open-xchange-imageconverter-server

=== SUSE Linux Enterprise Server 12 ===

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|imageconverter}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|imageconverter/updates}}

$ zypper ref
$ zypper install open-xchange-imageconverter-server

== Monitoring ==

Image Converter offers runtime information via JMX about the Image Converter. This [[AppSuite:ImageConverterMonitoring|article]] guides to the information how to access JMX data, configure and use Jolokia and integrate with munin.

== Configuration ==

=== Permissions ===

Since the ImageConverter service uses the FileItemService, which itself needs a dedicated filestore and a dedicated database schema, the following steps need to be performed by the admin prior to starting the ImageConverter WebService

Create a directory for the FileItemService filestore(s) with OS commands, that is writable for the user, running the OX backends : 'mkdir -p /var/opt/fisstore'

Register the FileItemService filestore(s) via the OX admin command registerfilestore after installation: "${OX_SBIN}/registerfilestore" -A oxadminmaster -P ${AS_ADMINMASTER_PASS} -t file:///var/opt/fisstore

Enter the id(s) of the FileItemService filestore(s) (put into the configdb database by using the registerfilestore command) into the fileitem.properties configuration file
Create a new, empty database schema to be used by the FileItemService: "${OX_IMAGECONVERTER_SBIN}/initfileitemdb" -i --fileitemdb-pass="${AS_DB_PASS}" --fileitemdb-user=openexchange --fileitemdb-host=localhost --fileitemdb-port=3306 --fileitemdb-dbname=fileitemdb

The ImageConverter itself currently relies on the external ImageMagick framework, so that this package has to be installed on the node, the ImageConverter is running on

The following property files finally need to be adjusted on the ImageConverter node to ensure correct runtime behavior of the ImageConverter implementation

* fileitem.properties
* imageconverter.properties

AppSuite:Documents Installation Guide 7.10.2 and earlier

2017-07-18T13:16:41Z

Mhollmichel: /* Configuration */

{{Version|7.8.3}}

= Download & Installation OX Documents =

=== General Information ===

OX Documents are browser based, cloud ready, text, spreadsheet and presentation products that can work with Microsoft Office and OpenOffice documents in a lossless way. And you can also collaborate with other people to edit shared documents on various devices.

Learn more about the highlights of OX Spreadsheet here: [http://software.open-xchange.com/products/appsuite/doc/OX_Spreadsheet_Product_Guide.pdf OX Spreadsheet Product Guide].

== Requirements ==

See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.

OX Documents needs to be installed in an OX App Suite configuration with a [[AppSuite:Grizzly|backend based on Grizzly]] (including hazelcast as installed and activated by default).

For compatibility with the legacy MS binary format files (.DOC, .XLS, .PPT) and for printing functionality in OX Text the document converter components (incl. readerengine) are required. These are not available in the Community Version of OX AppSuite.

== Mandatory Modules ==

Additional functional modules need to be installed separately:

* The Document Converter API: See [[AppSuite:DocumentConverterAPIInstall|Document converter API installation instructions]]

== Installation ==

The OX Documents deployment consists of the packages <tt>open-xchange-documents-backend</tt> and <tt>open-xchange-documents-ui</tt>. The <tt>open-xchange-documents-backend</tt> package also requires and installs these packages:

* <tt>open-xchange-realtime-core</tt>
* <tt>open-xchange-realtime-json</tt>
* <tt>open-xchange-file-distribution</tt>
* <tt>open-xchange-sessionstorage-hazelcast</tt>

=== Redhat Enterprise Linux 6 or CentOS 6 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}
$ yum install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Redhat Enterprise Linux 7 or CentOS 7 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ yum install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 7.0 (valid until v7.8.2) ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/7.8.2|pc2n=debianname|pc2v=DebianWheezy|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/7.8.2|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 8.0 ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== SUSE Linux Enterprise Server 11 (valid until v7.8.2) ===

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/7.8.2|pc2n=susename|pc2v=SLES11|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/7.8.2|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ zypper ref
$ zypper install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== SUSE Linux Enterprise Server 12 ===

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ zypper ref
$ zypper install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Univention Corporate Server ===

OX Text for OX App Suite for UCS is available in the Univention App Center. Please check the UMC module App Center for the installation of the OX Documents at your already available environment.

== Printing and legacy MS binary formats Editing ==

For .DOC/.XLS/.PPT and/or printing support from OX Documents the Document Converter and readerengine components have to be installed separately (license key required)

* See [[AppSuite:DocumentConverterInstall|Document converter / readerengine installation instructions]]

== Monitoring ==

OX Documents offers runtime information via JMX about the document editors as well as the OX Documentconverter. This [[AppSuite:DocumentsMonitoring|article]] guides to the information how to access JMX data, configure and use Jolokia and integrate with munin.

== Configuration ==

=== Permissions ===

To enable the OX Documents Applications for OX Drive the associated permission has to be set.

The default setting for all users is changed in the file '''documents.properties''' in the directory ''/opt/open-xchange/etc''.

After installation the functionality is disabled:
<pre>
# Enables or disables the "text" module capability globally.
# com.openexchange.capability.text=true

# Enables or disables the "spreadsheet" module capability globally.
# com.openexchange.capability.spreadsheet=true

# Enables or disables the "presentation" module capability globally.
# com.openexchange.capability.presentation=true

</pre>

The following line enables the functionality:
<pre>
# Enables or disables the "text" module capability globally.
com.openexchange.capability.text=true
</pre>

Starting with 7.6.2, you can disable the text portal app. In '''permissions.properties''':
<pre>
permissions=textportaldisabled
</pre>

=== Collaboration on shared documents ===

If OX Documents functionality is used for guest users in a cluster of application servers, this setting needs to be adjusted to false in order to also have guest sessions available in the distributed storage.

in ''/opt/open-xchange/etc/sharing.properties''

<pre>
# Specifies whether guest sessions are treated as transient or not. Transient
# sessions are only held in the short-term session containers, and are not put
# into the distributed session storage. Defaults to "true".
com.openexchange.share.transientSessions=false
</pre>

com.openechange.share.transientSessions has to be set to false.

=== Spell Checking===

OX Text and OX Presentation use ''hunspell'' for spell checking functionality.
By default Spellchecking is enabled in ''/opt/open-xchange/etc/settings/office.properties''
with the following entry
<pre>
# Determines whether online spelling is enabled for office documents.
# Possible values: true|false
# If this property is missing true is taken.
io.ox/office//module/spellingEnabled=true
</pre>

After installation of the ''hunspell'' package for your platform the shared library and the US English dictionaries are available.

Additional dictionaries are published for your platform as packages hunspell-de-de, hunspell-fr, ...

Spell checking has to be configured in the file ''/opt/open-xchange/etc/hunspell.properties''.
The values for the shared library file and dictionary path have to be set according to the platform.

This example shows the values for Debian:

<pre>
# The name and location of the hunspell library
# Default value: "/usr/lib/x86_64-linux-gnu/libhunspell-1.3.so.0"
com.openexchange.spellchecker.hunspell.library=/usr/lib64/libhunspell-1.2.so.0
# The location of the dictionaries
# Default value: "/usr/share/hunspell"
com.openexchange.spellchecker.hunspell.dictionaries=/usr/share/hunspell
</pre>

If spellchecking is enabled and the library path or dictionary path is wrong a warning is logged.

If a language is not supported by a hunspell dictionary (or produces error messages in the console log) myspell dictionaries are a working alternative.

=== Templates ===

OX Documents support different levels to provide document templates for users.

A number of ready-to-use templates for letters, memos, resumes, home budget, presentations, etc is included with the system. These templates are made available in a directory at each system node by installation of the package open-xchange-documents-templates. The path to this directory is defined in the office.properties file

<pre>
# Defines the absolute path where document templates are located inside the local (!) file system.
# The templates are displayed in the documents applications.
# If this property is missing a default '/opt/open-xchange/templates/documents' is taken.
io.ox/office//module/templatePath = /opt/open-xchange/templates/documents
</pre>

The content in the directory specified by the path must comply to the following rules:

<pre>
/opt/open-xchange/templates/documents
|
----> text [application type]
| |
| ----> en-US [language-region]
| |
| ----> en [language fallback, en is also fallback for all other non-convered languages]
| |
| ----> de-DE
| |
| ----> de
| |
| ----> common [language independent, used in addition to the language specific ones]
|
----> spreadsheet
|
----> presentation
</pre>

A context administrator can additionally provide global templates for all users in the same context.
If logged in with this role folders can be added to or removed from the list of global template folders. For regular users the list is displayed without the permission to modify it.

[[File:template-folder.png|border|600px|caption]]

Users can create and manage their own templates. These user templates are stored and retrieved from the user’s root folder (“My files”). In addition to the root folder the user can define more template folders, sub-folders or even external folders in the “Documents” section of the “Settings” menu. This helps to organize templates and allows cleanup of the root folder by removal of templates.

For installations of OX Spreadsheet based on Appsuite 7.8.0 and 7.8.1 please see [http://oxpedia.org/wiki/index.php?title=AppSuite:Spreadsheet_Installation_Guide_7_8_1 here] for different installation modes.

AppSuite:DocumentConverterInstall

2017-03-14T12:53:32Z

Mhollmichel:

= Description =

This is the Open-Xchange implementation of the [[AppSuite:DocumentConverterAPIInstall|Document Converter API]]. While the API is open, the implementation is not licensed under GPL. It maintains the running instances of readerengines, which are headless OpenOffice instances. This behavior can be configured through documenterconverter.properties configuration file. The Document Converter is only available via a valid Open-Xchange license key.

See [[AppSuite:ReaderEngineInstall|Readerengine installation instructions]] for details on the setup of the underlying readerengine.

For a more detailed guide explaining different installation variants visit the [[AppSuite:DocumentConverter_Installation_Guide|Installation Guide]]

Instructions for manual steps needed for the [[AppSuite:DocumentConverterUpdate782|Update to 7.8.2]] from earlier versions.

The Document Converter is installed according to the following instructions.

{{InstallPlugin|pluginname=open-xchange-documentconverter-server|toplevel=products|sopath=appsuite/stable/documentconverter|version=App Suite|reponame=documentconverter|ldbaccount=CUSTOMERID:PASSWORD}}

[[Category:AppSuite]]
[[Category:Administrator]]

AppSuite:Documents Installation Guide 7.10.2 and earlier

2016-11-15T11:01:32Z

Mhollmichel: /* Download & Installation OX Documments */

{{Version|7.8.3}}

= Download & Installation OX Documents =

=== General Information ===

OX Documents are browser based, cloud ready, text, spreadsheet and presentation products that can work with Microsoft Word, Excel and Powerpoint documents in a lossless way. And you can also collaborate with other people to edit shared documents on various devices.

Learn more about the highlights of OX Spreadsheet here: [http://software.open-xchange.com/products/appsuite/doc/OX_Spreadsheet_Product_Guide.pdf OX Spreadsheet Product Guide].

== Requirements ==

See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.

OX Documents needs to be installed in an OX App Suite configuration with a [[AppSuite:Grizzly|backend based on Grizzly]] (including hazelcast as installed and activated by default).

For compatibility with the legacy MS binary format files (.DOC, .XLS, .PPT) and for printing functionality in OX Text the document converter components (incl. readerengine) are required. These are not available in the Community Version of OX AppSuite.

== Mandatory Modules ==

Additional functional modules need to be installed separately:

* The Document Converter API: See [[AppSuite:DocumentConverterAPIInstall|Document converter API installation instructions]]

== Installation ==

The OX Documents deployment consists of the packages <tt>open-xchange-documents-backend</tt> and <tt>open-xchange-documents-ui</tt>. The <tt>open-xchange-documents-backend</tt> package also requires and installs these packages:

* <tt>open-xchange-realtime-core</tt>
* <tt>open-xchange-realtime-json</tt>
* <tt>open-xchange-file-distribution</tt>
* <tt>open-xchange-sessionstorage-hazelcast</tt>

=== Redhat Enterprise Linux 6 or CentOS 6 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}
$ yum install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Redhat Enterprise Linux 7 or CentOS 7 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ yum install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 7.0 ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 8.0 ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== SUSE Linux Enterprise Server 11 ===

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLES11|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ zypper ref
$ zypper install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== SUSE Linux Enterprise Server 12 ===

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ zypper ref
$ zypper install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Univention Corporate Server ===

OX Text for OX App Suite for UCS is available in the Univention App Center. Please check the UMC module App Center for the installation of the OX Documents at your already available environment.

== Printing and legacy MS binary formats Editing ==

For .DOC/.XLS/.PPT and/or printing support from OX Documents the Document Converter and readerengine components have to be installed separately (license key required)

* See [[AppSuite:DocumentConverterInstall|Document converter / readerengine installation instructions]]

== Spell Checking ==

OX Text and OX Presentation are able to use ''hunspell'' for spell checking functionality.

After installation of the ''hunspell'' package for your platform the shared library and the US English dictionaries are available.

Additional dictionaries are published for your platform as packages hunspell-de-de, hunspell-fr, ...

== Monitoring ==

OX Documents offers runtime information via JMX about the document editors as well as the OX Documentconverter. This [[AppSuite:DocumentsMonitoring|article]] guides to the information how to access JMX data, configure and use Jolokia and integrate with munin.

== Configuration ==

=== Permissions ===

To enable the OX Documents Applications for OX Drive the associated permission has to be set.

The default setting for all users is changed in the file '''documents.properties''' in the directory ''/opt/open-xchange/etc''.

After installation the functionality is disabled:
<pre>
# Enables or disables the "text" module capability globally.
# com.openexchange.capability.text=true

# Enables or disables the "spreadsheet" module capability globally.
# com.openexchange.capability.spreadsheet=true

# Enables or disables the "presentation" module capability globally.
# com.openexchange.capability.presentation=true

</pre>

The following line enables the functionality:
<pre>
# Enables or disables the "text" module capability globally.
com.openexchange.capability.text=true
</pre>

Starting with 7.6.2, you can disable the text portal app. In '''permissions.properties''':
<pre>
permissions=textportaldisabled
</pre>

=== Spell Checking===

Spell checking has to be configured in the file ''/opt/open-xchange/etc/hunspell.properties''.
The values for the shared library file and dictionary path have to be set according to the platform.

This example shows the values for Debian:

<pre>
# The name and location of the hunspell library
# Default value: "/usr/lib/x86_64-linux-gnu/libhunspell-1.3.so.0"
com.openexchange.spellchecker.hunspell.library=/usr/lib64/libhunspell-1.2.so.0
# The location of the dictionaries
# Default value: "/usr/share/hunspell"
com.openexchange.spellchecker.hunspell.dictionaries=/usr/share/hunspell
</pre>

=== Templates ===

OX Documents support different levels to provide document templates for users.

A number of ready-to-use templates for letters, memos, resumes, home budget, presentations, etc is included with the system. These templates are made available in a directory at each system node by installation of the package open-xchange-documents-templates. The path to this directory is defined in the office.properties file

<pre>
# Defines the absolute path where document templates are located inside the local (!) file system.
# The templates are displayed in the documents applications.
# If this property is missing a default '/opt/open-xchange/templates/documents' is taken.
io.ox/office//module/templatePath = /opt/open-xchange/templates/documents
</pre>

The content in the directory specified by the path must comply to the following rules:

<pre>
/opt/open-xchange/templates/documents
|
----> text [application type]
| |
| ----> en-US [language-region]
| |
| ----> en [language fallback, en is also fallback for all other non-convered languages]
| |
| ----> de-DE
| |
| ----> de
| |
| ----> common [language independent, used in addition to the language specific ones]
|
----> spreadsheet
|
----> presentation
</pre>

A context administrator can additionally provide global templates for all users in the same context.
If logged in with this role folders can be added to or removed from the list of global template folders. For regular users the list is displayed without the permission to modify it.

[[File:template-folder.png|border|600px|caption]]

Users can create and manage their own templates. These user templates are stored and retrieved from the user’s root folder (“My files”). In addition to the root folder the user can define more template folders, sub-folders or even external folders in the “Documents” section of the “Settings” menu. This helps to organize templates and allows cleanup of the root folder by removal of templates.

For installations of OX Spreadsheet based on Appsuite 7.8.0 and 7.8.1 please see [http://oxpedia.org/wiki/index.php?title=AppSuite:Spreadsheet_Installation_Guide_7_8_1 here] for different installation modes.

AppSuite:Documents Installation Guide 7.10.2 and earlier

2016-11-15T10:55:27Z

Mhollmichel:

{{Version|7.8.3}}

= Download & Installation OX Documments =

== Requirements ==

See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.

OX Documents needs to be installed in an OX App Suite configuration with a [[AppSuite:Grizzly|backend based on Grizzly]] (including hazelcast as installed and activated by default).

For compatibility with the legacy MS binary format files (.DOC, .XLS, .PPT) and for printing functionality in OX Text the document converter components (incl. readerengine) are required. These are not available in the Community Version of OX AppSuite.

== Mandatory Modules ==

Additional functional modules need to be installed separately:

* The Document Converter API: See [[AppSuite:DocumentConverterAPIInstall|Document converter API installation instructions]]

== Installation ==

The OX Documents deployment consists of the packages <tt>open-xchange-documents-backend</tt> and <tt>open-xchange-documents-ui</tt>. The <tt>open-xchange-documents-backend</tt> package also requires and installs these packages:

* <tt>open-xchange-realtime-core</tt>
* <tt>open-xchange-realtime-json</tt>
* <tt>open-xchange-file-distribution</tt>
* <tt>open-xchange-sessionstorage-hazelcast</tt>

=== Redhat Enterprise Linux 6 or CentOS 6 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}
$ yum install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Redhat Enterprise Linux 7 or CentOS 7 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL7|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ yum install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 7.0 ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 8.0 ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianJessie|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== SUSE Linux Enterprise Server 11 ===

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLES11|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLES11|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ zypper ref
$ zypper install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== SUSE Linux Enterprise Server 12 ===

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|office|office-web|documentconverter-api}}

if you have a valid maintenance subscription, please add also following repositories by replacing the credentials.

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=susename|pc2v=SLE_12|pc3n=ldbaccount|pc3v=LDBUSER:LDBPASSWORD|office/updates|office-web/updates|documentconverter-api/updates}}

$ zypper ref
$ zypper install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Univention Corporate Server ===

OX Text for OX App Suite for UCS is available in the Univention App Center. Please check the UMC module App Center for the installation of the OX Documents at your already available environment.

== Printing and legacy MS binary formats Editing ==

For .DOC/.XLS/.PPT and/or printing support from OX Documents the Document Converter and readerengine components have to be installed separately (license key required)

* See [[AppSuite:DocumentConverterInstall|Document converter / readerengine installation instructions]]

== Spell Checking ==

OX Text and OX Presentation are able to use ''hunspell'' for spell checking functionality.

After installation of the ''hunspell'' package for your platform the shared library and the US English dictionaries are available.

Additional dictionaries are published for your platform as packages hunspell-de-de, hunspell-fr, ...

== Monitoring ==

OX Documents offers runtime information via JMX about the document editors as well as the OX Documentconverter. This [[AppSuite:DocumentsMonitoring|article]] guides to the information how to access JMX data, configure and use Jolokia and integrate with munin.

== Configuration ==

=== Permissions ===

To enable the OX Documents Applications for OX Drive the associated permission has to be set.

The default setting for all users is changed in the file '''documents.properties''' in the directory ''/opt/open-xchange/etc''.

After installation the functionality is disabled:
<pre>
# Enables or disables the "text" module capability globally.
# com.openexchange.capability.text=true

# Enables or disables the "spreadsheet" module capability globally.
# com.openexchange.capability.spreadsheet=true

# Enables or disables the "presentation" module capability globally.
# com.openexchange.capability.presentation=true

</pre>

The following line enables the functionality:
<pre>
# Enables or disables the "text" module capability globally.
com.openexchange.capability.text=true
</pre>

Starting with 7.6.2, you can disable the text portal app. In '''permissions.properties''':
<pre>
permissions=textportaldisabled
</pre>

=== Spell Checking===

Spell checking has to be configured in the file ''/opt/open-xchange/etc/hunspell.properties''.
The values for the shared library file and dictionary path have to be set according to the platform.

This example shows the values for Debian:

<pre>
# The name and location of the hunspell library
# Default value: "/usr/lib/x86_64-linux-gnu/libhunspell-1.3.so.0"
com.openexchange.spellchecker.hunspell.library=/usr/lib64/libhunspell-1.2.so.0
# The location of the dictionaries
# Default value: "/usr/share/hunspell"
com.openexchange.spellchecker.hunspell.dictionaries=/usr/share/hunspell
</pre>

=== Templates ===

OX Documents support different levels to provide document templates for users.

A number of ready-to-use templates for letters, memos, resumes, home budget, presentations, etc is included with the system. These templates are made available in a directory at each system node by installation of the package open-xchange-documents-templates. The path to this directory is defined in the office.properties file

<pre>
# Defines the absolute path where document templates are located inside the local (!) file system.
# The templates are displayed in the documents applications.
# If this property is missing a default '/opt/open-xchange/templates/documents' is taken.
io.ox/office//module/templatePath = /opt/open-xchange/templates/documents
</pre>

The content in the directory specified by the path must comply to the following rules:

<pre>
/opt/open-xchange/templates/documents
|
----> text [application type]
| |
| ----> en-US [language-region]
| |
| ----> en [language fallback, en is also fallback for all other non-convered languages]
| |
| ----> de-DE
| |
| ----> de
| |
| ----> common [language independent, used in addition to the language specific ones]
|
----> spreadsheet
|
----> presentation
</pre>

A context administrator can additionally provide global templates for all users in the same context.
If logged in with this role folders can be added to or removed from the list of global template folders. For regular users the list is displayed without the permission to modify it.

[[File:template-folder.png|border|600px|caption]]

Users can create and manage their own templates. These user templates are stored and retrieved from the user’s root folder (“My files”). In addition to the root folder the user can define more template folders, sub-folders or even external folders in the “Documents” section of the “Settings” menu. This helps to organize templates and allows cleanup of the root folder by removal of templates.

For installations of OX Spreadsheet based on Appsuite 7.8.0 and 7.8.1 please see [http://oxpedia.org/wiki/index.php?title=AppSuite:Spreadsheet_Installation_Guide_7_8_1 here] for different installation modes.

2014-06-12T11:25:37Z

Mhollmichel:

SourceCodeAccess

2014-04-03T13:18:36Z

Mhollmichel: add documentconverter-api, calcengine

= How to download the Open-Xchange Server source code (6.22.0 and later) =

Starting with 6.22 the source code of Open-Xchange server is available from our Git repository.

The following repositories exist:

{| border="1" cellspacing="0" cellpadding="5" align="center"
! Repository
! content
|-
| wd/backend
| The main repository containing most of the parts of Open-Xchange server
|-
| frontend6
| The AJAX user interface (version 6)
|-
| wd/frontend/web
| The AJAX user interface of OX AppSuite
|-
| documentconverter-api
| The API of the server-based part of the documentconverter needed for OX Text
|-
| office
| The server-code for OX Text and OX Spreadsheet
|-
| office-web
| The frontend-code for OX Text and OX Spreadsheet
|-
| calcengine
| The C++, Apache OpenOffice based calc engine
|-
|}

== Git operations to access the code ==

To clone a repository, run

$ git clone http://code.open-xchange.com/git/<repository>
$ cd <repository>
$ git checkout -t origin/<branch>

== The currently used Git branches ==

For a list of available branches, run

$ git branch -r

The main development process uses the following branches:

{| border="1" cellspacing="0" cellpadding="5" align="center"
! Git branch
! content
|-
| develop
| head development
|-
| release-<version>
| stabilizing for <version> release
|-
| master
| maintenance of previous releases
|-
|}

= How to download the Open-Xchange Server source code (6.20.7 and earlier) =

The source code of Open-Xchange Server up to and including version 6.20.7 is available using cvs access and source packages. Please make sure to use an up-to-date CVS client (cvs > 1.12) to check out the repositories. Integrated CVS clients e.g. for current Eclipse version work well, too.

== The currently maintained cvs repositories ==

{| border="1" cellspacing="0" cellpadding="5" align="center"
! Repository
! content
|-
| open-xchange
| the main repository containing most of the parts of Open-Xchange server
|-
| open-xchange-gui
| The AJAX user interface
|-
| open-xchange-admin
| the Open-Xchange admin daemon used for provisioning (user creation, etc.)
|-
| open-xchange-admin-plugin-hosting
| contains the commandline tools and the oxinstaller
|-
| open-xchange-admin-soap
| SOAP interface
|-
|}

== CVS operations to access the code ==

To see a complete list of Open-Xchange cvs repositories, run the following command:

$ cvs -d :pserver:anonymous@www.open-xchange.com:/cvsroot rls

Note, however, that only the repositories as listed above are actively maintained.

To check out a repository, run

$ cvs -d :pserver:anonymous@www.open-xchange.com:/cvsroot co open-xchange/com.openexchange.authentication.ldap

to check out the ldap authentication plugin.

== Organization of the open-xchange repository ==

The open-xchange repository contains several [http://en.wikipedia.org/wiki/OSGi OSGi] bundles which are the building block of the Open-Xchange server package.
Each of them has an [http://ant.apache.org/ ant] <tt>build.xml</tt> file containing a target to create a source tarball and a subdirectory called <tt>packaging</tt> which contains the package metadata to build [http://en.wikipedia.org/wiki/Deb_(file_format) DEB] and [http://en.wikipedia.org/wiki/RPM_Package_Manager RPM] packages.

[[Category: OX6]]

AppSuite:CalcengineInstall

2014-03-31T15:15:13Z

Mhollmichel:

= Description =

The calcengine is necessary to use spreadsheet functionality. The calcengine is licensed under Apache License 2.0, so all our other code is able to use it.

{{InstallPlugin|pluginname=calcengine|toplevel=components|sopath=calcengine/7.4.2|version=App Suite|reponame=calcengine}}

[[Category:AppSuite]]
[[Category:Administrator]]

AppSuite:Spreadsheet Installation Guide

2014-03-31T15:10:21Z

Mhollmichel:

= Download & Installation OX Spreadsheet =

== General Information ==
OX Spreadsheet is a browser based, cloud ready, spreadsheet product that can work with Microsoft Excel documents in a lossless way. And you can also collaborate with other people to edit shared spreadsheets on various devices.

Learn more about the highlights of OX Spreadsheet here: http://software.open-xchange.com/products/appsuite/doc/OX_Spreadsheet_Product_Guide.pdf

== Requirements ==

See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.

OX Spreadsheet (Beta) needs to be installed in an OX App Suite configuration with a [[AppSuite:Grizzly|backend based on Grizzly]].

For compatibility with XLS files (not XLSX) and for printing functionality in OX Spreadsheet (Beta) the document converter components (incl. readerengine) are required. These are not available in the Community Version of OX AppSuite.

== Mandatory Modules ==

Additional functional modules need to be installed separately:

* The Document Converter API: See [[AppSuite:DocumentConverterAPIInstall|Document converter API installation instructions]]

* The calcengine: See [[AppSuite:CalcengineInstall|calcengine installation instructions]]

== Installation ==

The OX Spreadsheet deployment consists of the packages <tt>open-xchange-documents-backend</tt>,<tt>open-xchange-documents-ui</tt> and <tt>open-xchange-documents-ui-static</tt>

=== Redhat Enterprise Linux 6 or CentOS 6 ===

Add the following repositories to your Open-Xchange yum configuration:

{{for loop||call=YUMRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=rhelname|pc2v=RHEL6|office|office-web}}

$ yum install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 6.0 ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianSqueeze|office|office-web}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== Debian GNU/Linux 7.0 ===

Add the following repositories to your Open-Xchange apt configuration:

{{for loop||call=APTRepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc2n=debianname|pc2v=DebianWheezy|office|office-web}}

$ apt-get update
$ apt-get install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

=== SUSE Linux Enterprise Server 11 ===

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc3n=susename|pc3v=SLES11|office|office-web}}

$ zypper ref
$ zypper install open-xchange-documents-backend open-xchange-documents-ui open-xchange-documents-ui-static

== Printing and .xls Editing ==

For .XLS and/or printing support from OX Spreadsheet the Document Converter and readerengine components have to be installed separately (license key required)

* See [[AppSuite:DocumentConverterInstall|Document converter / readerengine installation instructions]]

== Configuration ==

=== Permissions ===

To enable OX Spreadsheet for OX Drive the associated permission has to be set.

The default setting for all users is changed in the file '''permissions.properties''' in the directory ''/opt/open-xchange/etc''.

After installation the functionality is disabled:
<pre>
# Default permissions for all users
permissions=
</pre>

The following line enables the functionality:
<pre>
# Default permissions for all users
permissions=spreadsheet
</pre>

If there are already some permissions in this file, add ''spreadsheet'' separated with a comma.

=== calcengine ===

The calcengine has to be configured in the file ''/opt/open-xchange/etc/calcengine.properties''.

<pre>
# -----------------------------------------------------------------------------
# define the mode the calc engine will use at runtime
#
# possible values :
#
# - local
# a set of worker processes are used at localhost;
# One worker = one calc engine process.
# JNI is used within worker process - not within main process.
#
# - http
# calc engine client will connect to a remote server
# where a calc engine server is running.
# Every calc engine server will host a set of worker processes.
# Communication protocol between client<->server<->worker is HTTP.
#
calcengine.mode=local

# -----------------------------------------------------------------------------
# timeout to detect hanging calc engine request
#
# unit = [ms]
# default = 20s

calcengine.request.timeout=20000

# -----------------------------------------------------------------------------
# define the max. value for memory reserved for one worker instance.
#
# Each worker will use that value separately.
# So the memory consumption for the whole pool of worker instances
# will be : pool-size * worker.memory.
#
# unit=[MB]
#
# default = 2048

calcengine.worker.memory.max-mb=2048

# -----------------------------------------------------------------------------
# configure restart of one worker in case more then X documents was opened
# within those process.
#
# Note:
#
# - A value of 0 means -> these restart trigger is disabled
# ... where might other restart trigger can be active.
#
# - Don't forget to configure reserve count value too
# if you configure these restart trigger.
#
# default = 50

calcengine.worker.restart.trigger.max-doc-count=50

# -----------------------------------------------------------------------------
# timeout to detect non starting worker process
#
# unit = [ms]
# default = 20s

calcengine.worker.init.timeout=20000

# -----------------------------------------------------------------------------
# define the range of ports to be used for a pool of worker processes.
#
# Of course MIN and MAX values needs to be in right (ascending) order.
# If not - an error is shown and calc engine environment wont work.
#
# MIN and MAX port are included in range. So pool size is MAX-MIN+1.
#
# default = 5001 ... 5003

calcengine.worker.port_range.min=5001
calcengine.worker.port_range.max=5003
</pre>

AppSuite:ReaderEngineInstall

2014-03-06T13:06:45Z

Mhollmichel: /* Fonts for CentOS6 / RHEL6 */

= Description =

Readerengine is a document conversion engine based on OpenOffice. It contains some tunings special for our requirements, too. Additional there is implemented a completely new export filter for exporting any
doc type to SVG.

=System requirements=

All available readerengine packages need to be installed on the target machine running Linux 64bit that is used for hosting the OX Document Converter.

{{InstallPlugin|pluginname=readerengine-writer|toplevel=products|sopath=appsuite/stable/readerengine|version=App Suite|reponame=readerengine|ldbaccount=LDBUSER:LDBPASSWORD}}

==Fonts for Debian==

Thumbnails and preview of documents are rendered on the server instance of the readerengine. For good results some standard fonts are required. For Appsuite < 7.4.2 the appropriate font packages should be installed.

* ttf-opensymbol (Bullets and Symbols)
* ttf-liberation (Aral, Times New Roman, Courier New)
* ttf-dejavu
* ttf-ipafont-jisx0208 (Asian fonts)
* ttf-arphic-uming ttf-wqy-zenhei ttf-sazanami-mincho ttf-sazanami-gothic ttf-unfonts-core
* t1-thai-arundina

apt-get install ttf-opensymbol ttf-liberation ttf-dejavu ttf-ipafont-jisx0208 ttf-arphic-uming \
ttf-wqy-zenhei ttf-sazanami-mincho ttf-sazanami-gothic ttf-unfonts-core t1-thai-arundina

Since Appsuite 7.4.2 the readerengine comes with the packages open-xchange-documents-fonts which includes an appropriate set of fonts.

==Fonts for CentOS6 / RHEL6 ==

yum install liberation-fonts-common liberation-mono-fonts liberation-sans-fonts liberation-serif-fonts \
libreoffice-opensymbol-fonts vlgothic-fonts vlgothic-fonts-common vlgothic-p-fonts

Since Appsuite 7.4.2 the readerengine comes with the packages open-xchange-documents-fonts which includes an appropriate set of fonts.

2013-11-11T17:07:46Z

Mhollmichel: /* Fonts for CentOS6 / RHEL6 */

= Description =

Readerengine is a document conversion engine based on OpenOffice. It contains some tunings special for our requirements, too. Additional there is implemented a completely new export filter for exporting any
doc type to SVG.

=System requirements=

All available readerengine packages need to be installed on the target machine running Linux 64bit that is used for hosting the OX Document Converter.

{{InstallPlugin|pluginname=readerengine-writer|toplevel=products|sopath=appsuite/stable/readerengine|version=App Suite|reponame=readerengine|ldbaccount=LDBUSER:LDBPASSWORD}}

==Fonts for Debian==

Thumbnails and preview of documents are rendered on the server instance of the readerengine. For good results some standard fonts are required.

* ttf-opensymbol (Bullets and Symbols)
* ttf-liberation (Aral, Times New Roman, Courier New)
* ttf-dejavu
* ttf-ipafont-jisx0208 (Asian fonts)
* ttf-arphic-uming ttf-wqy-zenhei ttf-sazanami-mincho ttf-sazanami-gothic ttf-unfonts-core
* t1-thai-arundina

apt-get install ttf-opensymbol ttf-liberation ttf-dejavu ttf-ipafont-jisx0208 ttf-arphic-uming \
ttf-wqy-zenhei ttf-sazanami-mincho ttf-sazanami-gothic ttf-unfonts-core t1-thai-arundina

==Fonts for CentOS6 / RHEL6 ==

yum install liberation-fonts-common liberation-mono-fonts liberation-sans-fonts liberation-serif-fonts \
libreoffice-opensymbol-fonts vlgothic-fonts vlgothic-fonts-common vlgothic-p-fonts