Skip over navigation
You are currently viewing documentation for a previously released version of OroCRM. See the latest long-term support version.

Operational Structure

Oro applications are implemented in PHP and require additional system components to be installed and configured in the environment.



Oro applications are web applications where most of the user interactions are done via web browser interface. HTTP(s) protocol is used as a foundation for data communication and the WebSocket protocol is used for real-time user notifications and updates.

See the list of supported browsers in the system requirements.

API Client

Application Programming Interface exposed over the web is a required part of business application and allows to integrate it to the enterprise infrastructure. Oro REST API allows any 3rd party API Client to consume application data and implement complex business scenarios related over HTTP(s) protocol.

See more information about the API.

Web Server

Web server is the main application entry point and is a required system component to run Oro applications. Web server configuration can be different based on the expected application load and can start with the single instance in the same environment where all other system components are installed. But it also can be much more complex and include multiple instances behind the load balancer. Web server should be available to the end user browser.


Consumer is an application command that is running as a daemon and handles all the messages registered within a Message Queue. Consumer is scalable and can run on multiple servers in case if application has a lot of asynchronous processes to be handled.

System Components

System components are 3rd party software that is required by Oro application and should be accessible by the application Web Server and the application Consumer. System components can be installed on the same server or on the separate servers that are accessible by Oro application.

Search Index

Application data is indexed based on the application configuration and stored in the search index. Community Edition supports only DB fulltext search index and Enterprise Edition supports highly scalable Elastic Search.

For more information, see Search Index overview.


All application data is stored in the relational database.


The PostgreSQL feature is only available in the Enterprise edition. MySQL can be used with both Community and Enterprise editions.


Application functions are using cache in order to optimize complex operations processing. By default, in a single server setup, file system is used as a cache storage. In the distributed environment, Redis is recommended as a cache storage.

See more information about the cache configuration.

Message Queue

In order to provide proper user experience and scale heavy backend operations, application integrated with message queue where all asynchronous jobs are registered and handled with consumer process. Community edition of message queue component is implemented based on the database and Enterprise Edition requires RabbitMQ for better scale.

See more information about using the message queue.

SMTP Relay

In order to send emails, Oro application needs SMTP Relay service to be configured.

File Storage

Application files related to the user data (attachments, images, documents) are stored in the file storage. In case of single server setup, server file system is used as the default file storage. In the distributed setup, Oro application supports any file storage supported by KnpGaufretteBundle.

Browse maintained versions:
Back to top