Deploying Bagisto

Bagisto is a free and open-source Laravel-based eCommerce platform designed for building scalable online stores, multi-vendor marketplaces, and B2B commerce solutions. Built on the powerful Laravel framework with a Vue.js frontend, Bagisto provides a modern, customizable foundation for creating feature-rich eCommerce applications.

Why Bagisto?

Bagisto stands out in the eCommerce platform landscape with its unique combination of power and flexibility:

• Laravel Foundation: Built on Laravel, one of the most popular PHP frameworks, ensuring clean code, security, and scalability
• Multi-Vendor Marketplace: Native support for creating multi-seller marketplaces with vendor management
• B2B & B2C: Support for both business-to-business and business-to-consumer commerce models
• Headless Commerce: REST API and GraphQL support for building custom storefronts and mobile applications
• Multi-Channel: Manage multiple stores, currencies, and locales from a single installation
• Extensible Architecture: Modular design with package development support for custom features
• PWA Ready: Progressive Web App support for mobile-first experiences
• Built-in Features: Product management, inventory control, tax rules, shipping methods, and payment integrations

With over 24,000 GitHub stars and trusted by 25,000+ businesses worldwide, Bagisto has established itself as a leading open-source eCommerce solution.

Prerequisites

Before deploying Bagisto, you’ll need:

• A Klutch.sh account
• A MySQL database instance - follow our MySQL deployment guide to set one up

Database Requirements

Bagisto requires MySQL version 8.0.32 or higher with the utf8mb4_unicode_ci collation for full Unicode and emoji support.

Deploying Bagisto

1. Create a New Project

   Log in to your Klutch.sh dashboard and create a new project for your eCommerce store.

2. Deploy MySQL Database

   If you haven’t already, deploy a MySQL 8.0+ database instance by following the MySQL guide. Take note of your database credentials for the next step.

3. Create a New App

   Create a new app within your project using the following Docker image from Docker Hub:

   webkul/bagisto:2.3.6

   This official Bagisto image includes PHP 8.2, Apache, and all required PHP extensions pre-configured.

4. Configure Environment Variables

   Set up the following environment variables for your Bagisto deployment:

   Variable	Description	Example
   APP_NAME	Your store name	My Store
   APP_ENV	Application environment	production
   APP_DEBUG	Enable debug mode	false
   APP_KEY	Application encryption key	base64:... (generate a 32-character random string)
   APP_URL	Your store’s public URL	https://your-app.klutch.sh
   APP_ADMIN_URL	Admin panel path	admin
   DB_CONNECTION	Database driver	mysql
   DB_HOST	MySQL host from Klutch	your-mysql-host
   DB_PORT	MySQL port	3306
   DB_DATABASE	Database name	bagisto
   DB_USERNAME	Database username	bagisto_user
   DB_PASSWORD	Database password	your-secure-password
   CACHE_DRIVER	Cache storage driver	file
   SESSION_DRIVER	Session storage driver	file
   QUEUE_CONNECTION	Queue driver	sync

   Generate APP_KEY

   You can generate a secure APP_KEY by running php artisan key:generate --show locally, or use an online tool to generate a base64-encoded 32-character random string.

5. Configure Persistent Storage

   Add a persistent volume to store uploaded files, product images, and cache:

   Mount Path	Description
   /var/www/html/storage	Application storage (uploads, cache, logs)

   Allocate at least 5GB of storage to accommodate product images and media files.

6. Set Network Configuration

   Configure your app to use HTTP traffic on port 80, which is the default Apache port in the Bagisto container.

7. Deploy Your App

   Click Deploy to start your Bagisto instance. The initial deployment may take a few minutes as the application initializes and runs database migrations.

Post-Deployment Configuration

Accessing the Admin Panel

Once deployed, access your Bagisto admin panel at:

https://your-app.klutch.sh/admin

Use the default administrator credentials:

• Email: admin@example.com
• Password: admin123

Security Warning

Change the default admin password immediately after your first login. Navigate to Settings → Users in the admin panel to update your credentials.

Initial Store Setup

After logging in, complete these essential configuration steps:

1. Update Admin Credentials: Change the default email and password
2. Configure Store Information: Set your store name, address, and contact details under Settings → Channels
3. Set Currency and Locale: Configure your default currency and language under Settings → Locales and Settings → Currencies
4. Configure Tax Rules: Set up tax categories and rates under Settings → Taxes
5. Add Payment Methods: Configure payment gateways under Settings → Payment Methods
6. Configure Shipping: Set up shipping methods and rates under Settings → Shipping Methods

Adding Products

To add your first products:

1. Navigate to Catalog → Products in the admin panel
2. Click Add Product and select the product type
3. Fill in product details, pricing, and inventory information
4. Upload product images
5. Set product categories and attributes
6. Save and publish your product

Sample Docker Compose for Local Development

For local development and testing before deploying to Klutch.sh, you can use this Docker Compose configuration:

version: '3.8'

services:
  bagisto:
    image: webkul/bagisto:2.3.6
    ports:
      - "8080:80"
    environment:
      - APP_NAME=Bagisto
      - APP_ENV=local
      - APP_DEBUG=true
      - APP_URL=http://localhost:8080
      - DB_CONNECTION=mysql
      - DB_HOST=mysql
      - DB_PORT=3306
      - DB_DATABASE=bagisto
      - DB_USERNAME=bagisto
      - DB_PASSWORD=secret
    volumes:
      - bagisto_storage:/var/www/html/storage
    depends_on:
      mysql:
        condition: service_healthy

  mysql:
    image: mysql:8.0
    environment:
      - MYSQL_ROOT_PASSWORD=rootsecret
      - MYSQL_DATABASE=bagisto
      - MYSQL_USER=bagisto
      - MYSQL_PASSWORD=secret
    volumes:
      - mysql_data:/var/lib/mysql
    healthcheck:
      test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
      interval: 10s
      timeout: 5s
      retries: 5

volumes:
  bagisto_storage:
  mysql_data:

Save this as docker-compose.yml and run:

docker-compose up -d

Access Bagisto at http://localhost:8080 and the admin panel at http://localhost:8080/admin.

Performance Optimization

Enable Redis for Caching

For better performance in production, deploy a Redis instance using our Redis guide and update your environment variables:

Variable	Value
CACHE_DRIVER	redis
SESSION_DRIVER	redis
QUEUE_CONNECTION	redis
REDIS_HOST	Your Redis host
REDIS_PORT	6379
REDIS_PASSWORD	Your Redis password (if set)

Enable Elasticsearch for Search

For enhanced product search functionality, deploy an Elasticsearch instance and configure:

Variable	Value
ELASTICSEARCH_HOST	Your Elasticsearch host
ELASTICSEARCH_PORT	9200

Additional Resources

• Bagisto Documentation - Official developer documentation
• Bagisto User Guide - End-user documentation
• Bagisto GitHub Repository - Source code and issue tracking
• Bagisto Extensions - Official and community extensions
• Bagisto Forums - Community support and discussions