Oro Documentation
Oro Documentation
  • USERS
  • DEVELOPERS
    • Backend Developer Guide
    • Frontend Developer Guide
    • Bundles Documentation
    • Community Guide
  • CLOUD
  • BLOG
  • ACADEMY
  • Home >
  • Infrastructure-related Oro Application Configuration
  • Backend Developer Guide
    • Setup
      • System Requirements
        • Performance Optimization
        • MySQL Optimization
      • Development Environment
        • Environment Setup for Community Edition
        • Environment Setup for Enterprise Edition
        • Web Server Configuration
        • Healthcheck and Data Monitoring
      • Demo Environment
        • VM VirtualBox
        • AWS Cloud Platform
        • Vagrant Provision
      • Installation
      • Installation in Sub-Folder
      • Loading Demo Data
      • Launch
      • Upgrade
      • Reinstall
      • Protect Cookies
    • Application Architecture
      • Technology Stack
        • Database
        • Search Index
          • ORM Search Engine
          • Elasticsearch
        • Message Queue
      • Application Structure
      • Application Framework
        • Architecture Principles of Oro Applications
      • Application Customization
      • Differences to Common Symfony Applications
      • Custom Oro Application
    • Bundles and Extensions
      • Create a Bundle
      • Extend an Existing Bundle
      • Install Extension from the Oro Marketplace
      • Add an Extension to Oro Marketplace
    • Entities
      • Create Entities
      • Extend Entities
      • Configure Entities
      • CRUD Operations
      • Data Grids
        • Pass Request Parameters to the Grid
      • Protect Entities Using ACLs
      • Entity Activities
      • Entity Attachments
      • Customize CRUD Pages
      • Customize Data Grid
    • Entities Data Management
      • Fixtures and Demo Data
      • Reports & Segments
      • Search Index
        • Configuration
        • Console Commands
        • Query Builder
        • Best Practices
        • Troubleshooting
      • Workflows
        • Introduction
        • Configuration Reference
        • Elements
        • Basic Configuration
        • Transition Forms
        • Translation Wizard
        • Configuration Example
      • Operations (Actions)
        • Glossary
        • Buttons
        • Action Groups
        • Configuration Reference
        • Actions and Conditions
        • Console Commands
      • Processes
      • Data Audit
    • Security
      • Introduction to Security in Oro Applications
      • Access Levels and Ownership (Example)
    • Translation and Localization
      • Translation
      • Localization
    • Integrations
      • Create an Integration
      • Import and Export Entities
      • Extend Entities to Support Bulk Import and Export
      • Accelerate Import
    • Dashboards
    • Navigation
    • Emails
    • Message Queue
      • Message Queue Jobs
      • Consumer
        • Resetting Container
      • Security Context
      • Logging, Error Handling and Debugging
        • Writing Logs to ELK Stack
      • Testing
      • RabbitMQ (Enterprise Edition Only)
        • Command Lines
        • Divide Queue to Separate Queues
        • Configure RabbitMQ for Production
        • Backup and Restore
        • Troubleshooting
      • Supervisord
    • Cron
    • WebSocket Notifications
      • Websocket Recipes
        • Use Maintenance Mode Notifications in Oro Applications
        • Use Content Outdated Notifications in Oro Applications
        • Create a Topic and a Handler for Publishing and Subscribing
        • Publish Messages to Existing Topics
        • Use Authentication and Authorization in WebSocket Connections
      • WebSocket Connection Configuration
    • Scopes
    • Feature Toggle
    • Logging
    • System Configuration
    • Configuration Reference
      • Annotations
        • @Acl
        • @AclAncestor
        • @Config
        • @ConfigField
        • @TitleTemplate
      • YAML
        • Access Control Lists
        • Assets
        • Dashboards
        • Datagrids
        • Entity Configuration
        • Navigation
        • Placeholders
        • Require.JS
        • Search Index
        • System Configuration
        • Workflows
    • Extending OroCRM
      • Add OroCommerce Capabilities to an OroCRM Application
    • Extending OroCommerce
      • Payment Methods
      • Shipping Methods
    • Akeneo Integration
    • Automated Tests
      • Functional Tests
      • Behat Tests
    • API Developer Guide
      • Using Web Services API
        • WSSE Authentication
        • Simple Search API
        • Advanced Search API
      • Actions
      • CLI Commands
      • Configuration Extensions
      • Configuration Extras
      • Configuration Reference
      • Documenting API Resources
      • Forms and Validators Configuration
      • Headers
      • Filters
      • How to
      • Processors
      • Configure Stateless Security Firewalls
      • Testing REST Api
      • Request Type
      • CORS Configuration
      • Entity Aliases
