Installation Tutorial for Mautic 5.1.1 Compatibility

[iuriJorbenadze]

Simplified Guide: Installing Custom Objects Plugin for Mautic 5.1.1
This guide helps you set up the Custom Objects plugin with Mautic 5.1.1 using the latest compatibility updates, while simplifying the upload process.

---

Al following steps are done locally in your computer before you even go to mautic instance.

Step 1: Clone the Plugin and Apply Compatibility Changes

1. Clone the staging branch of the Custom Objects plugin using Git Bash:

git clone -b staging https://github.com/acquia/mc-cs-plugin-custom-objects.git

2. Go into the cloned folder:

cd mc-cs-plugin-custom-objects

3. Add the upstream repository:

git remote add upstream https://github.com/acquia/mc-cs-plugin-custom-objects.git

4. Fetch the changes from PR Update to 5.x #338 (Mautic 5 compatibility):

git fetch upstream pull/338/head:pr-338

5. Merge the PR into your local staging branch:

git checkout staging
git merge pr-338

---

Step 2: Prepare the Plugin for Upload

1. Archive the folder (mc-cs-plugin-custom-objects) into a ZIP file.
2. Rename the ZIP file to CustomObjectsBundle.zip.

---

Step 3: Upload and Extract on Mautic Server

1. Upload CustomObjectsBundle.zip to the plugins folder of your Mautic installation using SFTP or a file manager.
2. Extract the ZIP file inside the plugins folder.
3. Rename the extracted folder to CustomObjectsBundle.

---

Step 4: Install the Plugin in Mautic

1. SSH into your Mautic server and navigate to the plugins directory
   or in file manager of your server just go to mautic installation directory and go to plugins folder.

cd your-mautic-path/plugins

IMPORTANT STEP: I had error 500, to fix it you need to manually run this command:

2. Run the Mautic plugin installation command:

sudo /usr/bin/php your-mautic-path/bin/console mautic:plugins:install

o You should see output confirming that 1 plugin was installed.

3. Clear the Mautic cache:

sudo /usr/bin/php your-mautic-path/bin/console cache:clear

---

Step 5: Verify Plugin Installation

1. Log in to your Mautic dashboard.
2. Go to Settings > Plugins and check if the Custom Objects plugin is listed and activated.

---

Final Notes
• If you encounter a 500 Internal Server Error after extracting the plugin, this is expected as Mautic needs to recognize the new plugin. It should be resolved after running the installation and clearing the cache.
• If you experience any issues, check the Mautic logs in:

your-mautic-path/var/logs/

After all this you will have CustomObjectsBundle running for Mautic 5 version.

[Moongazer]

Is this installation tutorial still required / up-to-date, or can we just using composer by adding "acquia/mc-cs-plugin-custom-objects": "5.x-dev", to the composer.json?

Or asked differently: is the PR already merged into the 5.x branch of this repository?

Because mergin pr-338 into staging results in many merge conflicts:

Auto-merging .github/workflows/tests.yml
Auto-merging Config/config.php
CONFLICT (content): Merge conflict in Config/config.php
Auto-merging Entity/CustomFieldOption.php
CONFLICT (content): Merge conflict in Entity/CustomFieldOption.php
Auto-merging EventListener/DynamicContentSubscriber.php
CONFLICT (content): Merge conflict in EventListener/DynamicContentSubscriber.php
Auto-merging EventListener/TokenSubscriber.php
CONFLICT (content): Merge conflict in EventListener/TokenSubscriber.php
Auto-merging Segment/Query/Filter/QueryFilterFactory.php
Auto-merging Tests/Unit/EventListener/DynamicContentSubscriberTest.php
CONFLICT (content): Merge conflict in Tests/Unit/EventListener/DynamicContentSubscriberTest.php
Auto-merging Tests/Unit/EventListener/TokenSubscriberTest.php
Auto-merging Tests/Unit/Helper/LockFlashMessageHelperTest.php
Auto-merging phpstan.neon
Automatic merge failed; fix conflicts and then commit the result.

All the different information out there are very confusing to make custom-objects work with Mautic 5, thanks for cleaning up a bit.

[PierreAmmeloot]

Hello, can the plugin currently be installed directly from the marketplace?

When I try to install it on Mautic 5.2.8, I get the following error:

php bin/console mautic:marketplace:install acquia/mc-cs-plugin-custom-objects
Installing acquia/mc-cs-plugin-custom-objects, this might take a while...
Error while installing this plugin.
Check the logs for more details or run again with the -vvv parameter.

Pierre