Skip to content

Commit

Permalink
Fixed grammar typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Mykolay Miasnikov committed Nov 3, 2016
1 parent 8024bef commit bac9c63
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 70 deletions.
70 changes: 35 additions & 35 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ $ cd oroplatform
$ vagrant up
```

For more details, please, see [Installation and configuration](#installation-and-configuration)
For more details, please, see [Installation and Configuration](#installation-and-configuration)
section.

#### Contents ####

* [About](#about)
* [What is this project for (and not for)](#what-is-this-project-for-and-not-for)
* [What inside](#what-inside)
* [Installation and configuration](#installation-and-configuration)
* [Installation and Configuration](#installation-and-configuration)
* [Requirements](#requirements)
* [Installation steps](#installation-steps)
* [Caveats to installation process](#caveats-to-installation-process)
Expand All @@ -38,26 +38,26 @@ This project purposes:
* Provide "Quick-start" kit for tasting of OroPlatform-based applications
* Provide simple development environment setup process for OroPlatform-based applications

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

This is made possible by
That is made possible by

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

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

**Warning!** To setup **production** environment for OroPlatform-based applications you'd better follow
official [System requirements][1] and [Installation and Configuration][2] guides.
**Warning!** To set up a **production** environment for OroPlatform-based applications, you'd better follow
official [System Requirements][1] and [Installation and Configuration][2] Guides.

### What inside ###

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

In top of the basebox provision script performs installation steps based on OroCRM
[Installation and Configuratoin][2] guide.
In the top of the base box provision script performs installation steps based on OroCRM
[Installation and Configuration][2] Guide.

There is following software inside:

Expand All @@ -71,7 +71,7 @@ There is following software inside:
* composer 1.2.*
* nodejs 4.2.*

## Installation and configuration ##
## Installation and Configuration ##

### Requirements ###

Expand Down Expand Up @@ -109,39 +109,39 @@ the [Vagrantfile][5]. For more details, please see

### Caveats to installation process ###

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

* Downloading Ununtu 16.04 base box
* 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
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.

After installation finished, you can access application frontend by url http://localhost:8000/ in your browser
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
_You can change application host, admin login, and password by modifying installation settings in
[Vagrantfile][5] before run `vagrant up` command. Please, see "Customize installation process ->
[Oro application settings](#oro-application-settings)" section below for details._

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

#### Running multiple VM ####
If you want simultaneously run multiple virtual machines on your host PC you should put unique value
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][5]
(`host: 8001`, `host: 8002`, etc.) for every instance of VM.

### Customize installation process ###

For simplicity there are some default values of installation settings, that can be changed by you before installation
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][5].
Expand All @@ -167,7 +167,7 @@ Below described some of them with their default values:
```shell
192.168.33.10 yourdesireddomain.local www.yourdesireddomain.local
```
Than you can access your installed Oro application in browser by url http://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][6]._

Expand All @@ -179,7 +179,7 @@ _For more information about `hosts` file, please, read the [Wikipedia article][6
**Warning!** Git settings have special meaning:

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

Expand All @@ -190,36 +190,36 @@ of the [Vagrantfile][5]._

### Shared working folder ###

The working folder on your host machine will be visible as `/home/ubuntu/www` folder inside virtual machine.
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 virtual machine just type `vagrant ssh` in command line in your working folder on host
machine (without any additional credentials).
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.
Inside virtual machine, you have `sudo` permission without password entering.

In case you need SSH access to virtual machine from some utils (like IDE) on your host machine, you can run
command `vagrant ssh-config` in terminal in working folder and you'll see the SSH credentials, configured by
Vagrant during installation process.
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
Inside virtual machine, you have access to MySQL with credentials provided in "Provision configuration" section
of the [Vagrantfile][5]. By default are:

* `root:dbpass` for root user
* `dbuser:dbpass` for Oro application user

#### From host machine ####

To get access to database on virtual machine from your host machine you need to configure access over SSH
using SSH credentials, that you can find out in a way described in the
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](#ssh-access-to-virtual-machine) section above.

### Useful Vagrant commands ###
Expand All @@ -237,16 +237,16 @@ At the second and next times just "wakes up" virtual machine instance without pr

Stops the virtual machine.

Save the virtual machine image (without current RAM state) in hard drive of the host 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) ih hard drive of the host 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 official [Vagrant documentation][7].
More detailed information you can find in the official [Vagrant documentation][7].

[1]: https://www.orocrm.com/documentation/index/current/system-requirements
[2]: https://www.orocrm.com/documentation/index/current/book/installation
Expand Down
70 changes: 35 additions & 35 deletions Vagrantfile.README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ $ cd oroplatform
$ vagrant up
```

