Open-Xchange - User contributions [en]

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:RedHat-7

2015-10-02T11:10:19Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on RedHat Enterprise Linux 7 - Mode 'Server Distributed' - Nature 'CE-Worker' ==

=== Preparation ===

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|backend|office-communication|calcengine}}

=== Installation ===

Install all required packages:

<source lang="bash">

$ yum install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:RedHat-6

2015-10-02T11:09:46Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on RedHat Enterprise Linux 6 - Mode 'Server Distributed' - Nature 'CE-Worker' ==

=== Preparation ===

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|backend|office-communication|calcengine}}

=== Installation ===

Install all required packages:

<source lang="bash">

$ yum install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:SLE 12

2015-10-02T11:09:10Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on SUSE Linux Enterprise Server 12 - Mode 'Server Distributed' - Nature 'CE-Worker' ==

=== Preparation ===

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

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc3n=susename|pc3v=SLE_12|backend|office-communication|calcengine}}

=== Installation ===

Install all required packages:

<source lang="bash">

$ zypper ref
$ zypper install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:SLESS-11

2015-10-02T11:08:35Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on SUSE Linux Enterprise Server 11 - Mode 'Server Distributed' - Nature 'CE-Worker' ==

=== Preparation ===

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

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

=== Installation ===

Install all required packages:

<source lang="bash">

$ zypper ref
$ zypper install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:Debian-8.0

2015-10-02T11:07:59Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on Debian GNU/Linux 8.0 - Mode 'Server Distributed' - Nature 'CE-Worker' ==

=== Preparation ===

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|backend|office-communication|calcengine}}

=== Installation ===

Install all required packages:

<source lang="bash">

$ apt-get update
$ apt-get install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:Debian-7.0

2015-10-02T11:07:23Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on Debian GNU/Linux 7.0 - Mode 'Server Distributed' - Nature 'CE-Worker' ==

=== Preparation ===

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|backend|office-communication|calcengine}}

=== Installation ===

Install all required packages:

<source lang="bash">

$ apt-get update
$ apt-get install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:Debian-6.0

2015-10-02T11:06:47Z

Andreas.schluens: new

== OX Spreadsheet on Debian GNU/Linux 6.0 - Mode 'Server Distributed' - Nature 'CE-Worker' ==

=== Preparation ===

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|backend|office-communication|calcengine}}

=== Installation ===

Install all required packages:

<source lang="bash">

$ apt-get update
$ apt-get install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:RedHat-7

2015-10-02T11:05:49Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on RedHat Enterprise Linux 7 - Mode 'Server Distributed' - Nature 'CE-Server' ==

=== Preparation ===

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|backend|office-communication|calcengine}}

=== Installation ===

Install all required packages:

<source lang="bash">

$ yum install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:RedHat-6

2015-10-02T11:05:15Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on RedHat Enterprise Linux 6 - Mode 'Server Distributed' - Nature 'CE-Server' ==

=== Preparation ===

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|backend|office-communication|calcengine}}

=== Installation ===

Install all required packages:

<source lang="bash">

$ yum install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:SLE 12

2015-10-02T11:04:36Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on SUSE Linux Enterprise Server 12 - Mode 'Server Distributed' - Nature 'CE-Server' ==

=== Preparation ===

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

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc3n=susename|pc3v=SLE_12|backend|office-communication|calcengine}}

=== Installation ===

Install all required packages:

<source lang="bash">

$ zypper ref
$ zypper install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:SLES-11

2015-10-02T11:04:03Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on SUSE Linux Enterprise Server 11 - Mode 'Server Distributed' - Nature 'CE-Server' ==

=== Preparation ===

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

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

=== Installation ===

Install all required packages:

<source lang="bash">

$ zypper ref
$ zypper install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:Debian-8.0

2015-10-02T11:03:30Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on Debian GNU/Linux 8.0 - Mode 'Server Distributed' - Nature 'CE-Server' ==

=== Preparation ===

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|backend|office-communication|calcengine}}

=== Installation ===

Install all required packages:

<source lang="bash">

$ apt-get update
$ apt-get install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:Debian-7.0

2015-10-02T11:02:59Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on Debian GNU/Linux 7.0 - Mode 'Server Distributed' - Nature 'CE-Server' ==

=== Preparation ===

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|backend|office-communication|calcengine}}

=== Installation ===

Install all required packages:

<source lang="bash">

$ apt-get update
$ apt-get install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:Debian-6.0

2015-10-02T11:02:29Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on Debian GNU/Linux 6.0 - Mode 'Server Distributed' - Nature 'CE-Server' ==

=== Preparation ===

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|backend|office-communication|calcengine}}

=== Installation ===

Install all required packages:

<source lang="bash">

$ apt-get update
$ apt-get install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Combined

2015-10-02T10:59:55Z

Andreas.schluens: add arch images

== Tutorial : OX Spreadsheet deployment - Mode 'Server Combined' ==

=== General Information ===

This article describes what you need for an OX Spreadsheet setup - the Server installation.

It contains everything you need to:
* Understand the design of the OX Spreadsheet setup including additional services
* Install the whole system based on the relevant articles
* Find pointers to the next steps of integration

=== System Design ===

[[File:AppSuite-Spreadsheet-Installation-Mode-Server-Combined-Physical-Architecture.jpg]]
[[File:AppSuite-Spreadsheet-Installation-Mode-Server-Combined-Logical-Architecture.jpg]]

The system is designed to provide basic functionality and availability with a minimum of necessary hardware. If the services on one OX server fail, this is NOT transparently handled by other machines.

=== Core Components ===

* Nx OX AppSuite (HW recommendation: 16GB RAM / 4 cores) running as OX Appsuite Backend & OX Spreadsheet Client (follow the instructions regarding Nature 'OX-Backend')
* 1x OX Spreadsheet Server (HW recommendation: 24GB RAM / 4 cores) (follow the instructions regarding Nature 'CE-Server')
* Optional: Nx OX Spreadsheet Worker (HW recommendation: 24GB RAM / 4 cores) (see [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed|OX Spreadsheet Server - Mode 'Server Distributed']] )

=== Overview Installation Steps ===

To deploy the described OX Spreadsheet setup, the following steps need to be done.

''Mandatory Installation Steps''

* Install OX Appsuite - Nature 'OX-Backend'
* Install OX Spreadsheet Server - Nature 'CE-Server'

''Configuration Steps''

* Configure OX Appsuite - Nature 'OX-Backend'
* Configure OX Spreadsheet Server - Nature 'CE-Server'

''Start & Stop''

* Start/Stop OX Appsuite - Nature 'OX-Backend'
* Start/Stop OX Spreadsheet Server - Nature 'CE-Server'

=== Mandatory Installation Steps - Instructions & Recommendations ===

=== Install OX Appsuite - Nature 'OX-Backend' ===

The following steps need to be done to get OX Spreadsheet Client up and running:

* [[AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-OX-Backend:Debian-6.0|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-OX-Backend:Debian-7.0|Download and Installation Guide for Debian GNU/Linux 7.0 (Wheezy)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-OX-Backend:Debian-8.0|Download and Installation Guide for Debian GNU/Linux 8.0 (Jessie)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-OX-Backend:SLES-11|Download and Installation Guide for SUSE Linux Enterprise Server 11]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-OX-Backend:SLE_12|Download and Installation Guide for SUSE Linux Enterprise Server 12]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-OX-Backend:RedHat-6|Download and Installation Guide for RedHat Enterprise Linux 6]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-OX-Backend:RedHat-7|Download and Installation Guide for RedHat Enterprise Linux 7]]

=== Install OX Spreadsheet Server - Nature 'CE-Server' ===

The following steps need to be done to get OX Spreadsheet Server up and running:

* [[AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-CE-Server:Debian-6.0|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-CE-Server:Debian-7.0|Download and Installation Guide for Debian GNU/Linux 7.0 (Wheezy)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-CE-Server:Debian-8.0|Download and Installation Guide for Debian GNU/Linux 8.0 (Jessie)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-CE-Server:SLES-11|Download and Installation Guide for SUSE Linux Enterprise Server 11]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-CE-Server:SLE_12|Download and Installation Guide for SUSE Linux Enterprise Server 12]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-CE-Server:RedHat-6|Download and Installation Guide for RedHat Enterprise Linux 6]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-CE-Server:RedHat-7|Download and Installation Guide for RedHat Enterprise Linux 7]]

=== Configuration Steps - Instructions & Recommendations ===

=== Configure OX Appsuite - Nature 'OX-Backend' ===

After installation the OX Spreadsheet functionality is disabled by default. To enable OX Spreadsheet Application the associated permission has to be set. The default setting for all users is changed in the file'''''/opt/open-xchange/etc/permissions.properties'''''.

<source lang="ini">

# Note:
# This list is a comma seperated list of different permissions.
# Add or remove the permission you want to change - leave other permissions unchanged.

permissions=..,spreadsheet,..

</source>

By enabling the OX Spreadsheet Application the corresponding OX Spreadsheet Portal was enabled also. If that is not intended you can disable the OX Spreadsheet Portal within the same configuration file'''''/opt/open-xchange/etc/permissions.properties''''':

<source lang="ini">

# Note:
# This list is a comma seperated list of different permissions.
# Add or remove the permission you want to change - leave other permissions unchanged.

permissions=..,spreadsheet,spreadsheetportaldisabled,..

</source>

Enable client mode at this node inside configuration file'''''/opt/open-xchange/etc/calcengine.properties''''':

<source lang="ini">

# -----------------------------------------------------------------------------
# define the mode the calc engine will use at runtime.
...
# - jms
# all involved processes will look for a JMS server to communicate together.
...
#

calcengine.mode=jms

</source>

The OX Spreadsheet Client needs to know where the OX Spreadsheet Server is running. But the client is not connected to the server directly. As communication channel between both nodes JMS is used.