Version:
3.1
  • 4.1
  • 4.2
  • 5.0 (latest)
  • 5.1-ALPHA.2
  • Contents
    • Default Configuration Values
    • The Sample of Configuration Parameters

Infrastructure-related Oro Application Configuration

Infrastructure-related configuration parameters are stored in the config/parameters.yml file and grouped in the following way:

  • The database_ parameters are used to connect to the database.

  • The mailer_ parameters define settings used to deliver emails sent by the application.

  • The websocket_ parameters define settings for the web UI.

  • The session_handler value specifies the PHP session handler to be used.

  • The secret value is used to generate CSRF tokens.

  • The assets_version parameter is used to bust the cache on assets by globally adding a query parameter to all rendered asset paths.

  • The assets_version_strategy value defines the strategy used to generate the global assets version. The available values are:

    • null — The asset’s version stays unchanged.
    • time_hash — A hash of the current time.
    • incremental — The next asset’s version is the previous version incremented by one (e.g. ver1 -> ver2 or 1 -> 2).

Default Configuration Values

Default configuration options for the Oro application are provided in brackets below:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
  database_driver (pdo_mysql):
  database_host (127.0.0.1):
  database_port (null):
  database_name (oro_crm):
  database_user (root):
  database_password (null):
  mailer_transport (smtp):
  mailer_host (127.0.0.1):
  mailer_port (null):
  mailer_encryption (null):
  mailer_user (null):
  mailer_password (null):
  websocket_bind_address (0.0.0.0):
  websocket_bind_port (8080):
  websocket_frontend_host ('*'):
  websocket_frontend_port (8080):
  websocket_backend_host ('*'):
  websocket_backend_port (8080):
  session_handler (session.handler.native_file):
  secret (ThisTokenIsNotSoSecretChangeIt):
  installed (null):
  assets_version (null):
  assets_version_strategy: time_hash

The Sample of Configuration Parameters

The sample contents of the <installation directory>/config/parameters.yml file for OroCommerce:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
    parameters:
       database_driver:        pdo_mysql
       database_host:          154.122.122.154
       database_port:          3606
       database_name:          orocommerce_database
       database_user:          orocommerce_database_user
       database_password:      orocommerce_database_password

       mailer_transport:       mail
       mailer_host:            155.122.122.155
       mailer_port:            22
       mailer_encryption:      TLS
       mailer_user:            orocommerce_mail_user
       mailer_password:        orocommerce_mail_password

       # WebSocket server config
       websocket_bind_address:  "0.0.0.0"  # The host IP the socket server will bind to
       websocket_bind_port:     8080       # The port the socket server will listen on
       websocket_frontend_host: "*"        # Websocket host the browser will connect to
       websocket_frontend_port: 8080       # Websocket port the browser will connect to
       websocket_backend_host:  "*"        # Websocket host the application server will connect to
       websocket_backend_port:  8080       # Websocket port the application server will connect to

       # search engine configuration
       search_engine_name:       orm
       search_engine_host:       156.122.122.156
       search_engine_port:       ~
       search_engine_index_name: oro_search
       search_engine_username:   orocommerce_search_user
       search_engine_password:   orocommerce_search_password
       search_engine_ssl_verification: ~
       search_engine_ssl_cert: ~
       search_engine_ssl_cert_password: ~
       search_engine_ssl_key: ~
       search_engine_ssl_key_password: ~

       # website search engine configuration
       website_search_engine_index_name: oro_website_search

       # Used to hide backend under specified prefix, should start with "/" and should not end with "/", for instance "/admin"
       web_backend_prefix:         '/admin'

       session_handler:        session.handler.native_file

       secret:                 ThisTokenIsNotSoSecretChangeIt
       installed:              ~
       assets_version:         ~
       assets_version_strategy: time_hash # A strategy should be used to generate the global assets version, can be:
              # null        - the assets version stays unchanged
              # time_hash   - a hash of the current time
             # incremental - the next assets version is the previous version is incremented by one (e.g. 'ver1' -> 'ver2' or '1' -> '2')
       enterprise_licence: ~
       message_queue_transport: 'dbal'
       message_queue_transport_config: ~
Oro Documentation
  • Oro inc
  • OroCommerce
  • OroMarketplace
  • OroCRM
  • OroPlatform
  • Partners
  • Services
  • Events
  • Terms & conditions
  • Privacy policy
  • Contributor license agreement

@2021 Oro, Inc. All Rights Reserved.

Back to top