Skip to content

Latest commit

 

History

History
140 lines (98 loc) · 6.99 KB

INSTALL.md

File metadata and controls

140 lines (98 loc) · 6.99 KB
Raw

Installing the eZ Platform legacy bridge

Instructions below will take you through installing legacy bridge and implicit eZ Publish legacy 2019.03.x on top of a eZ Platform 2.5LTS install.

TIP:

Before starting make sure to check-in (e.g. to Git) your eZ Platform 2.5LTS project working space so you'll be able to see & verify changes applied to your setup separate from initial clean project install.

Install netgen/ibexa-legacy-bridge and run init command

  1. Installed package using Composer:
composer require --update-with-all-dependencies "netgen/ibexa-legacy-bridge"
  1. Enable EzPublishLegacyBundle Edit app/AppKernel.php, and add new eZ\Bundle\EzPublishLegacyBundle\EzPublishLegacyBundle( $this ), at the end of the $bundles array (typically just after new AppBundle\AppBundle(),).

NOTE: Pay close attention to the $this argument, LegacyBundle needs it to interact with other eZ bundles.

  1. Run the following command to configure your install for legacy usage:
php bin/console ezpublish:legacy:init

During it's execution it will advice you on which command to run after you have moved over your legacy files (extensions, settings and optionally designs).

TIP:

If you are in need of applying these "init" steps manually, see INSTALL-MANUALLY.md.

  1. Complete setup as instructed ezpublish:legacy:init by command

The Legacy Backoffice requires the legacy_mode option to be enabled. When you ran ezpublish:legacy:init above, config to enable this for legacy_admin siteaccess was added to end of your ezplatform.yml. To enable it follow instructions given by the command (add to siteaccess list and site_group).

After this you'll need to run composer symfony-scripts once or twice to make sure assets are generated and symlinked correctly.

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

Tip:

Enabling Setup wizard is only needed if you intend to perform a new install with legacy demo data, you can also install Platform data (clean, demo) and afterwards when everything is setup use Platform UI to change Richtext FieldTypes to XmlText (using ezplatform-xmltext-fieldtype), or install Netgen RichTextDataType Bundle for legacy to make legacy allow raw editing of these. If you install eZ Platform Enterprise and it's demo data, there will also be Landing Page field type to handle in similar way (contributions to Legacy Bridge on this more than welcome ;))

Recommended: Add additional Legacy <=> eZ Platform integrations

netgen/ezplatformsearch

When using either Solr or (future) Elastic search bundle in eZ Platform, this extension makes sure eZ Platform and eZ Publish Legacy use the same search index. Technically it represents eZ Platform search engine as a eZ Publish Legacy search engine called "ezplatformsearch" which is then used for search, indexing and delayed cronjob indexing.

netgen/richtext-datatype-bundle

If you plan to migrate some or all of your content types to eZ Platform RichText format, install this bundle to make it possible to edit content with RichText field types using raw XML editing text box in eZ Publish Legacy. Good for cases where content migration, and also backend migration needs to happen gradually.

Optional: Add missing legacy extensions

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

Previusly bundled extensions, and their composer package names for installing:

  • ezsystems/ezscriptmonitor-ls
  • ezsystems/ezsi-ls
  • ezsystems/ezfind-ls
  • ezsystems/eztags-ls

To add the package(s) you want, add them with: composer require --update-with-all-dependencies <package>...

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)?/.* /app.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)?/(.*)" "/app.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 Platform.

Clearing of cache

Legacy bridge will by default also clear SPI cache (stored in redis, memcached or disk) when content-view cache is cleared in legacy. This behaviour can be disabled using the setting:

// app/config/ezplatform.yml
ez_publish_legacy:
    clear_all_spi_cache_from_legacy: false

Legacy bridge will also alter the default behaviour of Symfony's bin/console cache:clear command so that SPI cache is cleared when it is executed. This behaviour can be disabled using the setting:

// app/config/ezplatform.yml
ez_publish_legacy:
    clear_all_spi_cache_on_symfony_clear_cache: false