The OX Spreadsheet Server acts as a JMS Server also. Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-combined/nature-ox-backend/jms-server.properties''''' to generate a suitable configuration at'''''/opt/open-xchange/etc/documents/jms-server.properties''''' and replace all place holder following the schema'''''%%[...]%%'''''.

Note: All place holder values must be in sync with all other configuration files within the same setup.

<source lang="ini">

# =============================================================================
# NOTE : DO NOT USE DEFAULT VALUES WITHIN THIS SCRIPT AS THEY COME FROM THE CODE.
# ACTIVATE AND CHANGE VALUES IF NEEDED ONLY.

# -----------------------------------------------------------------------------
# define the host (IP/DNS) where the jms server is running and we have to
# be connected with
#
# default=127.0.0.1
#
jms.server.host=%%[CE_SERVER_IP]%%

# -----------------------------------------------------------------------------
# define the port where the server should listen for incoming requests
# or a client can be connected with those server.
#
# default=61616
#
#jms.server.port=61616

</source>

The OX Spreadsheet Server acts as a Cache Server also. Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-combined/nature-ox-backend/cache-server.properties''''' to generate a suitable configuration at'''''/opt/open-xchange/etc/documents/cache-server.properties''''' and replace all place holder following the schema'''''%%[...]%%'''''.

Note: All place holder values must be in sync with all other configuration files within the same setup.

<source lang="ini">

# =============================================================================
# NOTE : DO NOT USE DEFAULT VALUES WITHIN THIS SCRIPT AS THEY COME FROM THE CODE.
# ACTIVATE AND CHANGE VALUES IF NEEDED ONLY.

# -----------------------------------------------------------------------------
# define the host (IP/DNS) where the jms server is running and we have to
# be connected with
#
# default=127.0.0.1
#
cache.server.host=%%[CE_SERVER_IP]%%

# -----------------------------------------------------------------------------
# define the port where the server should listen for incoming requests
# or a client can be connected with those server.
#
# default=7000
#
#cache.server.port=7000

# -----------------------------------------------------------------------------
# unique ID for this server instance.
# Can be used to separate multiple server instances on the same machine.
#
cache.server.id=%%[CE_SERVER_ID]%%

# -----------------------------------------------------------------------------
# password to join those cache server.
# Can be empty.
#
cache.server.password=%%[CE_SERVER_PASSWORD]%%

</source>

=== Configure OX Spreadsheet Server - Nature 'CE-Server' ===

The OX Spreadsheet Server host:
* 1x OX Spreadsheet Server
* Nx OX Spreadsheet Worker
* 1x JMS Server for communication
* 1x Cache Server for caching data

The OX Spreadsheet Server node host all worker processes where the real user documents are handled. So e.g. the persistence of such documents (usable for an automatic document recovery in case a worker was restarted) has to be configured at this node. Inside the configuration file'''''/opt/open-xchange/etc/calcengine.properties'''''define the following:

<source lang="ini">

# -----------------------------------------------------------------------------
# define the mode the calc engine will use at runtime
#
# - jms
# calc engine is a central JMS server to communicate with
# all configured worker processes even clustered on different machines.
#
calcengine.mode=jms

# -----------------------------------------------------------------------------
# path where worker can cache there documents to support auto-restore in case
# a worker crashed and will be reactivated.
#
# If this path is empty - auto-restore will be disabled.
#
# This value can use special variable $(TEMP) to place the cache
# within the temporary directory. Other variables are not supported.
#
# Note: This feature can be disabled by define an empty path only !
#
calcengine.restore-documents.path=${sys:java.io.tmpdir}/ox-ce-doc-cache

</source>

The JMS Server is running besides the OX Spreadsheet server. Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-combined/nature-ce-server/jms-server.properties''''' to generate a suitable configuration at'''''/opt/open-xchange/etc/documents/jms-server.properties''''' and replace all place holder following the schema'''''%%[...]%%'''''.

<source lang="ini">

# =============================================================================
# NOTE : DO NOT USE DEFAULT VALUES WITHIN THIS SCRIPT AS THEY COME FROM THE CODE.
# ACTIVATE AND CHANGE VALUES IF NEEDED ONLY.

# -----------------------------------------------------------------------------
# define the network interface where the server should listen for incoming requests.
#
# Possible values are:
# - 0.0.0.0 to allow all (internal and external) connections
# - 127.0.0.1 to allow local connections only
#
# default=127.0.0.1
#
jms.server.interface=0.0.0.0

# -----------------------------------------------------------------------------
# define the port where the server should listen for incoming requests
# or a client can be connected with those server.
#
# default=61616
#
#jms.server.port=61616

# -----------------------------------------------------------------------------
# define directory for storing persistent data
#
# Will be created automatically if it does not exists.
# If it's not defined persistence will be disabled.
#
# Note: Thise feature can be disabled by setting an empty path only !
#
#jms.server.persistence.dir=${sys:java.io.tmpdir}/ox-jms-embedded-server/persistence

# -----------------------------------------------------------------------------
# frequency where the JMS Garbage Collector (GC) should run
#
# unit=[ms]
# default=300000 (5min)
#
#jms.server.gc.frequency=300000

# -----------------------------------------------------------------------------
# the time a JMS resource (queue/topic) has to be inactive before it can
# will be removed by the GC
#
# unit=[ms]
# default=60000 (1min)
#
#jms.server.gc.inactive-timeout-before-gc=60000

</source>

The Cache Server is running besides the OX Spreadsheet server. Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-combined/nature-ce-server/cache-server.properties''''' to generate a suitable configuration at'''''/opt/open-xchange/etc/documents/cache-server.properties''''' and replace all place holder following the schema'''''%%[...]%%'''''.

<source lang="ini">

# =============================================================================
# NOTE : DO NOT USE DEFAULT VALUES WITHIN THIS SCRIPT AS THEY COME FROM THE CODE.
# ACTIVATE AND CHANGE VALUES IF NEEDED ONLY.

# -----------------------------------------------------------------------------
# define the network interface where the server should listen for incoming requests.
#
# Possible values are:
# - <IP_RANGE> to allow all (internal and external) connections
# - 127.0.0.1 to allow local connections only
#
# <IP_RANGE> example:
# IP of local machine is "192.168.0.1".
# A might suitable IP range can be "192.168.0.*"
#
# default=127.0.0.1
#
cache.server.interface=%%[CE_CLIENTS_IP_RANGE]%%

# -----------------------------------------------------------------------------
# define the port where the server should listen for incoming requests
# or a client can be connected with those server.
#
# default=7000
#
#cache.server.port=7000

# -----------------------------------------------------------------------------
# unique ID for this server instance.
# Can be used to separate multiple server instances on the same machine.
#
# default = 'default'
#
cache.server.id=%%[CE_SERVER_ID]%%

# -----------------------------------------------------------------------------
# password to join those cache server.
# Can be empty.
#
# default = 'xxx'
#
cache.server.password=%%[CE_SERVER_PASSWORD]%%

# -----------------------------------------------------------------------------
# define directory for storing persistent data
#
# Will be created automatically if it does not exists.
# If it's not defined persistence will be disabled.
#
# Note: To disable this feature define an empty path.
#
# default = '${sys:java.io.tmpdir}/ox-cache-server/${cache.server.id}/persistence'
#
#cache.server.persistence.dir=${sys:java.io.tmpdir}/ox-cache-server/${cache.server.id}/persistence

</source>

