eXo developers documentation

# Start eXo community

This chapter covers the following topics:

  • The minimum system requirements needed to run the stack of tools used by eXo platform
  • The software prerequisites needed to be installed before running the eXo platform stack

# System requirements

WARNING

The requirements cited below are provisional and may change according to quality tests findings.

To run the Docker compose of eXo Platform 7.0, your system is required to meet the following specifications or higher:

  • CPU: Multi-core recommended, 2GHz minimum.
  • Memory: The eXo Platform package is optimized with default settings: max heap size = 4GB and non-heap size = 256MB; so the available memory should be at least 4GB. It is recommended you have a memory of 8GB (4GB free for database, Elasticsearch, Jitsi and Onlyoffice services and file system caches).
  • Free disk space: 10GB minimum
  • Browser Compatibility: Check Browser compatibility section in Supported Environments (opens new window)

Note

The eXo server will run on the port 80 by default, so make sure this port is not currently in use or configure eXo Platform to use another port.

# Prerequisites

The full environment will be provided as Docker containers assembled together using a Docker Compose file. To install and try eXo platform community edition, you need to install Docker (opens new window) and Docker Compose (opens new window)

WARNING

If you are using Docker desktop, there is a default limitation for resources that may prevent eXo platform server from starting. Make sure to allow enough resources (Memory, disk, CPU) to the docker containers as explained in [Docker desktop documentation].(https://docs.docker.com/desktop/settings/mac/#resources) for different Operating systems.

# Start eXo platform

# With Docker-compose

  • Create a new folder $EXO_HOME, this folder will contain all files needed to run the eXo platform environment.

WARNING

It is recommended to add $EXO_HOME as an environment variable in your system, it will be used in all the tutorials.

  • Download the Docker Compose from here (opens new window) and save it under $EXO_HOME
  • Create the folder conf which will contain configuration files needed for the services deployed in docker images
  • Download the file configuration file of Nginx server from here (opens new window) and save it under the folder conf
  • Using your preferred console, move in the $EXO_HOME, then start the environment with the command:
docker-compose -f docker-compose.yml up

The default domain name exoapp.local can be changed by setting the environment variable EXO_PROXY_VHOST in the start command, as shown above:

export EXO_PROXY_VHOST=exoapp2.local
docker-compose -f docker-compose.yml up

WARNING

It is strongly recommended to use a custom domain name instead of localhost to ensure that the OnlyOffice Document Server functions properly.

WARNING

If you use domain name exoapp.local, you need to ensure that this domain name is resolvable by your system. You can do this by adding the following line to your hosts file (/etc/hosts):

127.0.0.1 exoapp.local
  • Open your browser and open the URL : http://exoapp.local/ (opens new window) or the custom domain name
  • You can create a new user using the form that will be displayed with the first server startup
  • If you skip the step above, you can still connect with the super-user of the platform. Its username is root and password password

# With separated containers

Alternatively, you may want to run each component separately with containers. Required images are :

To do this, you can use properties described in this page (opens new window) to configure eXo Community docker image.

The prerequisites are :

  • Docker daemon version 12+ + internet access
  • 4GB of available RAM + 1GB of disk

The most basic way to start eXo Platform Community edition for evaluation purpose is to execute theses steps :

  • Create the network
docker network create -d bridge exo-network
  • Start OnlyOffice DocumentServer
docker run \
      -p ${ONLYOFFICE_HTTP_PORT:-9090}:80 \
      -e JWT_ENABLED=true \
      -e JWT_SECRET=${ONLYOFFICE_SECRET:-d24079cba6ea93aab7a0efcde5143673e8e4cd32be51519112ca604cf4f9bbb6} \
      -e SECURE_LINK_SECRET=${ONLYOFFICE_LINK_SECRET:-fe6c434c36ee04031718b3c53b1d803739da880a142baf17b8f56dc2520877dd} \
      --name onlyoffice --network=exo-network onlyoffice/documentserver:8.2
  • Start ElasticSearch Server
docker run -e ES_JAVA_OPTS="-Xms2048m -Xmx2048m" -e node.name=exo -e cluster.name=exo -e cluster.initial_master_nodes=exo -e network.host=_site_ -v search_data:/usr/share/elasticsearch/data --name es --network=exo-network elasticsearch:8.14.3
  • Start eXo Platform Server Replace the value of ONLYOFFICE_PUBLIC_IP with the public (local) IP address of the machine hosting the OnlyOffice Document Server, for example, 192.168.1.3.

WARNING

In this deployment mode, eXo Platform and OnlyOffice should be able to communicate with each other using the same network IP, both for internal interaction and access via the browser (since direct communication using container services does not succeed). Alternatively, they can communicate through an intermediate reverse proxy, as outlined in the provided Docker Compose file section.

ONLYOFFICE_PUBLIC_IP="10.0.0.1" # Replace this value with a public (local) ip address
docker run -v exo_data:/srv/exo -p 8080:8080 \
 -e EXO_ES_HOST=es \
 -e JAVA_OPTS="-Donlyoffice.documentserver.host=${ONLYOFFICE_PUBLIC_IP} \
-Donlyoffice.documentserver.schema=${ONLYOFFICE_SCHEMA:-http} \
-Donlyoffice.documentserver.allowedhosts=localhost,${ONLYOFFICE_PUBLIC_IP} \
-Donlyoffice.documentserver.accessOnly=false \
-Donlyoffice.documentserver.secret=${ONLYOFFICE_JWT_SECRET:-d24079cba6ea93aab7a0efcde5143673e8e4cd32be51519112ca604cf4f9bbb6}" \
 --name exo --network=exo-network exoplatform/exo-community:7.0.0

and then waiting the log line which say that the server is started

exo_1    | 2022-09-20 16:55:43,009 | INFO  | Server startup in [58805] milliseconds [org.apache.catalina.startup.Catalina<main>]

When ready just go to http://{the_ip_you_choose}:8080 (opens new window) (for example http://192.168.1.3:8080 (opens new window)) and follow the instructions 😉

Once containers successfully start, you can stop/start them with

docker stop $CONTAINER_NAME
docker start $CONTAINER_NAME

← User and Administrator guides →