Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lemberg/draft-environment
Vagrant-based environment setup for Draft Drupal
https://github.com/lemberg/draft-environment
drupal drupal-8 drupal-draft vagrant virtualbox vm
Last synced: 2 months ago
JSON representation
Vagrant-based environment setup for Draft Drupal
- Host: GitHub
- URL: https://github.com/lemberg/draft-environment
- Owner: lemberg
- Created: 2017-02-03T13:57:34.000Z (almost 8 years ago)
- Default Branch: 3.x.x
- Last Pushed: 2023-09-20T07:43:56.000Z (over 1 year ago)
- Last Synced: 2024-09-30T15:13:12.881Z (3 months ago)
- Topics: drupal, drupal-8, drupal-draft, vagrant, virtualbox, vm
- Language: PHP
- Homepage:
- Size: 3.16 MB
- Stars: 3
- Watchers: 5
- Forks: 4
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Draft Environment
[](https://packagist.org/packages/lemberg/draft-environment)
[](https://codecov.io/gh/lemberg/draft-environment)
This is Vagrant-based development environment for Drupal projects. This project is a part of a [Draft](https://github.com/lemberg/draft-template) Drupal project template.
## Prerequisites
- PHP (7.4+) and Composer 2
- Vagrant (2.2.6+)
- VirtualBox (5.2+)
- [mkcert](https://mkcert.dev) (optional)
## Vagrant plugins (will be automatically installed)
#### [Vagrant Host Manager](https://github.com/devopsgroup-io/vagrant-hostmanager)
Manages host and/or guest `hosts` files. Draft is configured to create a `hostname.test` DNS record on a host machine.
#### [vagrant-disksize](https://github.com/sprotheroe/vagrant-disksize)
A Vagrant plugin to resize disks in VirtualBox.
#### [Vagrant WinNFSd (WINDOWS only)](https://github.com/winnfsd/vagrant-winnfsd)
Dramatically increases disk IO on Windows by adding NFS support.
## How to
1. (Optional) Locally-trusted SSL certificates
**Skip this step if `mkcert` is already installed and the local CA does already exist.**
Install [mkcert](https://mkcert.dev) in order to get locally-trusted development SSL certificates. This tool requires no configuration. After installation just run:
```
$ mkcert -install
```
1. Add Draft Environment to the project (as a dev dependency):
```
$ composer require --dev lemberg/draft-environment
```
1. Configure guest machine by answering installer's questions. At the moment, project name (hostname) and PHP version are the only settings that can be set interactively
1. Override any variable used in any Ansible role by manually editing the `vm-settings.yml`. All available variables alongside with their default values are listed in [default.vm-settings.yml](/default.vm-settings.yml)
Here's the list of used roles:
- draft (internal)
- [oefenweb.swapfile @ v2.0.35](https://github.com/Oefenweb/ansible-swapfile/tree/v2.0.35)
- [geerlingguy.mailhog @ 2.3.0](https://github.com/geerlingguy/ansible-role-mailhog/tree/2.3.0)
- git_config (internal)
- apache2 (internal)
- [geerlingguy.mysql @ 3.5.0](https://github.com/geerlingguy/ansible-role-mysql/tree/3.5.0)
- [t2l.php @ 1.6.2](https://github.com/T2L/ansible-role-php/tree/1.6.2)
- [t2l.composer @ 2.0.5](https://github.com/T2L/ansible-role-composer/tree/2.0.5)
- [t2l.java @ 1.3.3](https://github.com/T2L/ansible-role-java/tree/1.3.3)
- [t2l.solr @ 2.2.2](https://github.com/T2L/ansible-role-solr/tree/2.2.2)
2. Create and provision the guest machine:
```
$ vagrant up
```
2. Commit `.gitignore`, `Vagrantfile` and `vm-settings.yml` to lock the VM state
1. Configuration can be overridden locally by creating and editing `vm-settings.local.yml` (and this file must not be committed)
## Documentation
Everybody loves documentation. We do too! [Check this out](/docs).
## Changelog
Changelog can be found here [CHANGELOG.md](/CHANGELOG.md)