Before starting the Middleware SAAS installation process, ensure that your system meets the following requirements:
- PHP: Version 8.1
- Node.js: Version 18
- MySQL: Version 8.0
Step 1: Download the Middleware SAAS Application
First, download the Middleware SAAS Application from the provided Git link. Once downloaded, rename the parameters-dist.yml
file to parameters.yml
.
Step 2: Install Necessary Bundles
Download the required bundles from the provided links and unzip them. After unzipping, merge the src
folder from each bundle into your application project:
- Doctrine Messenger
- Account Bundle
- SignUp Bundle
- Middleware API Client Bundle
Step 3: Register Bundles
Next, register the bundles in the config/bundles.php
file by adding the following lines:
Webkul\SignUpBundle\SignUpBundle::class => ['all' => true], Webkul\AccountsBundle\AccountsBundle::class => ['all' => true], Webkul\AkeneoApiClientBundle\AkeneoApiClientBundle::class => ['all' => true],
Step 4: Define Routing
Create routing files in the config/routes
directory:
wk_akeneoapiclient.yml
(this file is in the API Client Bundle zip file)wk_app.yml
(this file is in the SignUp Bundle zip file)wk_account.yml
(this file is in the Accounts Bundle zip file)
Step 5: Configure Environment Variables
Update the environment file (.env
) with the following details:
APP_DATABASE_NAME=akeneo_app APP_DATABASE_USER=root APP_DATABASE_PASSWORD=webkul
Rename config/parameters-dist.yml
to config/parameters.yml
.
Step 6: Install Dependencies
Run the following command to install all necessary dependencies:
composer install
Then, set the NO_DOCKER
environment variable to true
and run the Production setup:
NO_DOCKER=true make prod
Step 7: Module Installation
Unzip the respective extension zip files and merge the src
folder into the Akeneo app root directory. Follow the CE Akeneo 7 module installation process.
Step 8: Configure User-Central Project
After Middleware SAAS installation, you need to configure the app service in the user-central project. For this process, contact Vipin Yadav. The necessary steps include:
- Service creation
- App creation
- Service plan creation
Update the Akeneo app parameters.yml
file with the SERVICE_ID
key value and the CENTRAL_CONTROL_SERVICE_HOST
value.
CETRAL_CONTROL_SERVICE_HOST: ‘https://fa20-122-184-75-2.ngrok-free.app’
Step 9: App Connection for CE (Akeneo 6/Akeneo 7)
Navigate to the Akeneo Connect menu, then to the App Store, and create a test app. If the “Create a test app” button is not visible, follow these steps:
- Modify the following files
# vendor/akeneo/pim-community-dev/src/Akeneo/Connectivity/Connection/back/Infrastructure/Symfony/Resources/config/acl.yml akeneo_connectivity_connection_manage_test_apps: type: action label: akeneo_connectivity.connection.acl.manage_test_apps group_name: pim_system.acl_group.developer_mode order: -10
# vendor/akeneo/pim-community-dev/src/Akeneo/Platform/Bundle/UIBundle/Resources/config/acl_groups.yml pim_system.acl_group.developer_mode: order: 400
# vendor/akeneo/pim-community-dev/src/Akeneo/Platform/Bundle/FeatureFlagBundle/Configuration/EnvVarFeatureFlag.php public function __construct($envVar) { $this->envVar = boolval($envVar); $this->envVar = true; }
- Provide ACL permissions.
- Update the Akeneo .env file
AKENEO_PIM_URL=http://localhost:8080
Change toAKENEO_PIM_URL=your_akeneo_url_without_slash_at_the_end
Step 10: Create and Configure the App
After creating the credentials, ensure the middleware’s environment file contains the key and secret correctly (with quotes around both).
If the “Create” button is not visible in the App Store, check the ACL permissions at the following path: system -> role -> permissions
. Ensure the production mode is checked for the specific role.
Step 11: Connect the App
If an error occurs stating that “Some system requirements are not fulfilled,” address the issues as indicated in the output messages.
To connect the app, click the “Create App” button and fill out the form with the following URLs:
- Activate URL:
domainname/authorization/activate
- Callback URL:
domainname/callback
After clicking the “Create” button, copy the client_id
and client_secret
and configure your app .env file with these values. Finally, click the “Done” button.
Now, your test app is created and you can see it in the App Store. Click the “Connect” button, provide the necessary permissions, and connect the app.
Step 12: Troubleshooting
If you encounter a mailer issue during the connection from Akeneo to the middleware, run the following command:
composer require symfony/mailer:^5.4.0
By following these detailed steps, you will successfully install and configure the Middleware Application and its required extensions.
Support
For more detailed information on PHP installation, visit the official PHP documentation.
Refer to the Node.js installation guide for proper setup instructions.
Check out the MySQL installation guide for assistance with MySQL configuration.
For any further queries you can reach out to us through [email protected] and you can also check our Akeneo Development Services.
Be the first to comment.