Installation

Follow the steps below to install the UnoPim Bagisto Connector. Choose the installation method that best fits your setup - we recommend the Composer method for most users.

Option 1: Installation with Composer (Recommended)

The simplest and most efficient way to install the UnoPim Bagisto Connector is using Composer. This method automatically handles all dependencies and configuration.

Step 1 - Install via Composer

Run the following command in your UnoPim project root directory:

composer require unopim/bagisto-connector

Command	Purpose
composer require unopim/bagisto-connector	Downloads and installs the Bagisto connector package and updates Composer dependencies.

This command downloads and installs the UnoPim Bagisto Connector package along with all required dependencies.

Step 2 - Run Setup Commands

Execute the following commands in order to complete the installation:

php artisan migrate
php artisan vendor:publish --tag=unopim-bagisto-connector
php artisan optimize:clear

Here's what each command does:

Command	Purpose
php artisan migrate	Runs database migrations to set up necessary tables
php artisan vendor:publish --tag=unopim-bagisto-connector	Publishes configuration files and assets for the connector
php artisan optimize:clear	Clears the application cache to reflect new changes

Step 3 - Enable Queue Operations

The Bagisto Connector uses queued jobs for background operations like product exports. Start the queue worker by running:

php artisan queue:work --queue=default,system,completeness

Command	Purpose
php artisan queue:work --queue=default,system,completeness	Starts a queue worker for Bagisto jobs on the listed queues.

This command starts the worker and monitors the default, system, and completeness queues for new jobs. Keep this process running in the background.

For production environments, it's recommended to use a process manager like Supervisor to manage the queue worker continuously.

---

Option 2: Local Package Installation (Development & Forking)

Use this installation method only if you need to load the package from your local packages/ directory. This is ideal for development work, debugging, or when forking the connector for customization.

Step 1 - Place the Package Locally

1. Download and extract the Bagisto Connector package
2. Rename the extracted folder to Bagisto
3. Move the Bagisto folder into the packages/Webkul/ directory of your UnoPim 2.0 project

Your final path should be:

packages/Webkul/Bagisto/

Step 2 - Register the Namespace in Composer

Open your project's composer.json file and add the package namespace under the autoload.psr-4 section:

"autoload": {
    "psr-4": {
        "Webkul\\Bagisto\\": "packages/Webkul/Bagisto/src"
    }
}

Step 3 - Register the Service Provider

UnoPim 2.0 uses the Laravel 12+ bootstrap structure for service providers.

Open bootstrap/providers.php and add the Bagisto service provider to the returned array:

<?php

return [
    // ...other providers,
    Webkul\Bagisto\Providers\BagistoServiceProvider::class,
];

NOTE

This registers BagistoServiceProvider in Laravel so the connector can bootstrap its services, routes, and package configuration during application startup.

Step 4 - Choose Your Setup Method

You have two options to complete the installation:

Option A: Quick Setup with Installer Command (Recommended)

This single command handles all setup steps automatically:

composer dump-autoload
php artisan bagisto-package:install
php artisan optimize:clear

The installer will run database migrations, publish configuration files, and clear the cache.

Command	Purpose
composer dump-autoload	Regenerates Composer's autoloader mapping to include the newly added namespace.
php artisan bagisto-package:install	Runs the Bagisto connector installer and required setup tasks.
php artisan optimize:clear	Clears all cached files (bootstrap, configuration, routes, and views) to load the new changes.

Option B: Manual Setup (Fine-Grained Control)

If you prefer to run each step individually, execute these commands:

composer dump-autoload
php artisan migrate
php artisan vendor:publish --tag=unopim-bagisto-connector
php artisan optimize:clear

Here's what each command does:

Command	Purpose
composer dump-autoload	Refreshes the Composer autoloader to recognize the new package
php artisan migrate	Runs database migrations to set up necessary tables
php artisan vendor:publish --tag=unopim-bagisto-connector	Publishes configuration files and assets for the connector
php artisan optimize:clear	Clears the application cache to reflect new changes

Step 5 - (Optional) Install as a Path Repository

If you want to keep the package in packages/Webkul/Bagisto/ but still use Composer for automatic provider discovery, register it as a path repository:

composer config repositories.bagisto '{"type":"path","url":"packages/Webkul/Bagisto","options":{"symlink":true}}' --json
composer require unopim/bagisto-connector:"*@dev"

Command	Purpose
composer config repositories.bagisto '{"type":"path","url":"packages/Webkul/Bagisto","options":{"symlink":true}}' --json	Registers the local package path as a Composer repository for development use.
composer require unopim/bagisto-connector:"*@dev"	Installs the connector from the configured local path/dev source.

Then run the setup commands from Step 4 above.

---

Configure Queue for Production

The Bagisto Connector dispatches background jobs to Laravel queues for efficient processing. Ensure a queue worker is running:

php artisan queue:work --queue=default,system,completeness

Command	Purpose
php artisan queue:work --queue=default,system,completeness	Starts a queue worker for Bagisto jobs on the listed queues.

This command starts the worker and monitors the default, system, and completeness queues for new jobs.

For production environments, configure the queue to run continuously using a process manager like Supervisor.

After upgrading the connector, restart your process manager to load the new code:

sudo service supervisor restart

Command	Purpose
sudo service supervisor restart	Restarts Supervisor so queue workers pick up the latest connector code.

This ensures all background tasks have access to the latest connector updates.

---

Verify the Installation

Once all steps are complete, log in to your UnoPim dashboard. The Bagisto Connector should now be active and ready to use. You can begin:

• Configuring your Bagisto store connection
• Setting up product export mappings
• Exporting categories, attributes, and products