https://github.com/msztorc/laravel-starter
Laravel starter - Ansible Provisioner not only for Vagrant
https://github.com/msztorc/laravel-starter
ansible laravel provisioning vagrant
Last synced: 27 days ago
JSON representation
Laravel starter - Ansible Provisioner not only for Vagrant
- Host: GitHub
- URL: https://github.com/msztorc/laravel-starter
- Owner: msztorc
- Created: 2019-09-25T20:31:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-04-16T20:05:42.000Z (about 5 years ago)
- Last Synced: 2024-11-03T12:32:14.073Z (6 months ago)
- Topics: ansible, laravel, provisioning, vagrant
- Homepage:
- Size: 77.1 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Laravel Starter
[](https://travis-ci.org/msztorc/laravel-starter)
[](https://www.opensource.org/licenses/MIT)
[](https://github.com/msztorc/laravel-starter)
Quick and easy server provisioning for Laravel using Ansible + Vagrant auto provisioning for local environments.
**Default environment setup**
- ubuntu 18.04 (bionic64)
- laravel:latest
- php 7.4
- mysql 5.7
- nginx
#### Provisioning methods
- Vagrant deployment with Ansible local provisioning
- Ansible provisioning (remote environments)
### Quick start
Clone this repo
```bash
git clone https://github.com/msztorc/laravel-starter.git
```
```bash
cd laravel-starter
```
Adjust your config settings like project name, passwords, etc... - see below for more details.
**Provisioning variables**
[provisioning/group_vars/all](provisioning/group_vars/all)
```yaml
web_root: /var/www/my-project # project path
web_host: laravel.host # project domain
db_root_pass: p4ssvv0rD # database root password
app_db_name: my-project # application database name
app_db_user: my-project # application database user
app_db_pass: p4ssvv0rD # application database user password
```
**Inventory**
[provisioning/hosts](provisioning/hosts)
```ini
[local]
localhost ansible_connection=local
[vagrant]
10.10.10.10 ansible_connection=local ansible_ssh_user=vagrant ansible_ssh_private_key_file=/vagrant/.vagrant/machines/default/virtualbox/private_key
[sandbox]
X.X.X.X ansible_ssh_user=root
[all:vars]
ansible_python_interpreter=/usr/bin/python3
```
#### Vagrant deployment with Ansible local provisioning
Vagrant configurations are stored in [Vagrantfile](Vagrantfile)
Box default config
__IP & hostname__
```ruby
config.vm.network "private_network", ip: "10.10.10.10"
config.vm.hostname = "laravel.host"
```
__Resources (default: memory - 2GB, vCPUs - 2)__
```ruby
config.vm.provider "virtualbox" do |vb|
vb.memory = 2048
vb.cpus = 2
end
```
__Set synced folder__ (local, destination)
```ruby
# config.vm.synced_folder "../data", "/vagrant_data"
```
If you want to set synced folder mapping local project to box webroot, you have to uncomment this line:
```ruby
config.vm.synced_folder "../GIT/my-project", "/var/www/my-project"
```
Run your VM using Vagrant with Ansible auto-provisioning
```bash
vagrant up
```
**Note**
Remember to run `vagrant reload` every time when Vagrantfile has been updated
Other useful vagrant commands
Check status of all machines
``vagrant global-status``
Halt vagrant box (run in box directory)
``vagrant halt``
Up vagrant box (run in box directory)
``vagrant up``
**Note**
Remember to run `vagrant reload` and `vagrant provision` every time when any provisioning configs were updated
### Xdebug
To integrate Xdebug with PhpStorm perform following steps:
1. Make sure you have ``php7.4-xdebug`` extension installed in within the vagrant box.
2. Append following configuration to the ``/etc/php/7.4/php.ini`` file:
```
[xdebug]
zend_extension=/usr/lib/php/20170718/xdebug.so
xdebug.remote_enable=1
xdebug.remote_port=9000
xdebug.profiler_enable=1
xdebug.remote_host=10.10.10.10
```
3. Execute command: ``sudo service php7.4-fpm restart``.
4. Install ``Xdebug helper`` extension for Chrome (or some kind of equivalent for your browser).
5. In PhpStorm:
* Press Ctrl+Shift+A and search ``Web Server Debug Validation``.
* Choose ``Local Web Server or Shared Folder``.
* Determine ``Path to create validation script`` like so: ``////my-project/public``
* Determine ``Url to validation script`` like so: ``http://laravel.host``.
* After clicking ``Validate`` button you should receive some information with green ticks. If not - you probably messed up with previous settings.
6. Navigate to: ``Languages & Frameworks > PHP > Servers`` and map your local and remote paths. It should be something like: ``my-project -> /var/www/my-project``.
7. Press ``Start Listening for PHP Debug Connections`` button. It should be placed on top right side with phone icon.
8. Place breakpoint somewhere in your code that will be executed in the next request e.g. ``index.php``.
9. In the browser:
* Make sure you have enabled ``Debug`` option in previously installed browser extension.
* Refresh application's page.
10. In PhpStorm ``Debug`` panel should appear. You can toggle it using Alt+5.
11. Enjoy :metal:
#### Ansible provisioning
Adjust `staging` section in inventory file [provisioning/hosts](provisioning/hosts) and set IP for remote server
```ini
[staging]
X.X.X.X ansible_ssh_user=root
```
```bash
cd provisioning
ansible-playbook -i hosts --limit staging playbook.yml
```
or using user and password
```bash
ansible-playbook -i hosts --limit staging playbook.yml -u root -k
```
`-u` , `--user`
`-k`, `--ask-pass`
ask for connection password
if you want to enable debugging just add to `ansible-playbook` command verbose option `-v` (`-vvv` for more, `-vvvv` to enable connection debugging)