As a principle of this architecture all OX Spreadsheet Worker run in parallel to the OX Spreadsheet Server at the same machine. The min/max count of processes and further settings related to OX Spreadsheet Worker can be configured within the file '''''/opt/open-xchange/etc/documents/cluster-node.xml'''''.: Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-combined/nature-ce-server/cluster-node.xml'''''to create those file.

<source lang="xml">



<cluster>

<node>

<cache>


</cache>

<watchdog>





</watchdog>

<apps merge-operation="explicit">


<app id="jms-server">


</app>


<app id="cache-server">


</app>


<app id="calcengine-server">


</app>


<app id="calcengine-worker">


<start-mode>auto</start-mode>


<min-instances>10</min-instances>


<max-instances>10</max-instances>




</app>

</apps>
</node>
</cluster>

</source>

=== Start & Stop - Instructions & Recommendations ===

Note: In general the order of starting both nodes (OX Appsuite and OX Spreadsheet Server) is not important. An automatic reconnect feature guarantee a stable environment at runtime. On the other side it's more ease to analyze and locate errors inside the deployment if both nodes are started in a special order : OX Spreadsheet Server firstOX Appsuite then

=== Start/Stop OX Spreadsheet Server - Nature 'CE-Server' ===

The OX Spreadsheet Server can be controlled by the script'''''/etc/init.d/open-xchange-cluster-management'''''. The OX Backend is not installed and has not to be started on this node.

<source lang="bash">

# start OX Spreadsheet Server
/etc/init.d/open-xchange-cluster-management start

...

# check status of OX Spreadsheet Server
/etc/init.d/open-xchange-cluster-management status

...

# stop OX Spreadsheet Server
/etc/init.d/open-xchange-cluster-management stop

</source>

=== Start/Stop OX Appsuite - Nature 'OX-Backend' ===

The OX Spreadsheet Client is running within the OX Backend process. So it's enough to control those backend service by calling the script'''''/etc/init.d/open-xchange'''''.

<source lang="bash">

# start OX Backend
/etc/init.d/open-xchange start

...

# check status of OX Backend
/etc/init.d/open-xchange status

...

# stop OX Backend
/etc/init.d/open-xchange stop

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed

2015-10-02T10:59:02Z

Andreas.schluens: update images

== Tutorial : OX Spreadsheet deployment - Mode 'Server Distributed' ==

=== General Information ===

This article describes what you need for an OX Spreadsheet setup - in Mode 'Server Distributed'.

It contains everything you need to:
* Understand the design of the OX Spreadsheet setup including additional services
* Install the whole system based on the relevant articles
* Find pointers to the next steps of integration

=== System Design ===

[[File:AppSuite-Spreadsheet-Installation-Mode-Server-Distributed-Physical-Architecture.jpg]]
[[File:AppSuite-Spreadsheet-Installation-Mode-Server-Distributed-Logical-Architecture.jpg]]

The system is designed to provide maximum functionality and availability with a minimum of necessary hardware. If the services on one OX server fail, this is transparently handled by others within the same cluster.

=== Core Components ===

* Nx OX AppSuite (HW recommendation: 16GB RAM / 4 cores) running as OX Spreadsheet Client (follow the instructions regarding Nature 'OX-Backend')
* 1x OX Spreadsheet Server (HW recommendation: 8GB RAM / 2 cores) (follow the instructions regarding Nature 'CE-Server')
* Nx OX Spreadsheet Worker (HW recommendation: 24GB RAM / 4 cores) (follow the instructions regarding Nature 'CE-Worker')

=== Overview Installation Steps ===

To deploy the described OX Spreadsheet setup, the following steps need to be done.

''Mandatory Installation Steps''

* Install and configure OX Appsuite - Nature 'OX-Backend'
* Install and configure OX Spreadsheet Server - Nature 'CE-Server'
* Install and configure OX Spreadsheet Worker - Nature 'CE-Worker'

''Configuration Steps''

* Configure OX Appsuite - Nature 'OX-Backend'
* Configure OX Spreadsheet Server - Nature 'CE-Server'
* Configure OX Spreadsheet Worker - Nature 'CE-Worker'

''Start & Stop''

* Start/Stop OX Appsuite - Nature 'OX-Backend'
* Start/Stop OX Spreadsheet Server - Nature 'CE-Server'
* Start/Stop OX Spreadsheet Worker - Nature 'CE-Worker'

=== Mandatory Installation Steps - Instructions & Recommendations ===

=== Install and configure OX Appsuite - Nature 'OX-Bckend' ===

The following steps need to be done to get OX Spreadsheet Client up and running:

* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:Debian-6.0|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:Debian-7.0|Download and Installation Guide for Debian GNU/Linux 7.0 (Wheezy)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:Debian-8.0|Download and Installation Guide for Debian GNU/Linux 8.0 (Jessie)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:SLES-11|Download and Installation Guide for SUSE Linux Enterprise Server 11]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:SLE_12|Download and Installation Guide for SUSE Linux Enterprise Server 12]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:RedHat-6|Download and Installation Guide for RedHat Enterprise Linux 6]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:RedHat-7|Download and Installation Guide for RedHat Enterprise Linux 7]]

=== Install and configure OX Spreadsheet Server - Nature 'CE-Server' ===

The following steps need to be done to get OX Spreadsheet Server HA up and running:

* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:Debian-6.0|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:Debian-7.0|Download and Installation Guide for Debian GNU/Linux 7.0 (Wheezy)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:Debian-8.0|Download and Installation Guide for Debian GNU/Linux 8.0 (Jessie)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:SLES-11|Download and Installation Guide for SUSE Linux Enterprise Server 11]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:SLE_12|Download and Installation Guide for SUSE Linux Enterprise Server 12]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:RedHat-6|Download and Installation Guide for RedHat Enterprise Linux 6]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:RedHat-7|Download and Installation Guide for RedHat Enterprise Linux 7]]

=== Install and configure OX Spreadsheet Worker - Nature 'CE-Worker' ===

The following steps need to be done to get OX Spreadsheet Worker HA up and running:

* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:Debian-6.0|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:Debian-7.0|Download and Installation Guide for Debian GNU/Linux 7.0 (Wheezy)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:Debian-8.0|Download and Installation Guide for Debian GNU/Linux 8.0 (Jessie)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:SLESS-11|Download and Installation Guide for SUSE Linux Enterprise Server 11]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:SLE_12|Download and Installation Guide for SUSE Linux Enterprise Server 12]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:RedHat-6|Download and Installation Guide for RedHat Enterprise Linux 6]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:RedHat-7|Download and Installation Guide for RedHat Enterprise Linux 7]]

=== Configuration Steps - Instructions & Recommendations ===

=== Configure OX Appsuite - Nature 'OX-Backend' ===

After installation the OX Spreadsheet functionality is disabled by default. To enable OX Spreadsheet Application the associated permission has to be set. The default setting for all users is changed in the file'''''/opt/open-xchange/etc/permissions.properties'''''.

<source lang="ini">

# Note:
# This list is a comma seperated list of different permissions.
# Add or remove the permission you want to change - leave other permissions unchanged.

permissions=..,spreadsheet,..

</source>

By enabling the OX Spreadsheet Application the corresponding OX Spreadsheet Portal was enabled also. If that is not intended you can disable the OX Spreadsheet Portal within the same configuration file'''''/opt/open-xchange/etc/permissions.properties''''':

<source lang="ini">

# Note:
# This list is a comma seperated list of different permissions.
# Add or remove the permission you want to change - leave other permissions unchanged.

permissions=..,spreadsheet,spreadsheetportaldisabled,..

</source>

Enable client mode at this node inside configuration file'''''/opt/open-xchange/etc/calcengine.properties''''':

<source lang="ini">

# -----------------------------------------------------------------------------
# define the mode the calc engine will use at runtime
...
# - jms
# all involved processes will look for a JMS server to communicate together.
...
#

calcengine.mode=jms

</source>

The mode 'Server Distributed' was designed for scalability. This require a different handling of the load balancer strategy. Configure inside the configuration file'''''/opt/open-xchange/etc/calcengine.properties'''''the following:

<source lang="ini">

# -----------------------------------------------------------------------------
# define where and how the load balancer is running.
#
# - server-dynamic-router
# Its running at server side using the dynamic-router pattern.
# As dynamic-router only header of JMS messages are interpreted and used.
# Doing so not the whole JMS message needs to be submitted to the load balancer process.
#
# - client-embedded
# Its running embedded at client side. So it's not a dedicated process at server side.
# At least it's nothing more then a lookup into the registry of worker processes
# and a mapping of request to worker queues.
# This mode is very fast and scalable - but provides less feature then all other modes.
# E.g. re-queuing of messages in case worker is restarting is not provided.
#
# default = server-dynamic-router
#
calcengine.load-balancer.type=client-embedded

</source>

The OX Spreadsheet Client needs to know where the OX Spreadsheet Server is running. But the client is not connected to the server directly. As communication channel between both nodes JMS is used.

The OX Spreadsheet Server acts as a JMS Server also. Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-distributed/nature-ox-backend/jms-server.properties''''' to generate a suitable configuration at'''''/opt/open-xchange/etc/documents/jms-server.properties''''' and replace all place holder following the schema'''''%%[...]%%'''''.

Note: All place holder values must be in sync with all other configuration files within the same setup.

<source lang="ini">

# =============================================================================
# NOTE : DO NOT USE DEFAULT VALUES WITHIN THIS SCRIPT AS THEY COME FROM THE CODE.
# ACTIVATE AND CHANGE VALUES IF NEEDED ONLY.

# -----------------------------------------------------------------------------
# define the host (IP/DNS) where the jms server is running and we have to
# be connected with
#
# default=127.0.0.1
#
jms.server.host=%%[CE_SERVER_IP]%%

# -----------------------------------------------------------------------------
# define the port where the server should listen for incoming requests
# or a client can be connected with those server.
#
# default=61616
#
#jms.server.port=61616

</source>

The OX Spreadsheet Server acts as a Cache Server also. Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-distributed/nature-ox-backend/cache-server.properties''''' to generate a suitable configuration at'''''/opt/open-xchange/etc/documents/cache-server.properties''''' and replace all place holder following the schema'''''%%[...]%%'''''.

Note: All place holder values must be in sync with all other configuration files within the same setup.

<source lang="ini">

# =============================================================================
# NOTE : DO NOT USE DEFAULT VALUES WITHIN THIS SCRIPT AS THEY COME FROM THE CODE.
# ACTIVATE AND CHANGE VALUES IF NEEDED ONLY.

# -----------------------------------------------------------------------------
# define the host (IP/DNS) where the jms server is running and we have to
# be connected with
#
# default=127.0.0.1
#
cache.server.host=%%[CE_SERVER_IP]%%

# -----------------------------------------------------------------------------
# define the port where the server should listen for incoming requests
# or a client can be connected with those server.
#
# default=7000
#
#cache.server.port=7000

# -----------------------------------------------------------------------------
# unique ID for this server instance.
# Can be used to separate multiple server instances on the same machine.
#
cache.server.id=%%[CE_SERVER_ID]%%

# -----------------------------------------------------------------------------
# password to join those cache server.
# Can be empty.
#
cache.server.password=%%[CE_SERVER_PASSWORD]%%

</source>

=== Configure OX Spreadsheet Server - Nature 'CE-Server' ===

The OX Spreadsheet Server host:
* 1x JMS Server for communication
* 1x Cache Server for caching data

The mode 'Server Distributed' was designed for scalability. This require a different handling of the load balancer strategy. Configure inside the configuration file'''''/opt/open-xchange/etc/calcengine.properties'''''the following:

<source lang="ini">

# -----------------------------------------------------------------------------
# define the mode the calc engine will use at runtime
#
# - jms
# calc engine is a central JMS server to communicate with
# all configured worker processes even clustered on different machines.
#
calcengine.mode=jms

# -----------------------------------------------------------------------------
# define where and how the load balancer is running.
#
# - server-dynamic-router
# Its running at server side using the dynamic-router pattern.
# As dynamic-router only header of JMS messages are interpreted and used.
# Doing so not the whole JMS message needs to be submitted to the load balancer process.
#
# - client-embedded
# Its running embedded at client side. So it's not a dedicated process at server side.
# At least it's nothing more then a lookup into the registry of worker processes
# and a mapping of request to worker queues.
# This mode is very fast and scalable - but provides less feature then all other modes.
# E.g. re-queuing of messages in case worker is restarting is not provided.
#
# default = server-dynamic-router
#
calcengine.load-balancer.type=client-embedded

</source>

Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-distributed/nature-ce-server/jms-server.properties''''' to generate a suitable configuration at'''''/opt/open-xchange/etc/documents/jms-server.properties''''' and replace all place holder following the schema'''''%%[...]%%'''''.

<source lang="ini">

# =============================================================================
# NOTE : DO NOT USE DEFAULT VALUES WITHIN THIS SCRIPT AS THEY COME FROM THE CODE.
# ACTIVATE AND CHANGE VALUES IF NEEDED ONLY.

# -----------------------------------------------------------------------------
# define the network interface where the server should listen for incoming requests.
#
# Possible values are:
# - 0.0.0.0 to allow all (internal and external) connections
# - 127.0.0.1 to allow local connections only
#
# default=127.0.0.1
#
jms.server.interface=0.0.0.0

# -----------------------------------------------------------------------------
# define the port where the server should listen for incoming requests
# or a client can be connected with those server.
#
# default=61616
#
#jms.server.port=61616

# -----------------------------------------------------------------------------
# define directory for storing persistent data
#
# Will be created automatically if it does not exists.
# If it's not defined persistence will be disabled.
#
# Note: Thise feature can be disabled by setting an empty path only !
#
#jms.server.persistence.dir=${sys:java.io.tmpdir}/ox-jms-embedded-server/persistence

# -----------------------------------------------------------------------------
# frequency where the JMS Garbage Collector (GC) should run
#
# unit=[ms]
# default=300000 (5min)
#
#jms.server.gc.frequency=300000

# -----------------------------------------------------------------------------
# the time a JMS resource (queue/topic) has to be inactive before it can
# will be removed by the GC
#
# unit=[ms]
# default=60000 (1min)
#
#jms.server.gc.inactive-timeout-before-gc=60000

</source>

Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-distributed/nature-ce-server/cache-server.properties''''' to generate a suitable configuration at'''''/opt/open-xchange/etc/documents/cache-server.properties''''' and replace all place holder following the schema'''''%%[...]%%'''''.

<source lang="ini">

# =============================================================================
# NOTE : DO NOT USE DEFAULT VALUES WITHIN THIS SCRIPT AS THEY COME FROM THE CODE.
# ACTIVATE AND CHANGE VALUES IF NEEDED ONLY.

# -----------------------------------------------------------------------------
# define the network interface where the server should listen for incoming requests.
#
# Possible values are:
# - <IP_RANGE> to allow all (internal and external) connections
# - 127.0.0.1 to allow local connections only
#
# <IP_RANGE> example:
# IP of local machine is "192.168.0.1".
# A might suitable IP range can be "192.168.0.*"
#
# default=127.0.0.1
#
cache.server.interface=%%[CE_CLIENTS_IP_RANGE]%%

# -----------------------------------------------------------------------------
# define the port where the server should listen for incoming requests
# or a client can be connected with those server.
#
# default=7000
#
#cache.server.port=7000

# -----------------------------------------------------------------------------
# unique ID for this server instance.
# Can be used to separate multiple server instances on the same machine.
#
# default = 'default'
#
cache.server.id=%%[CE_SERVER_ID]%%

# -----------------------------------------------------------------------------
# password to join those cache server.
# Can be empty.
#
# default = 'xxx'
#
cache.server.password=%%[CE_SERVER_PASSWORD]%%

# -----------------------------------------------------------------------------
# define directory for storing persistent data
#
# Will be created automatically if it does not exists.
# If it's not defined persistence will be disabled.
#
# Note: To disable this feature define an empty path.
#
# default = '${sys:java.io.tmpdir}/ox-cache-server/${cache.server.id}/persistence'
#
#cache.server.persistence.dir=${sys:java.io.tmpdir}/ox-cache-server/${cache.server.id}/persistence

</source>

The OX Spreadsheet Server - Mode 'Server Distributed' do not run OX Spreadsheet Worker locally. They have to be disabled. This and other apsects of this setup can be configured within the file'''''/opt/open-xchange/etc/documents/cluster-node.xml''''': Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-distributed/nature-ce-server/cluster-node.xml'''''to create those file.

<source lang="xml">



<cluster>

<node>

<cache>


</cache>

<watchdog>





</watchdog>

<apps merge-operation="explicit">


<app id="jms-server">


</app>


<app id="cache-server">


</app>





</apps>
</node>
</cluster>

</source>

=== Configure OX Spreadsheet Worker - Nature 'CE-Worker' ===

The OX Spreadsheet Worker host:
* Nx Worker processes connected

The OX Spreadsheet Worker node host all worker processes where the real user documents are handled. So e.g. the persistence of such documents (usable for an automatic document recovery in case a worker was restarted) has to be configured at this node. Inside the configuration file'''''/opt/open-xchange/etc/calcengine.properties'''''define the following:

<source lang="ini">

# -----------------------------------------------------------------------------
# define the mode the calc engine will use at runtime
#
# - jms
# calc engine is a central JMS server to communicate with
# all configured worker processes even clustered on different machines.
#
calcengine.mode=jms

# -----------------------------------------------------------------------------
# path where worker can cache there documents to support auto-restore in case
# a worker crashed and will be reactivated.
#
# If this path is empty - auto-restore will be disabled.
#
# This value can use special variable $(TEMP) to place the cache
# within the temporary directory. Other variables are not supported.
#
# Note: This feature can be disabled by define an empty path only !
#
calcengine.restore-documents.path=${sys:java.io.tmpdir}/ox-ce-doc-cache

</source>

The OX Spreadsheet Worker needs to know where the JMS Server is running. JMS acts as a communication channel between the OX Spreadsheet Worker and Server. Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-distributed/nature-ce-worker/jms-server.properties''''' to generate a suitable configuration at'''''/opt/open-xchange/etc/documents/jms-server.properties''''' and replace all place holder following the schema'''''%%[...]%%'''''.

<source lang="ini">

# =============================================================================
# NOTE : DO NOT USE DEFAULT VALUES WITHIN THIS SCRIPT AS THEY COME FROM THE CODE.
# ACTIVATE AND CHANGE VALUES IF NEEDED ONLY.

# -----------------------------------------------------------------------------
# define the host (IP/DNS) where the jms server is running and we have to
# be connected with
#
# default=127.0.0.1
#
jms.server.host=%%[CE_SERVER_IP]%%

# -----------------------------------------------------------------------------
# define the port where the server should listen for incoming requests
# or a client can be connected with those server.
#
# default=61616
#
#jms.server.port=61616

</source>

The OX Spreadsheet Worker needs to register itself at OX Spreadsheet Server. The OX Spreadsheet Server host also a registry (cache) server. Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-distributed/nature-ce-worker/cache-server.properties''''' to generate a suitable configuration at'''''/opt/open-xchange/etc/documents/cache-server.properties''''' and replace all place holder following the schema'''''%%[...]%%'''''.

<source lang="ini">

# =============================================================================
# NOTE : DO NOT USE DEFAULT VALUES WITHIN THIS SCRIPT AS THEY COME FROM THE CODE.
# ACTIVATE AND CHANGE VALUES IF NEEDED ONLY.

# -----------------------------------------------------------------------------
# define the host (IP/DNS) where the jms server is running and we have to
# be connected with
#
# default=127.0.0.1
#
cache.server.host=%%[CE_SERVER_IP]%%

# -----------------------------------------------------------------------------
# define the port where the server should listen for incoming requests
# or a client can be connected with those server.
#
# default=7000
#
#cache.server.port=7000

# -----------------------------------------------------------------------------
# unique ID for this server instance.
# Can be used to separate multiple server instances on the same machine.
#
cache.server.id=%%[CE_SERVER_ID]%%

# -----------------------------------------------------------------------------
# password to join those cache server.
# Can be empty.
#
cache.server.password=%%[CE_SERVER_PASSWORD]%%

</source>

The OX Spreadsheet Worker do not run other services locally. They have to be disabled. This and other apsects of this setup can be configured within the file'''''/opt/open-xchange/etc/documents/cluster-node.xml''''': Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-distributed/nature-ce-worker/cluster-node.xml'''''to create those file.

<source lang="xml">



<cluster>

<node>

<cache>


</cache>

<watchdog>





</watchdog>

<apps merge-operation="explicit">








<app id="calcengine-worker">


<start-mode>auto</start-mode>


<min-instances>10</min-instances>


<max-instances>10</max-instances>




</app>

</apps>
</node>
</cluster>

</source>

=== Start & Stop - Instructions & Recommendations ===

Note: In general the order of starting all nodes (OX Appsuite, OX Spreadsheet Server and OX Spreadsheet Worker) is not important. An automatic reconnect feature guarantee a stable environment at runtime. On the other side it's more ease to analyze and locate errors inside the deployment if both nodes are started in a special order : OX Spreadsheet Server firstAll OX Spreadsheet Worker thenOX Appsuite at last

=== Start/Stop OX Spreadsheet Server - Nature 'CE-Server' ===

The OX Spreadsheet Server can be controlled by the script'''''/etc/init.d/open-xchange-cluster-management'''''. The OX Backend is not installed and has not to be started on this node.

<source lang="bash">

# start OX Spreadsheet Server
/etc/init.d/open-xchange-cluster-management start

...

# check status of OX Spreadsheet Server
/etc/init.d/open-xchange-cluster-management status

...

# stop OX Spreadsheet Server
/etc/init.d/open-xchange-cluster-management stop

</source>

=== Start/Stop OX Spreadsheet Worker - Nature 'CE-Worker' ===

The OX Spreadsheet Worker can be controlled by the script'''''/etc/init.d/open-xchange-cluster-management'''''. The OX Backend is not installed and has not to be started on this node.

<source lang="bash">

# start OX Spreadsheet Worker
/etc/init.d/open-xchange-cluster-management start

...

# check status of OX Spreadsheet Worker
/etc/init.d/open-xchange-cluster-management status

...

# stop OX Spreadsheet Worker
/etc/init.d/open-xchange-cluster-management stop

</source>

=== Start/Stop OX Appsuite - Nature 'OX-Backend' ===

The OX Spreadsheet Client is running within the OX Backend process. So it's enough to control those backend service by calling the script'''''/etc/init.d/open-xchange'''''.

<source lang="bash">

# start OX Backend
/etc/init.d/open-xchange start

...

# check status of OX Backend
/etc/init.d/open-xchange status

...

# stop OX Backend
/etc/init.d/open-xchange stop

</source>

File:AppSuite-Spreadsheet-Installation-Mode-Server-Distributed-Logical-Architecture.jpg

2015-10-02T10:58:39Z

Andreas.schluens:

File:AppSuite-Spreadsheet-Installation-Mode-Server-Distributed-Physical-Architecture.jpg

2015-10-02T10:58:14Z

Andreas.schluens:

File:AppSuite-Spreadsheet-Installation-Mode-Server-Combined-Logical-Architecture.jpg

2015-10-02T10:57:40Z

Andreas.schluens:

File:AppSuite-Spreadsheet-Installation-Mode-Server-Combined-Physical-Architecture.jpg

2015-10-02T10:57:03Z

Andreas.schluens:

AppSuite:Spreadsheet:Installation:Mode-Local

2015-10-02T10:55:57Z

Andreas.schluens: fix logical arch img

== Tutorial : OX Spreadsheet deployment - Mode 'Local' ==

=== General Information ===

This article describes what you need for an OX Spreadsheet setup - in mode 'Local'.

It contains everything you need to:
* Understand the design of the OX Spreadsheet setup including additional services
* Install the whole system based on the relevant articles
* Find pointers to the next steps of integration

=== System Design ===

[[File:AppSuite-Spreadsheet-Installation-Mode-Local-Physical-Architecture.jpg]]
[[File:AppSuite-Spreadsheet-Installation-Mode-Local-Logical-Architecture.jpg]]

The system is designed to provide maximum functionality with a minimum of necessary hardware. All services are running on one single machine besides the normal OX backend services.

=== Core Components ===

* One OX AppSuite server (HW recommendation: 16GB RAM / 4 cores) with optional OX Documents package installed

=== Overview Installation Steps ===

To deploy the described OX Spreadsheet setup, the following steps need to be done.

''Mandatory Installation Steps''

* Install and configure [[AppSuite:Main_Page_AppSuite|OX AppSuite Service]]
* Install and configure OX Spreadsheet Service

''Configuration Steps''

* Enable OX Spreadsheet Application and Portal
* Configure OX Spreadsheet

''Start / Stop Services''

* Start / Stop Services

=== Mandatory Installation Steps - Instructions & Recommendations ===

The following steps need to be done in every case to get OX Spreadsheet up and running:

* [[AppSuite:Spreadsheet:Installation:Mode-Local:Debian-6.0|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Local:Debian-7.0|Download and Installation Guide for Debian GNU/Linux 7.0 (Wheezy)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Local:Debian-8.0|Download and Installation Guide for Debian GNU/Linux 8.0 (Jessie)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Local:SLES-11|Download and Installation Guide for SUSE Linux Enterprise Server 11]]
* [[AppSuite:Spreadsheet:Installation:Mode-Local:SLE_12|Download and Installation Guide for SUSE Linux Enterprise Server 12]]
* [[AppSuite:Spreadsheet:Installation:Mode-Local:RedHat-6|Download and Installation Guide for RedHat Enterprise Linux 6]]
* [[AppSuite:Spreadsheet:Installation:Mode-Local:RedHat-7|Download and Installation Guide for RedHat Enterprise Linux 7]]

=== Configuration Steps - Instructions & Recommendations ===

=== Enable OX Spreadsheet Application and Portal ===

After installation the OX Spreadsheet functionality is disabled by default. To enable OX Spreadsheet Application the associated permission has to be set. The default setting for all users is changed in the file'''''/opt/open-xchange/etc/permissions.properties'''''.

<source lang="ini">

# Note:
# This list is a comma seperated list of different permissions.
# Add or remove the permission you want to change - leave other permissions unchanged.

permissions=..,spreadsheet,..

</source>

By enabling the OX Spreadsheet Application the corresponding OX Spreadsheet Portal was enabled also. If that is not intended you can disable the OX Spreadsheet Portal within the same configuration file'''''/opt/open-xchange/etc/permissions.properties''''':

<source lang="ini">

# Note:
# This list is a comma seperated list of different permissions.
# Add or remove the permission you want to change - leave other permissions unchanged.

permissions=..,spreadsheet,spreadsheetportaldisabled,..

</source>

=== Configure OX Spreadsheet ===

Within the OX Spreadsheet Standard installation the set of OX Spreadsheet Client/Server & Worker processes run locally on the same machine as the OX AppSuite Backend it does.

In the configuration file'''''/opt/open-xchange/etc/calcengine.properties'''''the mode of this setup is defined.

<source lang="ini">

# -----------------------------------------------------------------------------
# define the mode the calc engine will use at runtime
...
# - 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.
...
#

calcengine.mode=local

</source>

The configuration provide further settings to influence the behaviour regarding e.g. memory consumption or persistence of user data for the purpose or an automatic crash recovery.

In the configuration file'''''/opt/open-xchange/etc/calcengine.properties'''''the following settings are available:

<source lang="ini">

# -----------------------------------------------------------------------------
# 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 ... 5002
calcengine.worker.port_range.min=5001
calcengine.worker.port_range.max=5002

# -----------------------------------------------------------------------------
# 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

# -----------------------------------------------------------------------------
# path where worker can cache there documents to support auto-restore in case
# a worker crashed and will be reactivated.
#
# If this path is empty - auto-restore will be disabled.
#
# This value can use special variable $(TEMP) to place the cache
# within the temporary directory. Other variables are not supported.
#
# Note: This feature can be disabled by define an empty path only !
calcengine.restore-documents.path=${sys:java.io.tmpdir}/ox-ce-doc-cache

</source>

=== Start / Stop Services ===

All spreadsheet related services are controlled by the default OX Backend. So start/stop of those backend process is enough.

<source lang="bash">

# start OX Backend/Spreadsheet Service
/etc/init.d/open-xchange start

...

# check status of OX Backend/Spreadsheet Services
/etc/init.d/open-xchange status

...

# stop OX Backend/Spreadsheet Service
/etc/init.d/open-xchange stop

</source>

AppSuite:Spreadsheet:Installation:Mode-Local

2015-10-02T10:55:28Z

Andreas.schluens: add images

== Tutorial : OX Spreadsheet deployment - Mode 'Local' ==

=== General Information ===

This article describes what you need for an OX Spreadsheet setup - in mode 'Local'.

It contains everything you need to:
* Understand the design of the OX Spreadsheet setup including additional services
* Install the whole system based on the relevant articles
* Find pointers to the next steps of integration

=== System Design ===

[[File:AppSuite-Spreadsheet-Installation-Mode-Local-Physical-Architecture.jpg]]
[[File:AppSuite-Spreadsheet-Installation-Mode-Local-Physical-Architecture.jpg]]

The system is designed to provide maximum functionality with a minimum of necessary hardware. All services are running on one single machine besides the normal OX backend services.

=== Core Components ===

* One OX AppSuite server (HW recommendation: 16GB RAM / 4 cores) with optional OX Documents package installed

=== Overview Installation Steps ===

To deploy the described OX Spreadsheet setup, the following steps need to be done.

''Mandatory Installation Steps''

* Install and configure [[AppSuite:Main_Page_AppSuite|OX AppSuite Service]]
* Install and configure OX Spreadsheet Service

''Configuration Steps''

* Enable OX Spreadsheet Application and Portal
* Configure OX Spreadsheet

''Start / Stop Services''

* Start / Stop Services

=== Mandatory Installation Steps - Instructions & Recommendations ===

The following steps need to be done in every case to get OX Spreadsheet up and running:

* [[AppSuite:Spreadsheet:Installation:Mode-Local:Debian-6.0|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Local:Debian-7.0|Download and Installation Guide for Debian GNU/Linux 7.0 (Wheezy)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Local:Debian-8.0|Download and Installation Guide for Debian GNU/Linux 8.0 (Jessie)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Local:SLES-11|Download and Installation Guide for SUSE Linux Enterprise Server 11]]
* [[AppSuite:Spreadsheet:Installation:Mode-Local:SLE_12|Download and Installation Guide for SUSE Linux Enterprise Server 12]]
* [[AppSuite:Spreadsheet:Installation:Mode-Local:RedHat-6|Download and Installation Guide for RedHat Enterprise Linux 6]]
* [[AppSuite:Spreadsheet:Installation:Mode-Local:RedHat-7|Download and Installation Guide for RedHat Enterprise Linux 7]]

=== Configuration Steps - Instructions & Recommendations ===

=== Enable OX Spreadsheet Application and Portal ===

After installation the OX Spreadsheet functionality is disabled by default. To enable OX Spreadsheet Application the associated permission has to be set. The default setting for all users is changed in the file'''''/opt/open-xchange/etc/permissions.properties'''''.

<source lang="ini">

# Note:
# This list is a comma seperated list of different permissions.
# Add or remove the permission you want to change - leave other permissions unchanged.

permissions=..,spreadsheet,..

</source>

By enabling the OX Spreadsheet Application the corresponding OX Spreadsheet Portal was enabled also. If that is not intended you can disable the OX Spreadsheet Portal within the same configuration file'''''/opt/open-xchange/etc/permissions.properties''''':

<source lang="ini">

# Note:
# This list is a comma seperated list of different permissions.
# Add or remove the permission you want to change - leave other permissions unchanged.

permissions=..,spreadsheet,spreadsheetportaldisabled,..

</source>

=== Configure OX Spreadsheet ===

Within the OX Spreadsheet Standard installation the set of OX Spreadsheet Client/Server & Worker processes run locally on the same machine as the OX AppSuite Backend it does.

In the configuration file'''''/opt/open-xchange/etc/calcengine.properties'''''the mode of this setup is defined.

<source lang="ini">

# -----------------------------------------------------------------------------
# define the mode the calc engine will use at runtime
...
# - 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.
...
#

calcengine.mode=local

</source>

The configuration provide further settings to influence the behaviour regarding e.g. memory consumption or persistence of user data for the purpose or an automatic crash recovery.

In the configuration file'''''/opt/open-xchange/etc/calcengine.properties'''''the following settings are available:

<source lang="ini">

# -----------------------------------------------------------------------------
# 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 ... 5002
calcengine.worker.port_range.min=5001
calcengine.worker.port_range.max=5002

# -----------------------------------------------------------------------------
# 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

# -----------------------------------------------------------------------------
# path where worker can cache there documents to support auto-restore in case
# a worker crashed and will be reactivated.
#
# If this path is empty - auto-restore will be disabled.
#
# This value can use special variable $(TEMP) to place the cache
# within the temporary directory. Other variables are not supported.
#
# Note: This feature can be disabled by define an empty path only !
calcengine.restore-documents.path=${sys:java.io.tmpdir}/ox-ce-doc-cache

</source>

=== Start / Stop Services ===

All spreadsheet related services are controlled by the default OX Backend. So start/stop of those backend process is enough.

<source lang="bash">

# start OX Backend/Spreadsheet Service
/etc/init.d/open-xchange start

...

# check status of OX Backend/Spreadsheet Services
/etc/init.d/open-xchange status

...

# stop OX Backend/Spreadsheet Service
/etc/init.d/open-xchange stop

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed

2015-10-02T10:54:50Z

Andreas.schluens: /* System Design */

== Tutorial : OX Spreadsheet deployment - Mode 'Server Distributed' ==

=== General Information ===

This article describes what you need for an OX Spreadsheet setup - in Mode 'Server Distributed'.

It contains everything you need to:
* Understand the design of the OX Spreadsheet setup including additional services
* Install the whole system based on the relevant articles
* Find pointers to the next steps of integration

=== System Design ===

[[File:AppSuite-Spreadsheet-Installation-Mode-Local-Physical-Architecture.jpg]]
[[File:AppSuite-Spreadsheet-Installation-Mode-Local-Logical-Architecture.jpg]]

The system is designed to provide maximum functionality and availability with a minimum of necessary hardware. If the services on one OX server fail, this is transparently handled by others within the same cluster.

=== Core Components ===

* Nx OX AppSuite (HW recommendation: 16GB RAM / 4 cores) running as OX Spreadsheet Client (follow the instructions regarding Nature 'OX-Backend')
* 1x OX Spreadsheet Server (HW recommendation: 8GB RAM / 2 cores) (follow the instructions regarding Nature 'CE-Server')
* Nx OX Spreadsheet Worker (HW recommendation: 24GB RAM / 4 cores) (follow the instructions regarding Nature 'CE-Worker')

=== Overview Installation Steps ===

To deploy the described OX Spreadsheet setup, the following steps need to be done.

''Mandatory Installation Steps''

* Install and configure OX Appsuite - Nature 'OX-Backend'
* Install and configure OX Spreadsheet Server - Nature 'CE-Server'
* Install and configure OX Spreadsheet Worker - Nature 'CE-Worker'

''Configuration Steps''

* Configure OX Appsuite - Nature 'OX-Backend'
* Configure OX Spreadsheet Server - Nature 'CE-Server'
* Configure OX Spreadsheet Worker - Nature 'CE-Worker'

''Start & Stop''

* Start/Stop OX Appsuite - Nature 'OX-Backend'
* Start/Stop OX Spreadsheet Server - Nature 'CE-Server'
* Start/Stop OX Spreadsheet Worker - Nature 'CE-Worker'

=== Mandatory Installation Steps - Instructions & Recommendations ===

=== Install and configure OX Appsuite - Nature 'OX-Bckend' ===

The following steps need to be done to get OX Spreadsheet Client up and running:

* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:Debian-6.0|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:Debian-7.0|Download and Installation Guide for Debian GNU/Linux 7.0 (Wheezy)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:Debian-8.0|Download and Installation Guide for Debian GNU/Linux 8.0 (Jessie)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:SLES-11|Download and Installation Guide for SUSE Linux Enterprise Server 11]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:SLE_12|Download and Installation Guide for SUSE Linux Enterprise Server 12]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:RedHat-6|Download and Installation Guide for RedHat Enterprise Linux 6]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:RedHat-7|Download and Installation Guide for RedHat Enterprise Linux 7]]

=== Install and configure OX Spreadsheet Server - Nature 'CE-Server' ===

The following steps need to be done to get OX Spreadsheet Server HA up and running:

* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:Debian-6.0|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:Debian-7.0|Download and Installation Guide for Debian GNU/Linux 7.0 (Wheezy)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:Debian-8.0|Download and Installation Guide for Debian GNU/Linux 8.0 (Jessie)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:SLES-11|Download and Installation Guide for SUSE Linux Enterprise Server 11]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:SLE_12|Download and Installation Guide for SUSE Linux Enterprise Server 12]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:RedHat-6|Download and Installation Guide for RedHat Enterprise Linux 6]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Server:RedHat-7|Download and Installation Guide for RedHat Enterprise Linux 7]]

=== Install and configure OX Spreadsheet Worker - Nature 'CE-Worker' ===

The following steps need to be done to get OX Spreadsheet Worker HA up and running:

* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:Debian-6.0|Download and Installation Guide for Debian GNU/Linux 6.0 (Squeeze)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:Debian-7.0|Download and Installation Guide for Debian GNU/Linux 7.0 (Wheezy)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:Debian-8.0|Download and Installation Guide for Debian GNU/Linux 8.0 (Jessie)]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:SLESS-11|Download and Installation Guide for SUSE Linux Enterprise Server 11]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:SLE_12|Download and Installation Guide for SUSE Linux Enterprise Server 12]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:RedHat-6|Download and Installation Guide for RedHat Enterprise Linux 6]]
* [[AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-CE-Worker:RedHat-7|Download and Installation Guide for RedHat Enterprise Linux 7]]

=== Configuration Steps - Instructions & Recommendations ===

=== Configure OX Appsuite - Nature 'OX-Backend' ===

After installation the OX Spreadsheet functionality is disabled by default. To enable OX Spreadsheet Application the associated permission has to be set. The default setting for all users is changed in the file'''''/opt/open-xchange/etc/permissions.properties'''''.

<source lang="ini">

# Note:
# This list is a comma seperated list of different permissions.
# Add or remove the permission you want to change - leave other permissions unchanged.

permissions=..,spreadsheet,..

</source>

By enabling the OX Spreadsheet Application the corresponding OX Spreadsheet Portal was enabled also. If that is not intended you can disable the OX Spreadsheet Portal within the same configuration file'''''/opt/open-xchange/etc/permissions.properties''''':

<source lang="ini">

# Note:
# This list is a comma seperated list of different permissions.
# Add or remove the permission you want to change - leave other permissions unchanged.

permissions=..,spreadsheet,spreadsheetportaldisabled,..

</source>

Enable client mode at this node inside configuration file'''''/opt/open-xchange/etc/calcengine.properties''''':

<source lang="ini">

# -----------------------------------------------------------------------------
# define the mode the calc engine will use at runtime
...
# - jms
# all involved processes will look for a JMS server to communicate together.
...
#

calcengine.mode=jms

</source>

The mode 'Server Distributed' was designed for scalability. This require a different handling of the load balancer strategy. Configure inside the configuration file'''''/opt/open-xchange/etc/calcengine.properties'''''the following:

<source lang="ini">

# -----------------------------------------------------------------------------
# define where and how the load balancer is running.
#
# - server-dynamic-router
# Its running at server side using the dynamic-router pattern.
# As dynamic-router only header of JMS messages are interpreted and used.
# Doing so not the whole JMS message needs to be submitted to the load balancer process.
#
# - client-embedded
# Its running embedded at client side. So it's not a dedicated process at server side.
# At least it's nothing more then a lookup into the registry of worker processes
# and a mapping of request to worker queues.
# This mode is very fast and scalable - but provides less feature then all other modes.
# E.g. re-queuing of messages in case worker is restarting is not provided.
#
# default = server-dynamic-router
#
calcengine.load-balancer.type=client-embedded

</source>

The OX Spreadsheet Client needs to know where the OX Spreadsheet Server is running. But the client is not connected to the server directly. As communication channel between both nodes JMS is used.

The OX Spreadsheet Server acts as a JMS Server also. Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-distributed/nature-ox-backend/jms-server.properties''''' to generate a suitable configuration at'''''/opt/open-xchange/etc/documents/jms-server.properties''''' and replace all place holder following the schema'''''%%[...]%%'''''.