For more details, please, see [Installation and configuration](#installation-and-configuration)
For more details, please, see [Installation and Configuration](#installation-and-configuration)
section.

#### Contents ####

* [About](#about)
* [What is this project for (and not for)](#what-is-this-project-for-and-not-for)
* [What inside](#what-inside)
* [Installation and configuration](#installation-and-configuration)
* [Installation and Configuration](#installation-and-configuration)
* [Requirements](#requirements)
* [Installation steps](#installation-steps)
* [Caveats to installation process](#caveats-to-installation-process)
Expand All @@ -38,26 +38,26 @@ This project purposes:
* Provide "Quick-start" kit for tasting of OroPlatform-based applications
* Provide simple development environment setup process for OroPlatform-based applications

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

This is made possible by
That is made possible by

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

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

**Warning!** To setup **production** environment for OroPlatform-based applications you'd better follow
official [System requirements][1] and [Installation and Configuration][2] guides.
**Warning!** To set up a **production** environment for OroPlatform-based applications, you'd better follow
official [System Requirements][1] and [Installation and Configuration][2] Guides.

### What inside ###

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

In top of the basebox provision script performs installation steps based on OroCRM
[Installation and Configuratoin][2] guide.
In the top of the base box provision script performs installation steps based on OroCRM
[Installation and Configuration][2] Guide.

There is following software inside:

Expand All @@ -71,7 +71,7 @@ There is following software inside:
* composer 1.2.*
* nodejs 4.2.*

## Installation and configuration ##
## Installation and Configuration ##

### Requirements ###

Expand Down Expand Up @@ -109,39 +109,39 @@ the [Vagrantfile][5]. For more details, please see

### Caveats to installation process ###

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

* Downloading Ununtu 16.04 base box
* 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
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.

After installation finished, you can access application frontend by url http://localhost:8000/ in your browser
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
_You can change application host, admin login, and password by modifying installation settings in
[Vagrantfile][5] before run `vagrant up` command. Please, see "Customize installation process ->
[Oro application settings](#oro-application-settings)" section below for details._

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

#### Running multiple VM ####
If you want simultaneously run multiple virtual machines on your host PC you should put unique value
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][5]
(`host: 8001`, `host: 8002`, etc.) for every instance of VM.

### Customize installation process ###

For simplicity there are some default values of installation settings, that can be changed by you before installation
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][5].
Expand All @@ -167,7 +167,7 @@ Below described some of them with their default values:
```shell
192.168.33.10 yourdesireddomain.local www.yourdesireddomain.local
```
Than you can access your installed Oro application in browser by url http://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][6]._

Expand All @@ -179,7 +179,7 @@ _For more information about `hosts` file, please, read the [Wikipedia article][6
**Warning!** Git settings have special meaning:

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

Expand All @@ -190,36 +190,36 @@ of the [Vagrantfile][5]._

### Shared working folder ###

The working folder on your host machine will be visible as `/home/ubuntu/www` folder inside virtual machine.
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 virtual machine just type `vagrant ssh` in command line in your working folder on host
machine (without any additional credentials).
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.
Inside virtual machine, you have `sudo` permission without password entering.

In case you need SSH access to virtual machine from some utils (like IDE) on your host machine, you can run
command `vagrant ssh-config` in terminal in working folder and you'll see the SSH credentials, configured by
Vagrant during installation process.
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
Inside virtual machine, you have access to MySQL with credentials provided in "Provision configuration" section
of the [Vagrantfile][5]. By default are:

* `root:dbpass` for root user
* `dbuser:dbpass` for Oro application user

#### From host machine ####

To get access to database on virtual machine from your host machine you need to configure access over SSH
using SSH credentials, that you can find out in a way described in the
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](#ssh-access-to-virtual-machine) section above.

### Useful Vagrant commands ###
Expand All @@ -237,16 +237,16 @@ At the second and next times just "wakes up" virtual machine instance without pr

Stops the virtual machine.

Save the virtual machine image (without current RAM state) in hard drive of the host 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) ih hard drive of the host 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 official [Vagrant documentation][7].
More detailed information you can find in the official [Vagrant documentation][7].

[1]: https://www.orocrm.com/documentation/index/current/system-requirements
[2]: https://www.orocrm.com/documentation/index/current/book/installation
Expand Down

0 comments on commit bac9c63

Please sign in to comment.