Vagrant/Kirby StarterKit

You heard about Kirby CMS and want to use it on your next project? You want to harness the power of Vagrant? Then THIS is for you!

Here's my personal (thus opinionated) Vagrant+Kirby boilerplate, starring:

• Kirby CMS v3 - a file‑based CMS that's 'easy to setup, easy to use & flexible as hell'
• Vagrant - a tool for building and maintaining portable virtual software development environments

Table of Contents

• 1. Requirements
• 2. Getting started
• 3. Configuration
• 4. Credits

Requirements

• Installing Vagrant
• Working VirtualBox setup (also works with other providers)
• Composer

Getting started

Download or clone this repository, then install the Gulp/Kirby StarterKit (or any other Kirby project):

# Composer
composer create-project s1syphos/gulp-kirby-starter-kit htdocs --no-dev --prefer-dist

# Git
git clone https://github.com/S1SYPHOS/Gulp-Kirby-Starter-Kit.git htdocs

Now just type vagrant up and code away!

Configuration

This boilerplate assumes that index.php is stored inside htdocs:

htdocs/
├── assets
├── content
├── kirby
├── site
└── index.php

However, for a more secure setup (and some extra straightforwardness), the following structure is recommended:

htdocs/
├── content
├── kirby
├── public
│   ├── assets
│   ├── .htaccess
│   └── index.php
├── site
└── storage
    ├── accounts
    ├── cache
    └── sessions

The webserver only exposes the public directory, which contains assets, index.php and .htaccess. For this to work, simply move some files around, update your index.php (Gulp/Kirby StarterKit got your back) and lib/config/vars.yml (just comment/uncomment some lines).

Credits

@dirkaholic's vagrant-php-dev-box inspired this boilerplate - he deserves all the credit.

Special Thanks

I'd like to thank everybody that's making great software - you people are awesome. Also I'm always thankful for feedback and bug reports :)