README

Marketplace — is an extensible one-click modules and themes installer with command line and Magento backend interfaces. It allows to add unlimited number of custom software update channels and install modules and themes from any third-party vendor including official Magento Marketplace.

Contents

• Installation
• Usage
  • Command line interface
  • Magento backend interface
• Extending Marketplace
  • Register your update channel
  • Create one-click installer
• FAQ
  • Can I install modules from the packagist?
  • Can I install modules from private repository?

Installation

composer require swissup/module-marketplace
bin/magento setup:upgrade

Usage

Command line interface

1. Activate update channel and enter access keys:

   bin/magento marketplace:channel:enable

2. Install the package(s) you need:

   # Download and enable module:
   bin/magento marketplace:package:require <package/name>
   # Run one-click installer (if module provides it):
   bin/magento marketplace:package:install <package/name>

3. That's all. Check your store frontend now!

   Some modules requires additional configuration after installation. Please refer to the module documentation.

Magento backend interface

1. Navigate to System > Tools > Marketplace page.

2. Open Configuration panel, activate and add access keys to the channel you'd like to use.

3. Search for the module you'd like to install, and press Install button.

4. That's all. Check your store frontend now!

   Some modules requires additional configuration after installation. Please refer to the module documentation.

Extending Marketplace

Register your update channel

Custom update channels are registered via separate module with di.xml file instructions. See following examples:

• Magento Marketplace
• Swissup, Firecheckout, Argento
• Private channel as separate module

Create one-click installer

One-click installer is registered with etc/marketplace/installer.xml file. See following examples:

• Absolute Theme

FAQ

Can I install modules from the packagist?

Yes. But via CLI only.

Can I install modules from private repository?

Yes. But via CLI only. Here is an example:

# 1. Add your private repository to the composer.json
composer config repositories.<id> vcs https://github.com/repo/url.git

# 2. Setup auth data. Get token at https://github.com/settings/tokens/new?scopes=repo
bin/magento marketplace:auth github-oauth.github.com <token>

# 3. Use marketplace to download the module and run installer (if any)
bin/magento marketplace:package:require <package/name>
bin/magento marketplace:package:install <package/name>