PHPackages civicrm/civicrm-setup - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [DevOps & Deployment](/categories/devops) 4. / 5. civicrm/civicrm-setup AbandonedArchivedLibrary[DevOps & Deployment](/categories/devops) civicrm/civicrm-setup ===================== CiviCRM installation library v0.4.1(6y ago)756.6k↑5100%7[7 issues](https://github.com/civicrm/civicrm-setup/issues)1MITPHP Since Jan 23Pushed 6y ago8 watchersCompare [ Source](https://github.com/civicrm/civicrm-setup)[ Packagist](https://packagist.org/packages/civicrm/civicrm-setup)[ RSS](/packages/civicrm-civicrm-setup/feed)WikiDiscussions master Synced yesterday READMEChangelogDependencies (2)Versions (8)Used By (1) civicrm-setup ============= [](#civicrm-setup) `civicrm-setup` is a library for writing a CiviCRM installer. It aims to support multiple installers, such as the CLI command `cv`(`cv core:install` and `cv core:uninstall`) or per-CMS web-based installers (e.g. for `civicrm-drupal` or `civicrm-wordpress`). General design: - Installers call a high-level API ([Civi\\Setup](src/Setup.php)) which supports all major installation tasks/activities -- such as: - Check system requirements (`$setup->checkRequirements()`) - Check installation status (`$setup->checkInstalled()`) - Install data files (`$setup->installFiles()`) - Install database (`$setup->installDatabase()`) - A *data-model* ([Civi\\Setup\\Model](src/Setup/Model.php)) lists all the standard configuration parameters. This data-model is available when executing each task. For example, it includes: - The path to CiviCRM's code (`$model->srcPath`) - The system language (`$model->lang`) - The DB credentials (`$model->db`) - Each major task corresponds to an [*event*](https://github.com/civicrm/civicrm-setup/tree/master/src/Setup/Event) -- such as: - `civi.setup.checkRequirements` - `civi.setup.checkInstalled` - `civi.setup.installFiles` - `civi.setup.installDatabase` - *Plugins* (`plugins/*/*.civi-setup.php`) work with the model and the events. For example: - The plugin `init/WordPress.civi-setup.php` runs during initialization (`civi.setup.init`). It reads the WordPress config (e.g.`get_locale()` and `DB_HOST`) then updates the model (`$model->lang` and `$model->db`). - The plugin `installDatabase/SetLanguage.civi-setup.php` runs when installing the database (`civi.setup.installDatabase`). It reads the `$model->lang` and updates various Civi settings. Key features: - The library can be used by other projects -- such as `cv`, `civicrm-drupal`, `civicrm-wordpress` -- to provide an installation process. - It is a *leap*. It can coexist with the old installer, and it lives in a separate project/repo which can be deployed optionally. - *Example*: The `civicrm-wordpress` integration is phasing-in support for the new installer. By default, it uses the old installer. If you create a file `civicrm/.use-civicrm-setup`, then it will use the new installer. - It has minimal external dependencies. (The codebase for CiviCRM and its dependencies must be available -- but nothing else is needed.) Documentation ------------- [](#documentation) - [Getting started](docs/getting-started.md) - [Writing an installer](docs/new-installer.md) - [Writing a plugin](docs/new-plugin.md) - [Managing plugins](docs/plugins.md) ### Health Score 31 — LowBetter than 66% of packages Maintenance0 Infrequent updates — may be unmaintained Popularity36 Limited adoption so far Community20 Small or concentrated contributor base Maturity58 Maturing project, gaining track record Bus Factor1 Top contributor holds 93.7% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~123 days Recently: every ~156 days Total 7 Last Release 2346d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/1336047?v=4)[Tim Otten](/maintainers/totten)[@totten](https://github.com/totten) --- Top Contributors [![totten](https://avatars.githubusercontent.com/u/1336047?v=4)](https://github.com/totten "totten (208 commits)")[![monishdeb](https://avatars.githubusercontent.com/u/3735621?v=4)](https://github.com/monishdeb "monishdeb (10 commits)")[![JGaunt](https://avatars.githubusercontent.com/u/44573518?v=4)](https://github.com/JGaunt "JGaunt (3 commits)")[![mfb](https://avatars.githubusercontent.com/u/3278?v=4)](https://github.com/mfb "mfb (1 commits)") ### Embed Badge ![Health badge](/badges/civicrm-civicrm-setup/health.svg) ``` [![Health](https://phpackages.com/badges/civicrm-civicrm-setup/health.svg)](https://phpackages.com/packages/civicrm-civicrm-setup) ``` ### Alternatives [symfony/http-kernel Provides a structured process for converting a Request into a Response 8.1k869.4M8.7k](/packages/symfony-http-kernel)[matomo/matomo Matomo is the leading Free/Libre open analytics platform 21.7k38.9k](/packages/matomo-matomo)[symfony/mailer Helps sending emails 1.6k409.1M1.4k](/packages/symfony-mailer)[sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.5k5.9M735](/packages/sylius-sylius)[drupal/core Drupal is an open source content management platform powering millions of websites and applications. 21866.0M1.7k](/packages/drupal-core)[flow-php/flow PHP ETL - Extract Transform Load - Data processing framework 85036.3k](/packages/flow-php-flow) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)