There are two ways you can install the Yii framework:
There are two ways you can install the Yii framework:
* Via [Composer](http://getcomposer.org/)(recommended)
* Via [Composer](http://getcomposer.org/)(recommended)
*Download an application template containing all site requirements, including the Yii framework itself
*By downloading an application template containing all of the site requirements, including the Yii framework itself
Installing via Composer
Installing via Composer
-----------------------
-----------------------
The recommended way to install Yii is to use the [Composer](http://getcomposer.org/) package manager. If you do not already
The recommended way to install Yii is to use the [Composer](http://getcomposer.org/) package manager. If you do not already
have Composer installed, you may download it from [http://getcomposer.org/](http://getcomposer.org/) or run the following command:
have Composer installed, you may download it from [http://getcomposer.org/](http://getcomposer.org/), or run the following command to download and install it:
```
```
curl -s http://getcomposer.org/installer | php
curl -s http://getcomposer.org/installer | php
```
```
We strongly recommend a global composer installation.
(It is strongly recommended to perform a [global Composer installation](https://getcomposer.org/doc/00-intro.md#globally)).
For problems or more information, see the official Composer guide:
For problems with, or more information on, installing Composer, see the official Composer guide:
With Composer installed, you can create a new Yii site using one of Yii's ready-to-use application templates.
With Composer installed, you can create a new Yii site using one of Yii's ready-to-use application templates. Based on your needs, choosing the right template can help bootstrap your project.
Based on your needs, choosing the right template can help bootstrap your project.
Currently, there are two application templates available:
Currently, there are two Yii application templates available:
- The [Basic Application Template](https://github.com/yiisoft/yii2-app-basic) - just a basic frontend application template.
-[Basic Application Template](https://github.com/yiisoft/yii2-app-basic), a basic frontend application template
- The [Advanced Application Template](https://github.com/yiisoft/yii2-app-advanced) - consisting of a frontend, a backend,
-[Advanced Application Template](https://github.com/yiisoft/yii2-app-advanced), consisting of a frontend, a backend, console resources, common (shared code), and support for environments
console resources, common (shared code), and support for environments.
For installation instructions for these templates, see the above linked pages.
For template installation instructions, see the above linked pages.
To read more about the ideas behind these application templates and proposed usage,
To read more about the ideas behind these application templates and the proposed usage,
refer to the [basic application template](apps-basic.md) and [advanced application template](apps-advanced.md) documents.
refer to the [basic application template](apps-basic.md) and [advanced application template](apps-advanced.md) documents.
If you do not want to use a template and want to start from scratch you'll find information in the document about
If you do not want to use a template, rather starting from scratch, you'll find information in the [creating your own application structure](apps-own.md) document. This approach is only recommended for advanced users.
[creating your own application structure](apps-own.md). This is only recommended for advanced users.
Installing from zip
Installing from zip
...
@@ -49,14 +46,14 @@ Installation from a zip file involves two steps:
...
@@ -49,14 +46,14 @@ Installation from a zip file involves two steps:
1. Downloading an application template from [yiiframework.com](http://www.yiiframework.com/download/).
1. Downloading an application template from [yiiframework.com](http://www.yiiframework.com/download/).
2. Unpacking the downloaded file.
2. Unpacking the downloaded file.
If you only want the Yii Framework files you can download a ZIP file directly from [github](https://github.com/yiisoft/yii2-framework/releases).
If you only want the Yii Framework files you can download a zip file directly from [github](https://github.com/yiisoft/yii2-framework/releases).
To create your application you might want to follow the steps described in [creating your own application structure](apps-own.md).
To create your application you might want to follow the steps described in [creating your own application structure](apps-own.md).
This is only recommended for advanced users.
This is only recommended for advanced users.
> Tip: The Yii framework itself does not need to be installed under a web-accessible directory.
> Tip: The Yii framework itself does not need to be installed under a web-accessible directory (in fact, it should not be).
A Yii application has one entry script which is usually the only file that absolutely must be
A Yii application has one entry script, which is usually the only file that absolutely must be
exposed to web users (i.e., placed within the web directory). Other PHP scripts, including those
exposed to web users (i.e., placed within the web directory). Other PHP scripts, including those
part of the Yii Framework, should be protected from web access to prevent possible exploitation by hackers.
in the Yii Framework, should be protected from web access to prevent possible exploitation by hackers.
Requirements
Requirements
...
@@ -66,18 +63,18 @@ After installing Yii, you may want to verify that your server satisfies
...
@@ -66,18 +63,18 @@ After installing Yii, you may want to verify that your server satisfies
Yii's requirements. You can do so by running the requirement checker
Yii's requirements. You can do so by running the requirement checker
script in a web browser or from the command line.
script in a web browser or from the command line.
If you have installed a Yii application template via zip or composer you'll find a `requirements.php` file in the
If you have installed a Yii application template via the downloaded zip file or Composer, you'll find a `requirements.php` file in the
base directory of your application.
base directory of your application.
In order to run this script on the command line use the following command:
In order to run this script on the command line use the following command (after navigating to the directory where `requirements.php` can be found):
```
```
php requirements.php
php requirements.php
```
```
In order to run this script in your browser, you should ensure it is accessable by the webserver and
In order to run this script in your browser, you must make sure it's within a web directory, and then
access `http://hostname/path/to/yii-app/requirements.php` in your browser.
access `http://hostname/path/to/yii-app/requirements.php` in your browser.
If you are using Linux you can create a soft link to make it accessable, using the following command:
If you are using Linux, you can create a soft link to make it accessable, using the following command:
