Документация

Собрание всего, что поспособствует изучению OctoberCMS

Installation

There are two ways you can install October, either using the Wizard or Command-line installation process. Before you proceed, you should check that your server meets the minimum system requirements.

Minimum System Requirements

October CMS has a few system requirements:

  • PHP 5.4 or higher with safe_mode restrictions disabled
  • PDO PHP Extension
  • cURL PHP Extension
  • MCrypt PHP Extension
  • ZipArchive PHP Library
  • GD PHP Library

As of PHP 5.5, some OS distributions may require you to manually install the PHP JSON extension. When using Ubuntu, this can be done via apt-get install php5-json.

Wizard installation

The wizard installation is a recommended way to install October. It is simpler than the command-line installation and doesn't require any special skills.

  1. Prepare a directory on your server that is empty. It can be a sub-directory, domain root or a sub-domain.
  2. Download the installer archive file.
  3. Unpack the installer archive to the prepared directory.
  4. Grant writing permissions on the installation directory and all its subdirectories and files.
  5. Navigate to the install.php script in your web browser.
  6. Follow the installation instructions.

Troubleshooting installation

  • The page appears empty when opening the installer: This might be caused by using older versions of PHP, check that you are running PHP version 5.4 or higher.

  • An error 500 is displayed when downloading the application files: You may need to increase or disable the timeout limit on your webserver. For example, Apache's FastCGI sometimes has the -idle-timeout option set to 30 seconds.

Apache configuration

If your webserver is running Apache there are some extra system requirements:

  • mod_rewrite installed and AllowOverride turned on

Nginx configuration

There are small changes required to configure your site in Nginx.

nano /etc/nginx/sites-available/default

Use the following code in server section.

if (!-e $request_filename)
{
    rewrite ^/(.*)$ /index.php?/$1 break;
    break;
}
rewrite themes/.*/(layouts|pages|partials)/.*.htm /index.php break;
rewrite uploads/protected/.* /index.php break;

Lighttpd configuration

If your webserver is running Lighttpd you can use the following configuration to run OctoberCMS.

Open your site configuration file with your favorite editor.

nano /etc/lighttpd/conf-enabled/sites.conf

Paste the following code in the editor and change the host address and server.document-root to match your project.

$HTTP["host"] =~ "example.domain.com" {
    server.document-root = "/var/www/example/"

    url.rewrite-once = (
        "^/modules/(system|backend|cms)/([a-zA-Z0-9]+/[a-zA-Z0-9]+/|/|)assets/(vendor/.*|css|js|javascript|less|images|font(s|)).*\.(jpg|jpeg|gif|png|svg|swf|avi|mpg|mpeg|mp3|flv|ico|css|js|woff.*|ttf)$" => "$0",
        "^/(system|themes/[a-zA-Z0-9]+)/assets/(vendor/.*|css|js|javascript|less|images|fonts).*\.(jpg|jpeg|gif|png|svg|swf|avi|mpg|mpeg|mp3|flv|ico|css|js|woff|ttf)$" => "$0",
        "^/(favicon\.ico|robots\.txt|sitemap\.xml)$" => "$0",
        "^/[^\?]*(\?.*)?$" => "index.php/$1",
    )
}

Command-line installation

If you feel more comfortable with a command-line, there is a CLI install process on the Console interface page.