PHPackages ashleydawson/deskpro-hab - 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. ashleydawson/deskpro-hab ActiveProject ashleydawson/deskpro-hab ======================== 1.0.10(6y ago)02PHPPHP ^7.1CI failing Since May 30Pushed 6y ago1 watchersCompare [ Source](https://github.com/AshleyDawson/deskpro-hab)[ Packagist](https://packagist.org/packages/ashleydawson/deskpro-hab)[ RSS](/packages/ashleydawson-deskpro-hab/feed)WikiDiscussions master Synced yesterday READMEChangelog (6)Dependencies (5)Versions (18)Used By (0) Deskpro Hab =========== [](#deskpro-hab) [![Build Status](https://camo.githubusercontent.com/4e80afb7f1fd48e78c633d69ed3590ddc0e4e422f645ecf3dc499c29c02e7b7f/68747470733a2f2f7472617669732d63692e6f72672f4173686c6579446177736f6e2f6465736b70726f2d6861622e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/AshleyDawson/deskpro-hab) Hab(itat) is a virtual development environment bootstrapper for setting up and configuring a guest [Vagrant](https://www.vagrantup.com/) instance. The Vagrant instance includes all development dependencies to run Deskpro and develop against it. Hab is designed for Linux and MacOS host machines. [![Deskpro Hab VM SSH Screenshot](https://github.com/AshleyDawson/deskpro-hab/raw/master/src/Resources/img/deskpro-hab-vm-screenshot.png)](https://github.com/AshleyDawson/deskpro-hab/raw/master/src/Resources/img/deskpro-hab-vm-screenshot.png) Installation ------------ [](#installation) Please install both [Vagrant](https://www.vagrantup.com/downloads.html) and [VirtualBox](https://www.virtualbox.org/wiki/Downloads) before using Hab. Hab is packaged as a .phar and is used to bootstrap the virtual development infrastructure from within the Deskpro project. [Download the latest version hab.phar](https://github.com/AshleyDawson/deskpro-hab/releases) and place it within the root of your Deskpro project directory. "Quick" Start Guide (Linux & MacOS) --------------------------------------- [](#quick-start-guide-linux--macos) 1. Install [Vagrant](https://www.vagrantup.com/downloads.html) and [VirtualBox](https://www.virtualbox.org/wiki/Downloads) on your computer 2. Clone the [Deskpro repository](https://github.com/deskpro/deskpro) 3. Go to the Deskpro project root and [download Hab](https://github.com/AshleyDawson/deskpro-hab/releases) to this location 4. Initialise and update Git submodules by running `git submodule init && git submodule update` 5. Run `php ./hab.phar init` to initialise Vagrant and provisioning scripts 6. Run `vagrant up` 7. Run `vagrant ssh` to access the virtual machine 8. Download and install [Composer](https://getcomposer.org/download/) globally on the virtual machine 9. Run `cd /var/www/deskpro/app/BUILD` 10. Run `composer install -o` 11. Run `cd /var/www/deskpro/www/assets/BUILD/web` 12. Run `npm install` (this could take a while) 13. Run `bower install --config.interactive=false --allow-root` 14. Run `npm run gulp` 15. Run `cd /var/www/deskpro/www/assets/BUILD/pub` 16. Run `npm install` (this could take a while) 17. Run `ASSET_SERVER_HOSTNAME=deskpro.local npm run dev` to start the asset server 18. In another terminal on the host machine (your computer) 19. Run `vagrant ssh` to access the virtual machine as another session 20. Run `bin/install --install-source dev` to install Deskpro, when prompted: - enter the project URL "" - enter "127.0.0.1" as the database hostname and "root" as both the database username and password. The database name is "deskpro" 21. Check that the `asset_paths` are pointed to `deskpro.local:9666` in `config/config.paths.php` 22. Add the following line to the bottom of `config/advanced/config.settings.php`: ``` $SETTINGS['DESKPRO_APP_ASSETS_URL'] = 'http://deskpro.local/assets/BUILD/pub/build/'; ``` 23. You should now be able to access Deskpro via `http://deskpro.local/` Usage ----- [](#usage) To initialise the Vagrantfile, settings and provisioning scripts, run the `init` command: ``` $ php hab.phar init ``` This will install the necessary files ready to start your virtual machine using the standard Vagrant commands: ``` $ vagrant up && vagrant ssh ``` You can pass along several options to adjust the virtual machine instance settings that are subsequently stored in the `hab.json` file. ``` php hab.phar init \ --project-dir /path/to/project/dir \ --hostname deskpro.local \ --ip 192.168.2.34 \ --memory 2048 \ --cpus 4 \ --force ``` The options are as follows: - **project-dir** - The location of your Deskpro project directory, default is `current directory` - **hostname** - Hostname of the VM, default is `deskpro.local` - **ip** - Private IP address of the guest VM, default is `10.40.1.23` - **memory** - How much memory (in megabytes) is allocated to the VM, default is `4096` - **cpus** - How many CPUs the VM has, default is `2` - **force** - Force an overwrite of the hab bootstrap files, default is `false` After Hab has been initialised you should exclude the following files from version control (usually by adding to a `.gitignore` file): ``` /.vagrant /.hab /hab.phar /hab.json /Vagrantfile ``` Once the VM is booted, you can then SSH into it and run the usual installation and setup scripts as described in the [Deskpro setup instructions](https://github.com/deskpro/deskpro/blob/develop/README.md). **Note:** When running the dev assets server, do the following to override the default hostname: ``` $ ASSET_SERVER_HOSTNAME=deskpro.local npm run dev ``` Assets server env. variables are as follows: - `ASSET_SERVER_HOSTNAME` - Override the asset server hostname (default is `localhost`) - `ASSET_SERVER_PORT` - Override the asset server port (default is `9666`) **Note:** To run the Deskpro test suite you will need to configure the application to use `--login-path` option for things like `mysqldump`, etc. as this will suppress the "password in command prompt is insecure" warnings. This is done by adding the `--login-path=local` option to the test configuration database parameters (after copying the .dist config): ``` # app/BUILD/tests/config/config.all.php // ... $CONFIG['database'] = [ 'host' => '127.0.0.1', 'user' => 'root', 'password' => 'root', 'dbname' => $dbName.$dbPostfix, 'login-path' => 'local', // Append this parameter ]; // ... ``` Default Service Connectivity ---------------------------- [](#default-service-connectivity) - MySQL DSN: `mysql://root:root@deskpro.local:3306/deskpro` - Elasticsearch URL: `http://deskpro.local:9200/` *(requires service start)* Updating -------- [](#updating) The `hab.phar` package may be self updated using the following command: ``` $ php hab.phar self-update ``` After updating, you'd usually want to force initialise the modified bootstrap files: ``` $ php hab.phar init --force ``` Testing ------- [](#testing) You may run the Hab functional test suite using the following: ``` $ composer install $ vendor/bin/phpunit -c . ``` ### Health Score 26 — LowBetter than 43% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity2 Limited adoption so far Community7 Small or concentrated contributor base Maturity63 Established project with proven stability Bus Factor1 Top contributor holds 100% 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 ~20 days Recently: every ~39 days Total 17 Last Release 2218d ago Major Versions 0.1.0 → 1.0.02019-05-31 ### Community Maintainers ![](https://www.gravatar.com/avatar/958ec06d53fff9021d93c8728740d74bf348a3ad22a4fb22ef6c1de9ee7f4f7a?d=identicon)[AshleyDawson](/maintainers/AshleyDawson) --- Top Contributors [![AshleyDawson](https://avatars.githubusercontent.com/u/1968942?v=4)](https://github.com/AshleyDawson "AshleyDawson (45 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/ashleydawson-deskpro-hab/health.svg) ``` [![Health](https://phpackages.com/badges/ashleydawson-deskpro-hab/health.svg)](https://phpackages.com/packages/ashleydawson-deskpro-hab) ``` ### Alternatives [vimeo/psalm A static analysis tool for finding errors in PHP applications 5.8k77.5M6.7k](/packages/vimeo-psalm)[sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.4k5.6M651](/packages/sylius-sylius)[shopware/platform The Shopware e-commerce core 3.3k1.5M3](/packages/shopware-platform)[sulu/sulu Core framework that implements the functionality of the Sulu content management system 1.3k1.3M152](/packages/sulu-sulu)[prestashop/prestashop PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers. 9.0k15.4k](/packages/prestashop-prestashop)[shopware/core Shopware platform is the core for all Shopware ecommerce products. 595.2M386](/packages/shopware-core) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)