Skip to content

sugarcrm/Sugar-Instance-Packager

Repository files navigation

Helpers for packaging Sugar applications.

Minimum PHP Version

This repo provides a tool and classes for packaging Sugar instances. We may extend these in the future with helpers for packaging Sugar modules, language packs, and themes.

Packaging Instances

The following sections outline how to work with packaging a Sugar instance.

Supported Databases

  • MySQL

Installation

git clone https://github.com/sugarcrm/Sugar-Instance-Packager
cd Sugar-Instance-Packager
composer install --no-dev

If composer is not already installed, you can install it by following the instructions here: https://getcomposer.org/download/

Packaging a Sugar instance

To create a package from the command line, you can use packager.php. Usage is as follows

./packager.php [options] [<sugar-path>]
<sugar-path> is required

Command Options

Option Description
-h, --help Print this help message and exit.
-v, --version Print version information and exit.
--name [<package name>] File name of the package to be created. Defaults to "<UNIX timestamp>.zip".
--destination [<directory>] Directory to write the package to. Defaults to the current directory.
--type [<package type>] Type of package to create. Valid types are "MySQL" or "Cloud". Defaults to "Cloud".

Testing

Requires PHPUnit.

#install a Sugar instance to <Sugar-Instance-Packager Root>/sugar
vendor/bin/phpunit --group support --verbose

Contributing

Everyone is welcome to be involved by creating or improving packaging scripts. If you would like to contribute, please make sure to review the CONTRIBUTOR TERMS. When you update this README, please check out the contribution guidelines for helpful hints and tips that will make it easier to accept your pull request.

Contributors

Jerry Clark

Jonathan Wigglesworth

Licensed under Apache

© 2018 SugarCRM Inc. Licensed by SugarCRM under the Apache 2.0 license.

Third Party Libraries

About

A library for packaging Sugar instances

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages