Skip to content

Latest commit

 

History

History
256 lines (174 loc) · 9.62 KB

Vagrantfile.README.md

File metadata and controls

256 lines (174 loc) · 9.62 KB
Raw

oro-platform-vagrant

Vagrant provision script for OroPlatform (and OroCRM, OroCommerce) quick and simple environment setup.

For example, to install OroPlatform locally, just run in terminal:

$ git clone https://github.com/NiMias/oro-platform-vagrant.git oroplatform
$ cd oroplatform
$ vagrant up

For more details, please, see Installation and Configuration section.

Contents

About

What is this project for (and not for)

This project purposes:

  • Provide "Quick-start" kit for tasting of OroPlatform-based applications
  • Provide simple development environment setup process for OroPlatform-based applications

So, the main requirement this project tries to satisfy: quick, smooth, minimum steps installation process.

That is made possible by

  • leverage the Vagrant possibilities for quick virtual environments setup
  • make reasonable assumptions about all essential installation settings

If you are not satisfied with installation settings defaults, you can change them before (or after) installation (please see Customize installation process section below for details). And, of course, you can fork this repository and change files as you want.

Warning! To set up a production environment for OroPlatform-based applications, you'd better follow official System Requirements and Installation and Configuration Guides.

What inside

The environment based on Ubuntu 16.04 (on official Vagrant base box "ubuntu/xenial64").

In the top of the base box provision script performs installation steps based on OroCRM Installation and Configuration Guide.

There is following software inside:

  • LEMP stack
    • Ubuntu 16.04 LTS
    • Nginx 1.10.*
    • MySQL 5.7.*
    • PHP 7.0.*
  • Additions
    • git 2.7.*
    • composer 1.2.*
    • nodejs 4.2.*

Installation and Configuration

Requirements

  • Windows / MacOS / Linux (or other OS supported by Virtualbox and Vagrant).
  • 3072M available RAM on your PC.

You can decrease reserved RAM to 2048M (or even 1024M) (by edit "vb.memory' param in Vagrantfile), but it may be not enough for installation process - depends on your CPU frequency, chosen version of Oro application, etc.

Installation steps

First of all, you need to

When you have Virtualbox and Vagrant installed, next steps are simple as one-two-three:

  1. Make working directory
  2. Put Vagrantfile from this repository in the working directory (git clone or just download)
  3. Run "vagrant up" command in terminal in working directory

Simplest command sequence for OroPlatform application (assumes you have Virtualbox, Vagrant and Git already installed):

$ git clone https://github.com/NiMias/oro-platform-vagrant.git oroplatform
$ cd oroplatform
$ vagrant up

After installation finished, you can access application frontend by URL http://localhost:8000/ in your browser with admin credentials:

  • login: admin
  • password: adminpass

You can change application host, admin login, and password by modifying installation settings in Vagrantfile before run vagrant up command. Please, see "Customize installation process -> Oro application settings" section below for details.

If you want to install other that OroPlatform application (OroCRM, OroCommerce or your own OroPlatform-based application) you have to modify parameter GIT_REPO (and, maybe, GIT_TAG) in "Provision configuration" section of the Vagrantfile. For more details, please see Customize installation process section below.

Caveats to installation process

The first-time installation on your PC may take some time, for

  • Downloading Ubuntu 16.04 base box
  • Installation LEMP stack on guest system
  • Installation composer dependencies for Oro application
  • Oro application installation process (with, probably, demo data loading).

The time depends on your internet connection speed, CPU frequency, etc. In average it's 15-30 mins.

During installation process might be the pauses. It's ok because not all installation steps have detailed command-line output. Please, just wait for several minutes.

At the first time visit to the site, server response may be slow because of lack of application cache. So, please, be patient. If the page doesn't respond after 5 min timeout - try to reload it.

Customize installation process

For simplicity, there are some default values of installation settings, which can be changed by you before installation process run if you need it.

These settings situated in "Provision configuration" section of Vagrantfile.

Below described some of them with their default values:

Database settings

DB_USER=dbuser
DB_PASSWORD=dbpass
DB_NAME=oro

Oro application settings

APP_HOST=localhost
APP_USER=admin
APP_PASSWORD=adminpass
APP_LOAD_DEMO_DATA=y    # y | n (whether to perform loading demo data during installation)

Warning! If you want to change local application hostname from localhost to some other hostname (for example, yourdesireddomain.local), besides modifying APP_HOST variable value you also have to add following record in your system hosts file:

192.168.33.10 yourdesireddomain.local www.yourdesireddomain.local

Then you can access your installed Oro application in a browser by URL http://yourdesireddomain.local/.

For more information about hosts file, please, read the Wikipedia article.

Git settings

GIT_REPO="https://github.com/orocrm/platform-application.git"
GIT_TAG="1.10.8"

Warning! Git settings have special meaning:

  • If variable GIT_REPO defined - installation script will attempt to download source files from given GIT_REPO URL.
  • If variable GIT_REPO NOT defined (commented or deleted from Vagrantfile) - it assumes, that you have placed application source files in working (current) folder by yourself before running "vagrant up".

For more information about installation settings, please, see source code and comments in "Provision configuration" section of the Vagrantfile.

Running multiple VM

If you want simultaneously run multiple virtual machines on your host PC you should put a unique value to param host: 8000 in config.vm.network "forwarded_port" setting in Vagrantfile (host: 8001, host: 8002, etc.) for every instance of VM.

Everyday use

Shared working folder

The working folder on your host machine will be visible as /home/ubuntu/www folder inside the virtual machine.

Hence, any changes you provide to files in working folder on your host machine would be immediately available in /home/ubuntu/www folder inside your virtual machine and vice versa.

SSH access to virtual machine

To get SSH access to the virtual machine just type vagrant ssh in the command line in your working folder on the host machine (without any additional credentials).

Inside virtual machine, you have sudo permission without password entering.

In case you need SSH access to the virtual machine from some utils (like IDE) on your host machine, you can run command vagrant ssh-config in the terminal in working folder, and you'll see the SSH credentials, configured by Vagrant during the installation process.

Access to database in virtual machine

Inside virtual machine

Inside virtual machine, you have access to MySQL with credentials provided in "Provision configuration" section of the Vagrantfile. By default are:

  • root:dbpass for root user
  • dbuser:dbpass for Oro application user

From host machine

To get access to a database on the virtual machine from your host machine you need to configure access over SSH using SSH credentials, which you can find out in a way described in the SSH access to virtual machine section above.

Useful Vagrant commands

vagrant up

Runs the virtual machine.

At the first time also runs provision script (defined in "config.vm.provision" variable of Vagrantfile).

At the second and next times just "wakes up" virtual machine instance without provision script running.

vagrant halt

Stops the virtual machine.

Save the virtual machine image (without current RAM state) in a hard drive of the host machine.

vagrant suspend

Stops the virtual machine.

Save entire current virtual machine image (with RAM state) in a hard drive of the host machine.

Others

More detailed information you can find in the official Vagrant documentation.