Difference between revisions of "AppSuite:Spreadsheet Installation Guide"

(Requirements)
(new doc for release 7.8.0)
Line 1: Line 1:
= Download & Installation OX Spreadsheet =
 
  
== General Information ==
+
== Download & Installation OX Spreadsheet - DRAFT V.02 ==
 +
 
 +
=== 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.
 
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 OX Spreadsheet Product Guide]
+
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 ==
+
=== Requirements ===
  
 
See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.
 
See the [[AppSuite:OX_System_Requirements|Open-Xchange software requirements page]] for details.
  
OX Spreadsheet 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).
+
OX Spreadsheet 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 the document converter components (incl. readerengine) are required. These are not available in the Community Version of OX AppSuite.
 
For compatibility with XLS files (not XLSX) and for printing functionality in OX Spreadsheet the document converter components (incl. readerengine) are required. These are not available in the Community Version of OX AppSuite.
  
== Mandatory Modules ==
+
=== Installation Types ===
 
 
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 '''documents.properties''' in the directory ''/opt/open-xchange/etc''.
 
 
 
After installation the functionality is disabled:
 
<pre>
 
# Enables or disables the "spreadsheet" module capability globally.
 
#com.openexchange.capability.spreadsheet=true
 
</pre>
 
 
 
Uncomment the above line so that the capability is set to true.
 
 
 
Starting with 7.6.2, you can disable the spreadsheet portal app. In '''permissions.properties''':
 
<pre>
 
permissions=spreadsheetportaldisabled
 
</pre>
 
 
 
=== 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
 
 
 
# -----------------------------------------------------------------------------
 
# define the count of worker we use as reserve for exchanging 'dirty' worker instances.
 
#
 
# Note:
 
#
 
# - If reserve count is configured with 0 no pro-active restart of any worker will happen
 
#  ... excepting in error case.
 
#
 
# - Reserve count needs to be in sync with worker pool size.
 
#  Means : port range has to be higher then these reserve count.
 
#
 
# default = 1
 
 
 
calcengine.worker.restart.reserve-count=1
 
 
 
# -----------------------------------------------------------------------------
 
# 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 = 55s
 
 
 
calcengine.worker.init.timeout=55000
 
  
# -----------------------------------------------------------------------------
+
The following article give you a complete guide of necessary tasks with a hardware and setup recommendation for different Spreadsheet hosting environments:
# 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
+
*  [[AppSuite:Spreadsheet:Installation:Mode-Local|OX Spreadsheet deployment tutorial - Mode 'Local']]
calcengine.worker.port_range.max=5003
+
*  [[AppSuite:Spreadsheet:Installation:Mode-Server-Combined|OX Spreadsheet deployment tutorial - Mode 'Server Combined']]
</pre>
+
*  [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed|OX Spreadsheet deployment tutorial - Mode 'Server Distributed']]

Revision as of 07:35, 2 October 2015

Download & Installation OX Spreadsheet - DRAFT V.02

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: OX Spreadsheet Product Guide.

Requirements

See the Open-Xchange software requirements page for details.

OX Spreadsheet needs to be installed in an OX App Suite configuration with a backend based on Grizzly .

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

Installation Types

The following article give you a complete guide of necessary tasks with a hardware and setup recommendation for different Spreadsheet hosting environments: