Configuring eZ Publish

Once you have created a clean eZ Publish database on the Oracle server, you need to configure eZ Publish in order to create a site that runs on the newly created database. Configuration is done manually using the command line interface of the target operating system. The following steps will work on both UNIX/Linux and Windows environments.

File permissions

Windows users can skip this part. If eZ Publish is installed on a UNIX/Linux based system, some of the file permissions need to be changed. There exists a shell script that takes care of this. This script must be run, otherwise eZ Publish will not function properly. The script needs to be run from within the eZ Publish directory:

$ cd /opt/ezpublish/3.x
$ bin/modfix.sh

Replace the "/opt/ezpublish/3.x" by the full path to the root directory of your eZ Publish installation.

The modfix script recursively alters the permission settings of the following directories inside the eZ Publish installation:

If you know the user and group of the web server, it is recommended to use a different set of permissions:

# chown -R user.usergroup var/
# chmod -R 770 var/

Change the "user.usergroup" to the user and group used by the web server (Apache).

Configuring eZ Publish

The "site.ini.append.php" configuration file located in the "settings/override" directory of your eZ Publish installation must be changed, otherwise eZ Publish will not function properly. This file is the global override for the site.ini configuration file. There are a lot of things that need to be configured (database, mail transport system, var directory, etc.). The following text shows a generic example of a configuration that can be used:

<?php /* #?ini charset="iso-8859-1"?
 
[ExtensionSettings]
ActiveExtensions[]=ezoracle
 
[DatabaseSettings]
DatabaseImplementation=ezoracle
User=scott
Password=tiger
Database=ORCL
 
[FileSettings]
VarDir=var/example
 
[Session]
SessionNameHandler=custom
 
[SiteSettings]
DefaultAccess=example
SiteList[]
SiteList[]=example
 
[SiteAccessSettings]
CheckValidity=false
AvailableSiteAccessList[]
AvailableSiteAccessList[]=example
AvailableSiteAccessList[]=example_admin
MatchOrder=host;uri
 
# Host matching
HostMatchMapItems[]=www.example.com;example
HostMatchMapItems[]=admin.example.com;example_admin
 
[InformationCollectionSettings]
EmailReceiver=webmaster@example.com
 
[MailSettings]
Transport=sendmail
AdminEmail=webmaster@example.com
EmailSender=test@example.com
 
[RegionalSettings]
Locale=eng-GB
ContentObjectLocale=eng-GB
TextTranslation=disabled
 
*/ ?>

In the example above, the "AvailableSiteAccessList[]" array located in the "[SiteAccessSettings]" section of this file defines the available siteaccesses called "example" and "example_admin". The "CheckValidity" setting located in the same section should be set to false, so that the setup wizard will not be initiated when trying to access the site. (Please note that the setup wizard does not support interaction with an Oracle database server.)

In addition, two siteaccess configurations must be created, a public siteaccess ("example") and an administration siteaccess ("example_admin"). The following subdirectories have to be created in the root of your eZ Publish installation:

Both siteaccesses must have a file called "site.ini.append.php".

The public siteaccess

The following text shows a generic solution for the "example" siteaccess:

<?php /* #?ini charset="iso-8859-1"?
 
[SiteSettings]
SiteName=Example
SiteURL=www.example.com
LoginPage=embedded
 
[SiteAccessSettings]
RequireUserLogin=false
ShowHiddenNodes=false
 
[DesignSettings]
SiteDesign=example
 
[ContentSettings]
ViewCaching=disabled
 
[TemplateSettings]
TemplateCache=disabled
TemplateCompile=disabled
#ShowXHTMLCode=enabled
#Debug=enabled
 
[DebugSettings]
DebugOutput=disabled
Debug=inline
#DebugRedirection=enabled
 
# the following settings can only be used in eZ Publish 3.8 and later versions:
[RegionalSettings]
SiteLanguageList[]
SiteLanguageList[]=eng-GB
ShowUntranslatedObjects=disabled
 
*/ ?>

The admin siteaccess

The following text shows a generic solution for the "example_admin" siteaccess:

<?php /* #?ini charset="iso-8859-1"?
 
[SiteSettings]
SiteName=Example
SiteURL=admin.example.com
LoginPage=custom
 
[SiteAccessSettings]
RequireUserLogin=true
ShowHiddenNodes=true
 
[DesignSettings]
SiteDesign=admin
 
[ContentSettings]
CachedViewPreferences[full]=admin_navigation_content=0;admin_navigation_details=0;admin_navigation_languages=0;admin_navigation_locations=
0;admin_navigation_relations=0;admin_navigation_roles=0;admin_navigation_policies=0;admin_navigation_content=0;admin_navigation_translatio
ns=0;admin_children_viewmode=list;admin_list_limit=1;admin_edit_show_locations=0;admin_url_list_limit=10;admin_url_view_limit=10;admin_sec
tion_list_limit=1;admin_orderlist_sortfield=user_name;admin_orderlist_sortorder=desc;admin_search_stats_limit=1;admin_treemenu=1;admin_boo
kmarkmenu=1;admin_left_menu_width=13
 
[DebugSettings]
DebugOutput=enabled
Debug=inline
 
# the following settings can only be used in eZ Publish 3.8 and later versions:
[RegionalSettings]
SiteLanguageList[]
SiteLanguageList[]=eng-GB
ShowUntranslatedObjects=enabled
 
*/ ?>

Please note that database settings, mail settings, regional and other settings defined in "settings/override/site.ini.append.php" will be used for each siteaccess regardless of what is specified in the siteaccess settings. In the example above, the "Database=ORCL" is specified under the "[DatabaseSettings]" section of this file so this database will be used for both "example" and "example_admin" siteaccesses. Please refer to the "Site management" and "Configuration" sections of the "Concepts and basics" chapter for more information.

Unicode support

If your Oracle database uses Unicode character set and PHP is compiled with multibyte string support, create the file called "i18n.ini.append.php" in the "settings/override/" directory of your eZ Publish installation and make sure that it contains the following lines:

<?php /* #?ini charset="iso-8859-1"?
 
[CharacterSettings]
Charset=utf-8
MBStringExtension=enabled
 
*/ ?>

Issue the following SQL query to determine the character set encoding used by your database:

SELECT value FROM nls_database_parameters WHERE parameter = 'NLS_CHARACTERSET'

 

Toolbars in the admin interface

The right section of the administration interface allows you to use the toolbar system. In order to make it work, create the file called "toolbar.ini.append.php" in the "settings/override/example_admin/" directory and make sure that it contains the following lines:

<?php /* #?ini charset="iso-8859-1"?
 
[Toolbar]
AvailableToolBarArray[]
AvailableToolBarArray[]=admin_right
AvailableToolBarArray[]=admin_developer
 
[Tool]
AvailableToolArray[]
AvailableToolArray[]=admin_current_user
AvailableToolArray[]=admin_bookmarks
AvailableToolArray[]=admin_clear_cache
AvailableToolArray[]=admin_quick_settings
 
[Toolbar_admin_right]
Tool[]
Tool[]=admin_current_user
Tool[]=admin_bookmarks
 
[Toolbar_admin_developer]
Tool[]
Tool[]=admin_clear_cache
Tool[]=admin_quick_settings
 
*/ ?>

 

Languages

A clean Oracle database created using the "db_data.dba" file contains only one language (British English, eng-GB). Please note that if you are using eZ Publish 3.7 (or earlier versions), the default primary language will be set to eng-GB as well and objects will have to be created in the primary language before they could be translated to additional languages.

All other languages should be added using "Setup - Languages" (or "Setup - Translations" in 3.7 and earlier versions) in the administration interface (http://admin.example.com in the example above).

Default username and password

The following username/password combination is specified in the "db_data.dba" file. Use it to log into the administration interface.

Once the configuration is done, you can finish the installation process by following the last step.

Powered by eZ Publish™ CMS Open Source Web Content Management. Copyright © 1999-2013 eZ Systems AS (except where otherwise noted). All rights reserved.