View source for AppSuite:Text Installation Guide 7 8 0

{{Version|7.8.0}}
{{Version|7.8.1}}
= Download & Installation OX Text =


== Requirements ==

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

OX Text 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 DOC files (not DOCX) 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 Text deployment consists of the packages <tt>open-xchange-documents-backend</tt> and <tt>open-xchange-documents-ui</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|calcengine}}

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|calcengine/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|calcengine}}

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|calcengine/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|calcengine}}

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|calcengine/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|calcengine}}

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|calcengine/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|calcengine}}

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|calcengine/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|calcengine}}

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|calcengine/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 Text at your already available environment.

== Printing and .doc Editing ==

For .DOC and/or printing support from OX Text 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 is 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, ...

== Configuration ==

=== Permissions ===

To enable OX Text 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
</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 Text and OX Spreadsheet support different levels to provide document templates for users.

A number of ready-to-use templates for letters, memos, resumes, home budget, 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
</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.