Note: All place holder values must be in sync with all other configuration files within the same setup.

<source lang="ini">

# =============================================================================
# NOTE : DO NOT USE DEFAULT VALUES WITHIN THIS SCRIPT AS THEY COME FROM THE CODE.
# ACTIVATE AND CHANGE VALUES IF NEEDED ONLY.

# -----------------------------------------------------------------------------
# define the host (IP/DNS) where the jms server is running and we have to
# be connected with
#
# default=127.0.0.1
#
jms.server.host=%%[CE_SERVER_IP]%%

# -----------------------------------------------------------------------------
# define the port where the server should listen for incoming requests
# or a client can be connected with those server.
#
# default=61616
#
#jms.server.port=61616

</source>

The OX Spreadsheet Server acts as a Cache Server also. Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-distributed/nature-ox-backend/cache-server.properties''''' to generate a suitable configuration at'''''/opt/open-xchange/etc/documents/cache-server.properties''''' and replace all place holder following the schema'''''%%[...]%%'''''.

Note: All place holder values must be in sync with all other configuration files within the same setup.

<source lang="ini">

# =============================================================================
# NOTE : DO NOT USE DEFAULT VALUES WITHIN THIS SCRIPT AS THEY COME FROM THE CODE.
# ACTIVATE AND CHANGE VALUES IF NEEDED ONLY.

# -----------------------------------------------------------------------------
# define the host (IP/DNS) where the jms server is running and we have to
# be connected with
#
# default=127.0.0.1
#
cache.server.host=%%[CE_SERVER_IP]%%

# -----------------------------------------------------------------------------
# define the port where the server should listen for incoming requests
# or a client can be connected with those server.
#
# default=7000
#
#cache.server.port=7000

# -----------------------------------------------------------------------------
# unique ID for this server instance.
# Can be used to separate multiple server instances on the same machine.
#
cache.server.id=%%[CE_SERVER_ID]%%

# -----------------------------------------------------------------------------
# password to join those cache server.
# Can be empty.
#
cache.server.password=%%[CE_SERVER_PASSWORD]%%

</source>

=== Configure OX Spreadsheet Server - Nature 'CE-Server' ===

The OX Spreadsheet Server host:
* 1x JMS Server for communication
* 1x Cache Server for caching data

The mode 'Server Distributed' was designed for scalability. This require a different handling of the load balancer strategy. Configure inside the configuration file'''''/opt/open-xchange/etc/calcengine.properties'''''the following:

<source lang="ini">

# -----------------------------------------------------------------------------
# define the mode the calc engine will use at runtime
#
# - jms
# calc engine is a central JMS server to communicate with
# all configured worker processes even clustered on different machines.
#
calcengine.mode=jms

# -----------------------------------------------------------------------------
# define where and how the load balancer is running.
#
# - server-dynamic-router
# Its running at server side using the dynamic-router pattern.
# As dynamic-router only header of JMS messages are interpreted and used.
# Doing so not the whole JMS message needs to be submitted to the load balancer process.
#
# - client-embedded
# Its running embedded at client side. So it's not a dedicated process at server side.
# At least it's nothing more then a lookup into the registry of worker processes
# and a mapping of request to worker queues.
# This mode is very fast and scalable - but provides less feature then all other modes.
# E.g. re-queuing of messages in case worker is restarting is not provided.
#
# default = server-dynamic-router
#
calcengine.load-balancer.type=client-embedded

</source>

Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-distributed/nature-ce-server/jms-server.properties''''' to generate a suitable configuration at'''''/opt/open-xchange/etc/documents/jms-server.properties''''' and replace all place holder following the schema'''''%%[...]%%'''''.

