/proton

Marello Application

Primary LanguagePHPOtherNOASSERTION


Proton ERP Unified Commerce Management

Proton ERP provides powerful capabilities to meet and exceed the evolving demands of modern commerce. It enables businesses to efficiently manage multiple sales channels, offering real-time visibility into B2C and B2B orders, inventory, fulfillment, customer data, and more. Proton ERP's unified approach allows seamless shopping experiences, letting customers buy anywhere, fulfill anywhere, and return anywhere—all within one integrated system that serves as a single source of truth for your business.

This document outlines how to download, install, and start using Proton ERP.

Requirements

Proton ERP is built on Symfony 5.4 and has the following requirements:

  • PHP 8.2 or above, with the command-line interface
  • PHP Extensions:
    • ctype
    • curl
    • fileinfo
    • gd
    • intl (ICU library 4.4 and above)
    • json
    • mbstring
    • sodium
    • openssl
    • pcre
    • simplexml
    • tokenizer
    • xml
    • zip
    • imap
    • soap
    • bcmath
    • ldap
    • pgsql
  • PostgreSQL 15.1

Installation Instructions

Since both Symfony and Proton ERP use Composer to manage dependencies, it’s recommended to use Composer for the installation process.

  1. Clone the Proton ERP application repository:
git clone -b x.y.z https://github.com/bleuproton/proton.git

Replace x.y.z with the latest release tag, or use the latest master branch:

git clone https://github.com/bleuproton/proton.git
  1. Install Composer globally by following the official Composer installation documentation.

  2. Ensure that you have Node.js (>=18.14.0, <19) and NPM (>=9.3.1, <10) installed.

  3. Install Proton ERP dependencies using Composer. If the installation is slow, you can use the --prefer-dist option. In the Proton ERP application folder, run the following command:

composer install --prefer-dist --no-dev
  1. Create the database using the name you specified during setup (default: "proton_application").

  2. Increase PHP memory limit (temporarily, if needed) to 1GB in the php.ini file for the installation process:

memory_limit=1024M

After the installation, you can revert the memory_limit to the recommended 512MB or more.

  1. Install Proton ERP and create the admin user using the Installation Wizard by opening install.php in the browser or by running the following from the CLI:
php bin/console oro:install --env prod

If the installation times out, add the --timeout=0 argument to the command.

  1. Enable WebSockets messaging by running:
php bin/console gos:websocket:server --env prod
  1. Configure crontab or scheduled tasks to execute the following command every minute:
php bin/console oro:cron --env prod
  1. Start the message queue processing with the following command:
php bin/console oro:message-queue:consume --env=prod

We recommend using a supervisor to run the oro:message-queue:consume command continuously, as many background tasks rely on the message queue to operate. For more details on configuration, check the Oro documentation or visit the Supervisord website.

Note: bin/console is relative to the project root folder. Ensure you're using the full path in crontab configuration or when running the command from another location.

Additional Installation Notes

Installed PHP Accelerators must be compatible with Symfony and Doctrine (support for DOCBLOCKs is required).
Ensure that the WebSocket port is open in your firewall for incoming and outgoing connections.
For additional performance optimization, consult the Oro performance documentation.

Web Server Configuration

Since Proton ERP is based on the Symfony standard, you can follow the same web server configuration recommendations.

More Detailed Installation Guide

For a more comprehensive guide on installing Proton ERP, including advanced configurations and troubleshooting tips, refer to the official Oro Inc. installation documentation for version 5.1.

Package Manager Configuration

Ensure that a GitHub OAuth token is configured in the package manager settings.


This version includes the link to the Oro installation guide for version 5.1, providing a more complete reference for anyone setting up Proton ERP. Let me know if you need further adjustments!