Skip to content

Latest commit

 

History

History
120 lines (91 loc) · 4.89 KB

INSTALL.md

File metadata and controls

120 lines (91 loc) · 4.89 KB
Raw

Installing the eZ Platform legacy bridge

Unlike eZ Publish 5.x, eZ Platform does not include the Legacy stack by default.

Even though it is not recommended for use on new installs, eZ Publish Legacy can easily be installed on top of Platform using Composer to provide a more up-to-date platform to migrate your code to eZ Platform with.

Missing legacy extensions

Several ezpublish-legacy extensions are no longer installed by default, such as ezfind or eztags. They can still be manually added to the root composer.json.

Add the composer legacy post-*-scripts

Edit composer.json, and add those lines to both post-update-cmd and post-install-cmd blocks at the end:

"scripts": {
    "post-install-cmd": [
        ...,
        "eZ\\Bundle\\EzPublishLegacyBundle\\Composer\\ScriptHandler::installAssets",
        "eZ\\Bundle\\EzPublishLegacyBundle\\Composer\\ScriptHandler::installLegacyBundlesExtensions",
        "eZ\\Bundle\\EzPublishLegacyBundle\\Composer\\ScriptHandler::generateAutoloads"
    ],
    "post-update-cmd": [
        ...,
        "eZ\\Bundle\\EzPublishLegacyBundle\\Composer\\ScriptHandler::installAssets",
        "eZ\\Bundle\\EzPublishLegacyBundle\\Composer\\ScriptHandler::installLegacyBundlesExtensions",
        "eZ\\Bundle\\EzPublishLegacyBundle\\Composer\\ScriptHandler::generateAutoloads"
    ],
}

Enable EzPublishLegacyBundle

Edit app/AppKernel.php (or ezpublish/EzPublishKernel before ezplatform 2015.12), and add new eZ\Bundle\EzPublishLegacyBundle\EzPublishLegacyBundle( $this ) at the end of the $bundles array. Pay close attention to the $this argument. The LegacyBundle is a bit of a spoiled brat, and has high expectations from its collaborators.

Add legacy routes

Edit app/config/routing.yml, and add the LegacyBundle routes.

_ezpublishLegacyRoutes:
    resource: @EzPublishLegacyBundle/Resources/config/routing.yml

Enable legacy_mode for your backoffice siteaccess

The Legacy Backoffice requires the legacy_mode option to be enabled. This can be done in app/config/config.yml or app/config/ezplatform.yml:

ez_publish_legacy:
    system:
        site_admin:
           legacy_mode: true

Optional: add security rules for the Setup Wizard

If you intend to run the legacy setup wizard, you need to allow it in app/config/security.yml.

ezpublish_setup:
    pattern: ^/ezsetup
    security: false

Install ezsystems/legacy-bridge

ezsystems/legacy-bridge contains the libraries previous included in ezsystems/ezpublish-kernel in version 5.x.

It must be installed using Composer. Take care to use ^1.3.0 as version constraint, since previous versions lack some important fixes for newer versions of eZ Platform:

composer require --update-no-dev "ezsystems/legacy-bridge:^1.3.0"

Configure virtual host rewrite rules

To access legacy assets (eZ Publish designs and extension designs), add the following rewrite rules to your Apache virtual host:

# If using cluster, uncomment the following two lines:
#RewriteRule ^/var/([^/]+/)?storage/images(-versioned)?/.* /index.php [L]
#RewriteRule ^/var/([^/]+/)?cache/(texttoimage|public)/.* /index_cluster.php [L]

RewriteRule ^/var/([^/]+/)?storage/images(-versioned)?/.* - [L]
RewriteRule ^/var/([^/]+/)?cache/(texttoimage|public)/.* - [L]
RewriteRule ^/design/[^/]+/(stylesheets|images|javascript|fonts)/.* - [L]
RewriteRule ^/share/icons/.* - [L]
RewriteRule ^/extension/[^/]+/design/[^/]+/(stylesheets|flash|images|lib|javascripts?)/.* - [L]
RewriteRule ^/packages/styles/.+/(stylesheets|images|javascript)/[^/]+/.* - [L]
RewriteRule ^/packages/styles/.+/thumbnail/.* - [L]
RewriteRule ^/var/storage/packages/.* - [L]

Or if using nginx:

# If using cluster, uncomment the following two lines:
#rewrite "^/var/([^/]+/)?storage/images(-versioned)?/(.*)" "/index.php" break;
#rewrite "^/var/([^/]+/)?cache/(texttoimage|public)/(.*)" "/index_cluster.php" break;

rewrite "^/var/([^/]+/)?storage/images(-versioned)?/(.*)" "/var/$1storage/images$2/$3" break;
rewrite "^/var/([^/]+/)?cache/(texttoimage|public)/(.*)" "/var/$1cache/$2/$3" break;
rewrite "^/design/([^/]+)/(stylesheets|images|javascript|fonts)/(.*)" "/design/$1/$2/$3" break;
rewrite "^/share/icons/(.*)" "/share/icons/$1" break;
rewrite "^/extension/([^/]+)/design/([^/]+)/(stylesheets|flash|images|lib|javascripts?)/(.*)" "/extension/$1/design/$2/$3/$4" break;
rewrite "^/packages/styles/(.+)/(stylesheets|images|javascript)/([^/]+)/(.*)" "/packages/styles/$1/$2/$3/$4" break;
rewrite "^/packages/styles/(.+)/thumbnail/(.*)" "/packages/styles/$1/thumbnail/$2" break;
rewrite "^/var/storage/packages/(.*)" "/var/storage/packages/$1" break;

Setup Folder Permissions

Last step, if you are on *nix operation system, is to make sure to run the appropriate command for setting correct folder permissions, you can find the information you need in installation guide for eZ Publish 5.x.