.. _installation:

************
Installation
************

Getting the proxy
=================

To obtain the latest version of the App Suite Proxy, clone the repository via git from ``https://gitlab.open-xchange.com/middleware/appsuite-proxy`` and follow the tutorial found in the README.md file to build an archive. Extract the archive into folder ``/opt/`` and continue with the setup of groups and users.


**Create a symlink to simplify later version changes and permission settings**::

  ln -s appsuite-proxy-<proxy_version> /opt/appsuite-proxy``

.. note:: At the moment there is no distribution package available for the App Suite Proxy. This will change as soon as the first release is published. There will also be full docker images available by then.

Create permissions
==================

Create an own system user alongside a dedicated group to run the later created App Suite Service.

**Create a dedicated group**::

  groupadd -r appsuite-proxy

**Create system user without login or home**::

  useradd -r appsuite-proxy


**Set permissions**::

  chgrp appsuite-proxy /opt/appsuite-proxy/bin/appsuite-proxy
  chmod -R 650 /opt/appsuite-proxy/bin/appsuite-proxy
  chgrp appsuite-proxy /opt/appsuite-proxy/conf/application.properties
  chmod -R 640 /opt/appsuite-proxy/conf/application.properties

**Create logging folder**::

  mkdir /var/log/appsuite-proxy
  chgrp appsuite-proxy /var/log/appsuite-proxy
  chmod -R 750 /var/log/appsuite-proxy

Create service
==============

Create a systemd service unit to control the process. For this purpose, create a file ``appsuite-proxy.service`` in directory ``/etc/systemd/system`` followed by a ``systemctl daemon-reload``.

appsuite-proxy.service::

    [Unit]
    Description=appsuite-proxy
    After=syslog.target
    After=network.target

    [Service]
    User=appsuite-proxy
    ExecStart=/opt/appsuite-proxy/bin/appsuite-proxy
    SuccessExitStatus=143
    LimitNOFILE=65536
    LimitNPROC=65536

    [Install]
    WantedBy=multi-user.target