<source lang="ini">

# =============================================================================
# NOTE : DO NOT USE DEFAULT VALUES WITHIN THIS SCRIPT AS THEY COME FROM THE CODE.
# ACTIVATE AND CHANGE VALUES IF NEEDED ONLY.

# -----------------------------------------------------------------------------
# define the network interface where the server should listen for incoming requests.
#
# Possible values are:
# - 0.0.0.0 to allow all (internal and external) connections
# - 127.0.0.1 to allow local connections only
#
# default=127.0.0.1
#
jms.server.interface=0.0.0.0

# -----------------------------------------------------------------------------
# define the port where the server should listen for incoming requests
# or a client can be connected with those server.
#
# default=61616
#
#jms.server.port=61616

# -----------------------------------------------------------------------------
# define directory for storing persistent data
#
# Will be created automatically if it does not exists.
# If it's not defined persistence will be disabled.
#
# Note: Thise feature can be disabled by setting an empty path only !
#
#jms.server.persistence.dir=${sys:java.io.tmpdir}/ox-jms-embedded-server/persistence

# -----------------------------------------------------------------------------
# frequency where the JMS Garbage Collector (GC) should run
#
# unit=[ms]
# default=300000 (5min)
#
#jms.server.gc.frequency=300000

# -----------------------------------------------------------------------------
# the time a JMS resource (queue/topic) has to be inactive before it can
# will be removed by the GC
#
# unit=[ms]
# default=60000 (1min)
#
#jms.server.gc.inactive-timeout-before-gc=60000

</source>

Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-distributed/nature-ce-server/cache-server.properties''''' to generate a suitable configuration at'''''/opt/open-xchange/etc/documents/cache-server.properties''''' and replace all place holder following the schema'''''%%[...]%%'''''.

<source lang="ini">

# =============================================================================
# NOTE : DO NOT USE DEFAULT VALUES WITHIN THIS SCRIPT AS THEY COME FROM THE CODE.
# ACTIVATE AND CHANGE VALUES IF NEEDED ONLY.

# -----------------------------------------------------------------------------
# define the network interface where the server should listen for incoming requests.
#
# Possible values are:
# - <IP_RANGE> to allow all (internal and external) connections
# - 127.0.0.1 to allow local connections only
#
# <IP_RANGE> example:
# IP of local machine is "192.168.0.1".
# A might suitable IP range can be "192.168.0.*"
#
# default=127.0.0.1
#
cache.server.interface=%%[CE_CLIENTS_IP_RANGE]%%

# -----------------------------------------------------------------------------
# define the port where the server should listen for incoming requests
# or a client can be connected with those server.
#
# default=7000
#
#cache.server.port=7000

# -----------------------------------------------------------------------------
# unique ID for this server instance.
# Can be used to separate multiple server instances on the same machine.
#
# default = 'default'
#
cache.server.id=%%[CE_SERVER_ID]%%

# -----------------------------------------------------------------------------
# password to join those cache server.
# Can be empty.
#
# default = 'xxx'
#
cache.server.password=%%[CE_SERVER_PASSWORD]%%

# -----------------------------------------------------------------------------
# define directory for storing persistent data
#
# Will be created automatically if it does not exists.
# If it's not defined persistence will be disabled.
#
# Note: To disable this feature define an empty path.
#
# default = '${sys:java.io.tmpdir}/ox-cache-server/${cache.server.id}/persistence'
#
#cache.server.persistence.dir=${sys:java.io.tmpdir}/ox-cache-server/${cache.server.id}/persistence

</source>

The OX Spreadsheet Server - Mode 'Server Distributed' do not run OX Spreadsheet Worker locally. They have to be disabled. This and other apsects of this setup can be configured within the file'''''/opt/open-xchange/etc/documents/cluster-node.xml''''': Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-distributed/nature-ce-server/cluster-node.xml'''''to create those file.

<source lang="xml">



<cluster>

<node>

<cache>


</cache>

<watchdog>





</watchdog>

<apps merge-operation="explicit">


<app id="jms-server">


</app>


<app id="cache-server">


</app>





</apps>
</node>
</cluster>

</source>

=== Configure OX Spreadsheet Worker - Nature 'CE-Worker' ===

The OX Spreadsheet Worker host:
* Nx Worker processes connected

The OX Spreadsheet Worker node host all worker processes where the real user documents are handled. So e.g. the persistence of such documents (usable for an automatic document recovery in case a worker was restarted) has to be configured at this node. Inside the configuration file'''''/opt/open-xchange/etc/calcengine.properties'''''define the following:

<source lang="ini">

# -----------------------------------------------------------------------------
# define the mode the calc engine will use at runtime
#
# - jms
# calc engine is a central JMS server to communicate with
# all configured worker processes even clustered on different machines.
#
calcengine.mode=jms

# -----------------------------------------------------------------------------
# path where worker can cache there documents to support auto-restore in case
# a worker crashed and will be reactivated.
#
# If this path is empty - auto-restore will be disabled.
#
# This value can use special variable $(TEMP) to place the cache
# within the temporary directory. Other variables are not supported.
#
# Note: This feature can be disabled by define an empty path only !
#
calcengine.restore-documents.path=${sys:java.io.tmpdir}/ox-ce-doc-cache

</source>

The OX Spreadsheet Worker needs to know where the JMS Server is running. JMS acts as a communication channel between the OX Spreadsheet Worker and Server. Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-distributed/nature-ce-worker/jms-server.properties''''' to generate a suitable configuration at'''''/opt/open-xchange/etc/documents/jms-server.properties''''' and replace all place holder following the schema'''''%%[...]%%'''''.

<source lang="ini">

# =============================================================================
# NOTE : DO NOT USE DEFAULT VALUES WITHIN THIS SCRIPT AS THEY COME FROM THE CODE.
# ACTIVATE AND CHANGE VALUES IF NEEDED ONLY.

# -----------------------------------------------------------------------------
# define the host (IP/DNS) where the jms server is running and we have to
# be connected with
#
# default=127.0.0.1
#
jms.server.host=%%[CE_SERVER_IP]%%

# -----------------------------------------------------------------------------
# define the port where the server should listen for incoming requests
# or a client can be connected with those server.
#
# default=61616
#
#jms.server.port=61616

</source>

The OX Spreadsheet Worker needs to register itself at OX Spreadsheet Server. The OX Spreadsheet Server host also a registry (cache) server. Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-distributed/nature-ce-worker/cache-server.properties''''' to generate a suitable configuration at'''''/opt/open-xchange/etc/documents/cache-server.properties''''' and replace all place holder following the schema'''''%%[...]%%'''''.

<source lang="ini">

# =============================================================================
# NOTE : DO NOT USE DEFAULT VALUES WITHIN THIS SCRIPT AS THEY COME FROM THE CODE.
# ACTIVATE AND CHANGE VALUES IF NEEDED ONLY.

# -----------------------------------------------------------------------------
# define the host (IP/DNS) where the jms server is running and we have to
# be connected with
#
# default=127.0.0.1
#
cache.server.host=%%[CE_SERVER_IP]%%

# -----------------------------------------------------------------------------
# define the port where the server should listen for incoming requests
# or a client can be connected with those server.
#
# default=7000
#
#cache.server.port=7000

# -----------------------------------------------------------------------------
# unique ID for this server instance.
# Can be used to separate multiple server instances on the same machine.
#
cache.server.id=%%[CE_SERVER_ID]%%

# -----------------------------------------------------------------------------
# password to join those cache server.
# Can be empty.
#
cache.server.password=%%[CE_SERVER_PASSWORD]%%

</source>

The OX Spreadsheet Worker do not run other services locally. They have to be disabled. This and other apsects of this setup can be configured within the file'''''/opt/open-xchange/etc/documents/cluster-node.xml''''': Use the template'''''/opt/open-xchange/etc-templates/documents/mode-server-distributed/nature-ce-worker/cluster-node.xml'''''to create those file.

<source lang="xml">



<cluster>

<node>

<cache>


</cache>

<watchdog>





</watchdog>

<apps merge-operation="explicit">








<app id="calcengine-worker">


<start-mode>auto</start-mode>


<min-instances>10</min-instances>


<max-instances>10</max-instances>




</app>

</apps>
</node>
</cluster>

