You can install Yii using the Composer package manager.
Standard installations of Yii result in both the framework packages and a project template being downloaded and installed. A project template is a working Yii project implementing some basic features, such as login, contact form, etc. Its code is organized in a recommended way. Therefore, it can serve as a good starting point for your projects.
If you do not already have Composer installed, you may do so by following the instructions at getcomposer.org. On Linux and Mac OS X, you'll run the following commands:
curl -sS https://getcomposer.org/installer | php
sudo mv composer.phar /usr/local/bin/composerOn Windows, you'll download and run Composer-Setup.exe.
Please refer to the Troubleshooting section of the Composer Documentation if you encounter any problems. If you are new to Composer, we also recommend reading at least the Basic usage section of the Composer documentation.
In this guide, all composer commands assume you have installed composer globally
so that it is available as the composer command. If you are using the composer.phar in the local directory instead,
you have to adjust the example commands accordingly.
If you had Composer already installed before, make sure you use an up to date version. You can update Composer
by running composer self-update.
With Composer installed, you can install Yii application template by running the following command under a Web-accessible folder:
composer create-project yiisoft/yii-demo appThis will install the latest stable version of Yii application template in a directory named app.
You can choose a different directory name if you want.
Tip: If you want to install the latest development version of Yii, you may use the following command instead, which adds a stability option:
composer create-project --stability=dev yiisoft/yii-demo appNote that the development version of Yii should not be used for production as it may break your running code.
Many Yii packages could be used separately from the framework via Composer. Framework-specific ones
are prefixed with yii-.
...
After installation is done, either configure your web server (see next section) or use the
built-in PHP web server by running the following
console command while in the project public directory:
../vendor/bin/yii serveNote: By default, the HTTP-server will listen to port 8080. However, if that port is already in use or you wish to serve multiple applications this way, you might want to specify what port to use. Just add the --port argument:
../vendor/bin/yii serve --port=8888You can use your browser to access the installed Yii application with the following URL:
http://localhost:8080/
You should see the above "Congratulations!" page in your browser.
Info: You may skip this subsection for now if you are just test-driving Yii with no intention of deploying it to a production server.
The application installed according to the above instructions should work out of the box with either an Apache HTTP server or an Nginx HTTP server, on Windows, Mac OS X, or Linux running PHP 7.2 or higher.
On a production server, you may want to configure your Web server so that the application can be accessed
via the URL http://www.example.com/index.php instead of http://www.example.com/app/public/index.php. Such configuration
requires pointing the document root of your Web server to the app/public folder. You may also
want to hide index.php from the URL, as described in the Routing and URL Creation section.
In this subsection, you'll learn how to configure your Apache or Nginx server to achieve these goals.
Info: By setting
app/publicas the document root, you also prevent end users from accessing your private application code and sensitive data files that are stored in the sibling directories ofapp/public. Denying access to those other folders is a security improvement.
Info: If your application will run in a shared hosting environment where you do not have permission to modify its Web server configuration, you may still adjust the structure of your application for better security. Please refer to the Shared Hosting Environment section for more details.
Info: If you are running your Yii application behind a reverse proxy, you might need to configure Trusted proxies and headers in the request component.
Use the following configuration in Apache's httpd.conf file or within a virtual host configuration. Note that you
should replace path/to/app/public with the actual path for app/public.
# Set document root to be "app/public"
DocumentRoot "path/to/app/public"
<Directory "path/to/app/public">
# use mod_rewrite for pretty URL support
RewriteEngine on
# if $showScriptName is false in UrlManager, do not allow accessing URLs with script name
RewriteRule ^index.php/ - [L,R=404]
# If a directory or a file exists, use the request directly
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
# Otherwise forward the request to index.php
RewriteRule . index.php
# ...other settings...
</Directory>
In case you have AllowOverride All you can add .htaccess file with the following configuration instead of
using httpd.conf:
# use mod_rewrite for pretty URL support
RewriteEngine on
# if $showScriptName is false in UrlManager, do not allow accessing URLs with script name
RewriteRule ^index.php/ - [L,R=404]
# If a directory or a file exists, use the request directly
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
# Otherwise forward the request to index.php
RewriteRule . index.php
# ...other settings...
To use Nginx, you should install PHP as an FPM SAPI.
You may use the following Nginx configuration, replacing path/to/app/public with the actual path for
app/public and mysite.test with the actual hostname to serve.
server {
charset utf-8;
client_max_body_size 128M;
listen 80; ## listen for ipv4
#listen [::]:80 default_server ipv6only=on; ## listen for ipv6
server_name mysite.test;
root /path/to/app/public;
index index.php;
access_log /path/to/basic/log/access.log;
error_log /path/to/basic/log/error.log;
location / {
# Redirect everything that isn't a real file to index.php
try_files $uri $uri/ /index.php$is_args$args;
}
# uncomment to avoid processing of calls to non-existing static files by Yii
#location ~ \.(js|css|png|jpg|gif|swf|ico|pdf|mov|fla|zip|rar)$ {
# try_files $uri =404;
#}
#error_page 404 /404.html;
# deny accessing php files for the /assets directory
location ~ ^/assets/.*\.php$ {
deny all;
}
location ~ \.php$ {
include fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
fastcgi_pass 127.0.0.1:9000;
#fastcgi_pass unix:/var/run/php5-fpm.sock;
try_files $uri =404;
}
location ~* /\. {
deny all;
}
}When using this configuration, you should also set cgi.fix_pathinfo=0 in the php.ini file
to avoid many unnecessary system stat() calls.
Also note that when running an HTTPS server, you need to add fastcgi_param HTTPS on; so that Yii
can properly detect if a connection is secure.
To use IIS, put Web.config and index.php to public accessible directory. The following
configuration goes to Web.config:
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<system.webServer>
<rewrite>
<rules>
<rule name="slim" patternSyntax="Wildcard">
<match url="*" />
<conditions>
<add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
<add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
</conditions>
<action type="Rewrite" url="index.php" />
</rule>
</rules>
</rewrite>
</system.webServer>
</configuration>To use lighttpd >= 1.4.24 put index.php to webroot and add the following to configuration:
url.rewrite-if-not-file = ("(.*)" => "/index.php/$0")