ssossossosso
Documentation Home »Installation Guide »Run Installation via Wizard or CLI »Installation
1.4 version

Installation

You can launch the Oro application installation either from the console, or using the web installation wizard.

The installation wizard guides you through the installation process and is more straightforward. However, with console-based installation, you get more flexibility in choosing custom options, like force reinstall. Additionally, from the console, you can install the Oro application in a silent mode.

To customize the installation process and modify the database structure and/or data that are loaded in the OroCommerce after installation, you can:

Via Console

Warning

To avoid access permissions issues, please review the Symfony Setting up or Fixing File Permissions guide before running any commands. On top of that, consider running the command(s) below with sudo -u [web server user name] prefix.

To run the installation script in the console, navigate to the <installation_folder> and run the oro:install command, like in the following example:

php -dxcache.cacher=0 app/console oro:install --env=prod

The “–env=prod” parameter must be defined, as otherwise the development environment will be installed.

Provide values for basic system configuration when prompted.

The Installation is a four step process:

  1. The system requirements are checked. The setup process terminates if any of the requirements are not fulfilled.
  2. The database and all caches are reset.
  3. The initial data (i.e. migrations, workflow definitions and fixture data) are loaded and executed.
  4. The assets are dumped, RequireJS is initialized.

If you invoke the command without any arguments, you will be asked to enter some values for certain configuration options:

Option Description OroCRM OroCommerce
--application-url   n y
--organization-name   n y
--company-short-name Company short name y y
--company-name Company name y y
--user-name User name y y
--user-email User email y y
--user-firstname User first name y y
--user-lastname User last name y y
--user-password User password y y
--sample-data Determines whether sample data need to be loaded or not y y

Note

The installation process terminates with a warning if the environment does not meet any of the system requirements. You can try launching installation again after you fix the reported issue(s).

If any problem occurs, you can see the details in app/logs/oro_install.log file.

Hint

Normally, the installation process is terminated if it detects an already-existing installation. Use the “–force” option to overwrite an existing installation, e.g. during your development process.

Hint

After the installation finished remember to run php app/console oro:api:doc:cache:clear to warm-up the API documentation cache. This process may take several minutes.

Note

Please refer to the oro:install command help for more information on the parameters.

Usage:  oro:install [options]

Options:

--application-url[=APPLICATION-URL]      Application URL
--organization-name[=ORGANIZATION-NAME]  Organization name
--user-name[=USER-NAME]                  User name
--user-email[=USER-EMAIL]                User email
--user-firstname[=USER-FIRSTNAME]        User first name
--user-lastname[=USER-LASTNAME]          User last name
--user-password[=USER-PASSWORD]          User password
--skip-assets                            Skip UI related commands during installation
--symlink                                Symlinks the assets instead of copying it
--sample-data[=SAMPLE-DATA]              Determines whether sample data need to be loaded or not
--drop-database                          Database will be dropped and all data will be deleted
--skip-translations                      Determines whether translation data need to be loaded or not
--skip-download-translations             Determines whether translation data need to be downloaded or not
--force-debug                            Forces launching of child commands in debug mode; by default they are launched with
--no-debug
--timeout[=TIMEOUT]                      Execution timeout for child commands [default: 300]
-h, --help                               Display this help message
-q, --quiet                              Do not output any message
-V, --version                            Display this application version
--ansi                                   Force ANSI output
--no-ansi                                Disable ANSI output
-n, --no-interaction                     Do not ask any interactive question
-s, --shell                              Launch the shell
--process-isolation                      Launch commands from shell as a separate process
-e, --env=ENV                            The Environment name [default: "dev"]
--no-debug                               Switches off debug mode
--disabled-listeners=DISABLED-LISTENERS  Disable optional listeners, "all" to disable all listeners, command "oro:platform:optional-listeners" shows all listeners (multiple values allowed)
-v | vv | vvv, --verbose                 Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Silent Installation

For silent installation, use -n (no interaction) and -q (silence the output messages) parameters, and set the required parameters value, like in the example below. Replace items in bold with the information specific to your deployment.

php -dxcache.cacher=0 app/console oro:install
        --application-url=**<URL that is configured as an entry point for Oro application>**
        --env=prod
        --user-name=**admin**
        --user-email=**admin@example.com**
        --user-firstname=**John**
        --user-lastname=**Doe**
        --user-password=**admin**
        --sample-data=**y**
        --organization-name="**Acme, Inc**"
        --force
        --timeout=10000

Note

Use –sample-data=y only for learning purposes, test deployments and pre-production deployments. In this mode, OroCommerce is populated with sample data that help you unlock all the features so that you can quickly test the system after re-configuration or customization.

Note

The installation process terminates with the warning if the environment does not meet any of the system requirements. You can try launching installation again after you fix the reported issue(s).

If any problem occurs, you can see the details in app/logs/oro_install.log file.

Hint

Normally, the installation process is terminated if it detects an already-existing installation. Use the “–force” option to overwrite an existing installation, e.g. during your development process.

Hint

After the installation finished remember to run php app/console oro:api:doc:cache:clear to warm-up the API documentation cache. This process may take several minutes.

Via Installation Wizard

  1. In web browser, open the following URL:

    http://<ApplicationServerHost>:<ApplicationServerPort>/install.php

  2. Click Begin Installation on the Welcome to Oro Installer screen.

  1. During the System requirements check, the installation wizard will check the system configuration:

    Ensure that system requirements are met (status indicators should be green for all items) and click Next.

    The application configuration page emerges.

    The values defined in the configuration parameters will be filled in automatically, but they can be changed.

  2. For the Configuration, provide the following information:

    1. For Database connection:

      • provide a driver (either MySQL or PostgreSQL),
      • enter the database server host and port,
      • enter the database name (Name), user name and password for OroCommerce authentication with the database server.
      • For re-installation, specify whether OroCommerce should remove the existing database table contents. Available options are None, Application Tables, All Tables. The default value is None.
    2. In System settings, specify the system language and the secret for OAuth 2 client authorization.

    3. In Web settings, provide the prefix that will be attached to the application URL to access the OroCommerce configuration and administration application (backend).

    4. In Mailer settings, select the transport for the emails OroCommerce will be sending. Available options are PHP mail, SMTP, and sendmail. When you select the SNMP, please, provide the following mail server connection details: host, port, encryption (None, SSL, TLS), user name, and password.

    5. In the Websocket connection, set up your web service network configuration: service bind address and port, WS backend and frontend host/post.

    Once you are happy with the information you have provided, click Next.

  3. The Database initialization starts automatically.

    Hint

    If something goes wrong and a failure occurs, you can check error logs in the app/logs/oro_install.log file. Fix the errors, click the Back button and repeat.

    Click Next when status turns green for every step.

    The administration step appears.

  4. At the Administration step, provide the following information:

    1. Organization name

    2. Application URL (e.g. http://commerce.MyCompany.com)

    3. Create the first system administrator by providing a user name, a password (with confirmation), an email, and their first and last name.

    4. If necessary, select the Load Sample Data check box.

      Note

      Load Sample Data only for learning purposes, test deployments and pre-production deployments. In this mode, OroCommerce is populated with sample data that help you unlock all the features so that you can quickly test the system after re-configuration or customization.

    1. Finally, click Install and wait until the status for all operations turns green.

      Hint

      If something goes wrong and a failure occurs, you can check error logs in the app/logs/oro_install. Fix the errors, click Back and repeat the installation step.

      Once installation is complete, click Next.

  1. At the Finish step, click Launch Application to open the OroCommerce Administration Login screen.

    The URL will be similar to the following: http://<hostname>:<port>/app.php/admin/user/login. To log in, use credentials you provided for the first system administrator.

Related Topics