</source>

=== Start & Stop - Instructions & Recommendations ===

Note: In general the order of starting all nodes (OX Appsuite, OX Spreadsheet Server and OX Spreadsheet Worker) is not important. An automatic reconnect feature guarantee a stable environment at runtime. On the other side it's more ease to analyze and locate errors inside the deployment if both nodes are started in a special order : OX Spreadsheet Server firstAll OX Spreadsheet Worker thenOX Appsuite at last

=== Start/Stop OX Spreadsheet Server - Nature 'CE-Server' ===

The OX Spreadsheet Server can be controlled by the script'''''/etc/init.d/open-xchange-cluster-management'''''. The OX Backend is not installed and has not to be started on this node.

<source lang="bash">

# start OX Spreadsheet Server
/etc/init.d/open-xchange-cluster-management start

...

# check status of OX Spreadsheet Server
/etc/init.d/open-xchange-cluster-management status

...

# stop OX Spreadsheet Server
/etc/init.d/open-xchange-cluster-management stop

</source>

=== Start/Stop OX Spreadsheet Worker - Nature 'CE-Worker' ===

The OX Spreadsheet Worker can be controlled by the script'''''/etc/init.d/open-xchange-cluster-management'''''. The OX Backend is not installed and has not to be started on this node.

<source lang="bash">

# start OX Spreadsheet Worker
/etc/init.d/open-xchange-cluster-management start

...

# check status of OX Spreadsheet Worker
/etc/init.d/open-xchange-cluster-management status

...

# stop OX Spreadsheet Worker
/etc/init.d/open-xchange-cluster-management stop

</source>

=== Start/Stop OX Appsuite - Nature 'OX-Backend' ===

The OX Spreadsheet Client is running within the OX Backend process. So it's enough to control those backend service by calling the script'''''/etc/init.d/open-xchange'''''.

<source lang="bash">

# start OX Backend
/etc/init.d/open-xchange start

...

# check status of OX Backend
/etc/init.d/open-xchange status

...

# stop OX Backend
/etc/init.d/open-xchange stop

</source>

File:AppSuite-Spreadsheet-Installation-Mode-Local-Logical-Architecture.jpg

2015-10-02T10:54:10Z

Andreas.schluens:

File:AppSuite-Spreadsheet-Installation-Mode-Local-Physical-Architecture.jpg

2015-10-02T10:53:25Z

Andreas.schluens:

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:RedHat-7

2015-10-02T10:45:27Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on RedHat Enterprise Linux 7 - Mode 'Server Distributed' - Nature 'OX-Backend' ==

=== Preparation ===

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

=== Installation ===

Install all required packages:

<source lang="bash">

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

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:RedHat-6

2015-10-02T10:44:54Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on RedHat Enterprise Linux 6 - Mode 'Server Distributed' - Nature 'OX-Backend' ==

=== Preparation ===

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

=== Installation ===

Install all required packages:

<source lang="bash">

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

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:SLE 12

2015-10-02T10:44:15Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on SUSE Linux Enterprise Server 12 - Mode 'Server Distributed' - Nature 'OX-Backend' ==

=== Preparation ===

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

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

=== Installation ===

Install all required packages:

<source lang="bash">

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

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:SLES-11

2015-10-02T10:43:42Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on SUSE Linux Enterprise Server 11 - Mode 'Server Distributed' - Nature 'OX-Backend' ==

=== Preparation ===

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

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

=== Installation ===

Install all required packages:

<source lang="bash">

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

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:Debian-8.0

2015-10-02T10:43:06Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on Debian GNU/Linux 8.0 - Mode 'Server Distributed' - Nature 'OX-Backend' ==

=== Preparation ===

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

=== Installation ===

Install all required packages:

<source lang="bash">

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

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:Debian-7.0

2015-10-02T10:42:31Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on Debian GNU/Linux 7.0 - Mode 'Server Distributed' - Nature 'OX-Backend' ==

=== Preparation ===

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

=== Installation ===

Install all required packages:

<source lang="bash">

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

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Distributed:Nature-OX-Backend:Debian-6.0

2015-10-02T10:41:59Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on Debian GNU/Linux 6.0 - Mode 'Server Distributed' - Nature 'OX-Backend' ==

=== Preparation ===

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

=== Installation ===

Install all required packages:

<source lang="bash">

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

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-CE-Server:RedHat-7

2015-10-02T08:57:32Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on RedHat Enterprise Linux 7 - Mode 'Server Combined' - Nature 'CE-Server' ==

=== Preparation ===

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|backend|office-communication|calcengine}}

=== Installation ===

Install all required packages:

<source lang="bash">

$ yum install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-CE-Server:RedHat-6

2015-10-02T08:56:50Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on RedHat Enterprise Linux 6 - Mode 'Server Combined' - Nature 'CE-Server' ==

=== Preparation ===

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|backend|office-communication|calcengine}}

=== Installation ===

Install all required packages:

<source lang="bash">

$ yum install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-CE-Server:SLE 12

2015-10-02T08:56:11Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on SUSE Linux Enterprise Server 12 - Mode 'Server Combined' - Nature 'CE-Server' ==

=== Preparation ===

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

{{for loop||call=SUSERepo|pv=reponame|pc1n=path|pc1v=products/appsuite/stable|pc3n=susename|pc3v=SLE_12|backend|office-communication|calcengine}}

=== Installation ===

Install all required packages:

<source lang="bash">

$ zypper ref
$ zypper install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-CE-Server:SLES-11

2015-10-02T08:55:31Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on SUSE Linux Enterprise Server 11 - Mode 'Server Combined' - Nature 'CE-Server' ==

=== Preparation ===

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

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

=== Installation ===

Install all required packages:

<source lang="bash">

$ zypper ref
$ zypper install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-CE-Server:Debian-8.0

2015-10-02T08:54:52Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on Debian GNU/Linux 8.0 - Mode 'Server Combined' - Nature 'CE-Server' ==

=== Preparation ===

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|backend|office-communication|calcengine}}

=== Installation ===

Install all required packages:

<source lang="bash">

$ apt-get update
$ apt-get install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-CE-Server:Debian-7.0

2015-10-02T08:54:17Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on Debian GNU/Linux 7.0 - Mode 'Server Combined' - Nature 'CE-Server' ==

=== Preparation ===

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|backend|office-communication|calcengine}}

=== Installation ===

Install all required packages:

<source lang="bash">

$ apt-get update
$ apt-get install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-CE-Server:Debian-6.0

2015-10-02T08:53:15Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on Debian GNU/Linux 6.0 - Mode 'Server Combined' - Nature 'CE-Server' ==

=== Preparation ===

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|backend|office-communication|calcengine}}

=== Installation ===

Install all required packages:

<source lang="bash">

$ apt-get update
$ apt-get install open-xchange-office-jms-spreadsheet-context

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-OX-Backend:RedHat-7

2015-10-02T08:51:43Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on RedHat Enterprise Linux 7 - Mode 'Server Combined' - Nature 'OX-Backend' ==

=== Preparation ===

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

=== Installation ===

Install all required packages:

<source lang="bash">

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

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-OX-Backend:RedHat-6

2015-10-02T08:51:00Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on RedHat Enterprise Linux 6 - Mode 'Server Combined' - Nature 'OX-Backend' ==

=== Preparation ===

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

=== Installation ===

Install all required packages:

<source lang="bash">

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

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-OX-Backend:SLE 12

2015-10-02T08:50:18Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on SUSE Linux Enterprise Server 12 - Mode 'Server Combined' - Nature 'OX-Backend' ==

=== Preparation ===

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

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

=== Installation ===

Install all required packages:

<source lang="bash">

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

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-OX-Backend:SLES-11

2015-10-02T08:49:24Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on SUSE Linux Enterprise Server 11 - Mode 'Server Combined' - Nature 'OX-Backend' ==

=== Preparation ===

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

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

=== Installation ===

Install all required packages:

<source lang="bash">

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

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-OX-Backend:Debian-8.0

2015-10-02T08:48:43Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on Debian GNU/Linux 8.0 - Mode 'Server Combined' - Nature 'OX-Backend' ==

=== Preparation ===

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

=== Installation ===

Install all required packages:

<source lang="bash">

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

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-OX-Backend:Debian-7.0

2015-10-02T08:48:05Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on Debian GNU/Linux 7.0 - Mode 'Server Combined' - Nature 'OX-Backend' ==

=== Preparation ===

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

=== Installation ===

Install all required packages:

<source lang="bash">

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

</source>

AppSuite:Spreadsheet:Installation:Mode-Server-Combined:Nature-OX-Backend:Debian-6.0

2015-10-02T08:47:24Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on Debian GNU/Linux 6.0 - Mode 'Server Combined' - Nature 'OX-Backend' ==

=== Preparation ===

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

=== Installation ===

Install all required packages:

<source lang="bash">

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

</source>

AppSuite:Spreadsheet:Installation:Mode-Local:RedHat-7

2015-10-02T08:44:35Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on RedHat Enterprise Linux 7 - Mode 'Local' ==

=== Preparation ===

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

=== Installation ===

Install all required packages:

<source lang="bash">

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

</source>

AppSuite:Spreadsheet:Installation:Mode-Local:RedHat-6

2015-10-02T08:42:56Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on RedHat Enterprise Linux 6 - Mode 'Local' ==

=== Preparation ===

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

=== Installation ===

Install all required packages:

<source lang="bash">

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

</source>

AppSuite:Spreadsheet:Installation:Mode-Local:SLE 12

2015-10-02T08:42:18Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on SUSE Linux Enterprise Server 12 - Mode 'Local' ==

=== Preparation ===

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

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

=== Installation ===

Install all required packages:

<source lang="bash">

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

</source>

AppSuite:Spreadsheet:Installation:Mode-Local:SLES-11

2015-10-02T08:41:31Z

Andreas.schluens: new doc for release 7.8.0

== OX Spreadsheet on SUSE Linux Enterprise Server 11 - Mode 'Local' ==

=== Preparation ===

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

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

=== Installation ===

Install all required packages:

<source lang="bash">

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

</source>