Vagrant - korobi/Web GitHub Wiki
Web with Vagrant
WARNING - Provisioning Korobi uses a relatively moderate amount of internet data (~100-500MB of download from updates, 1 GB for downloading the Operating System). If you are on a capped connection, you may wish to wait with provisioning.
Korobi's Web interface is relatively taxing to set up, so the Korobi team offers a prepared Vagrant set up to let this work be done for you.
Vagrant will ensure you work on the same software as the production and test servers do, and come will all sorts of nifty tools.
Requirements
- You need to have Vagrant version 1.5.0 or higher installed.
- You'll want ansible installed.
sudo pip install ansible
should work. - A stable and fast internet connection is a plus.
- It *is* virtualization, decent hardware is recommended. You need about 5GB free space.
- Hosts file pointing
korobi.dev
at10.0.5.6
is required for nginx. It hard-redirects to https://korobi.dev/. Otherwise also really recommended.
Installation
- Clone the Korobi Web dir
- Copy
Vagrantfile.example
toVagrantfile
, and edit it if you want
- If port 443 is unoccupied, it's a good idea to set
config.vm.network
's forwarding to 443 rather than 4443.
- Run the initial
vagrant up
- This process normally takes about 5 to 20 minutes.
- You're set! That was easy!
What do I need to know?
First of all, get familiar with the forwarded ports in your Vagrantfile. The HTTP and HTTPS ports are used for your browser, mongodb is forwarded but not necessary, ssh is usually located on port 2222.
Generally, SSH and HTTPS is all you need to work with Korobi.
Is it required?
No. But it is convenient, works on all platforms, works exactly like korobi.io does, and takes less time to set up than to do it yourself. Although if you'd like to install Korobi yourself without Vagrant, the .vagrant_bootstrap.sh
file is excellent to look at to get started.