Caution: This documentation is for eZ Publish legacy, from version 3.x to 5.x.
For 5.x documentation covering Platform see eZ Documentation Center, for difference between legacy and Platform see 5.x Architecture overview.

site.ini

[ContentSettings]

SettingSummary
CacheDir Sets the directory where eZ Publish stores view cache files.
CachedViewModes Sets which of the content view modes that use view cache.
CachedViewPreferences Sets the user preferences each view mode depends on.
CacheThreshold Sets the treshold for content cache cleanup
ComplexDisplayViewModes Sets content views that have their content cache expired whenever an object is published.
EditDirtyObjectAction Sets what eZ Publish should do if the user tries to edit a page that has a draft that is newer than the published version.
PreCacheSiteaccessArray Sets the siteaccesses that will have view-cache created when an object is published.
PreViewCache Sets if eZ publish should generate the view cache when an object is published.
PreviewCacheUsers Sets the users that should have view cache generated when an object is published.
StaticCache Sets if static caching should be enabled or not.
ViewCaching Sets if view caching should be enabled or not.

[DatabaseSettings]

SettingSummary
Charset Sets the character set that eZ Publish uses when communicating with the database.
ConnectRetries Sets the number of database connection retries.
Database Sets the database to use when connecting to the database server.
DatabaseImplementation Sets the type of database you are using.
DatabasePluginPath Sets the path to an external database driver.
Host Sets the host that contains the database eZ Publish should use.
Password Sets the password that eZ Publish uses when logging in to the database.
SlaverServerDatabase The databases to use when logging in to the slaveservers.
SlaverServerPassword The passwords to use when logging in to the slaveservers.
SlaverServerUser The usernames to use when logging in to the slaveservers.
SlaveServerArray The hostnames of the slaveservers to use for read queries.
SlowQueriesOutput Show queries that where slower than a set amount of time.
Socket Sets the socket eZ Publish should use when connecting to the database.
SQLOutput Enables the output of SQL queries in the debug output.
Transactions Enables to make eZ Publish use transactions to ensure database integrity.
UseBuiltInEncoding Use the built in character conversion in the database if available.
UsePersistentConnection Controls if database connections should be kept open between eZ Publish runs.
User Sets the username that eZ Publish uses when logging in to the database.
UseSlaveServer Enables the usage of slave database servers for read queries. (MySQL only)

[DebugSettings]

SettingSummary
Debug Sets if you want to display debug information in the rendered page or in a separate popup.
DebugByIP Enables debug output for some IP addresses only. Useful when debugging live sites.
DebugIPList Sets the hosts that receive debug output.
DebugLogOnly Choose if you want debug strings in the debugoutput or in the log only.
DebugOutput Main switch for debug output
DebugRedirection Enables debugging of internal and external module redirections.
DisplayDebugWarnings Choose if debug warnings should be displayed explicitely on the top of the page or in the debug log only.
ScriptDebugOutput Enables debug output for PHP scripts run from the command line.

[DesignSettings]

SettingSummary
AdditionalSiteDesignList Sets the additional site designs.
SiteDesign Sets the most significant design resource.
StandardDesign Sets the least significant (fallback) design resource.

[ExtensionSettings]

SettingSummary
ActiveAccessExtensions Sets the extensions that are available to eZ Publish per siteaccess.
ActiveExtensions Sets the extensions that are available to eZ Publish.
ExtensionDirectory Sets the directory where extensions are located.

[FileSettings]

SettingSummary
CacheDir Sets the directory where eZ Publish stores cache files.
DirDepth Sets the number of extra directories that will be made when storing a file.
LogDir Sets the directory where eZ Publish will store its logfiles.
StorageDir Sets the directory eZ Publish uses to store files.
StorageDirPermissions Sets the permissions set on directories created in the storage directory.
StorageFilePermission Sets the permissions set on files created in the storage directory.
TemporaryDir Sets the directory eZ Publish uses to store temporary files.
TemporaryPermissions Sets the permissions on temporary files created by eZ Publish
VarDir Sets the main directory for file storage in eZ Publish.

[FormProcessSettings]

SettingSummary
Module Sets if the form module should be enabled or not.

[InformationCollectionSettings]

SettingSummary
EmailReceiver Sets the receiver of e-mail generated by the information collection system.

[MailSettings]

SettingSummary
AdminEmail Sets the mail address of the site administrator.
AllowedCharsets Sets the character sets that eZ publish sends directly in mail.
ContentType Sets the content type for email sent from eZ publish.
EmailSender Sets the default sender address for mail sent from eZ publish.
HeaderLineEnding Sets the line ending character used in emails sent from eZ publish.
OutputCharset Sets the character set to convert mail into if they are formatted with the wrong character set.
Transport Sets the mail transport system for mail sent from eZ publish.
TransportPassword Sets the password to use for authentication with the SMTP server.
TransportPort Sets the port that should be used when connecting to the SMTP server.
TransportServer Sets the hostname of the SMTP server.
TransportUser Sets the user to use for authentication with the SMTP server.

[OverrideSettings]

SettingSummary
Cache Sets if the template override cache should be enabled.

[PortAccessSettings]

SettingSummary
Portnumber to siteaccess mapping Creates a mapping between a portnumber and a siteaccess.

[RegionalSettings]

SettingSummary
ContentObjectLocale Sets the default language for content objects.
ContentXMLCharset Sets the characterset used when storing XML in content objects.
Debug Sets if debug mode should be enabled or disabled.
DevelopmentMode Sets if development mode should be on or off.
HTTPLocale Sets the locale transmitted to the web clients.
Locale Sets the locale (currency, date and time settings etc.)
SystemLocale Tells PHP to be run in a specific locale.
TextTranslation Sets if text translation is enabled for template translation.
TranslationCache Sets if the translation cache should be anabled or disabled.
TranslationExtensions Sets the extensions that hold translations
TranslationRepository Sets the default translation repository for eZ publish.

[RoleSettings]

SettingSummary
EnableCaching Controls whether role caching should be enabled or disabled.
PolicyOmitList Excludes modules and views from the permission checking.
ShowAccessDeniedReason Sets if eZ Publish elaborates on the reason for getting access denied when viewing a page.
UserPolicyCache Sets which users' policies to cache.

[RSSSettings]

SettingSummary
AvailableVersionList Sets the available RSS versions
CacheTime Sets the cachetime for RSS feeds in seconds.
DefaultVersion Sets the default RSS version to use.
NumberOfObjectsDefault Sets the default value for the number of items in an RSS export.
NumberOfObjectsList Sets the number of items in an RSS export that the user can choose between in the administration interface.

[SearchSettings]

SettingSummary
AllowEmptySearch Sets if users can search for nothing
DelayedIndexing Sets if new content objects are indexed in the search engine upon publishing or if indexing is done by the cronjob
EnableWildcard Sets if wildcard searching is allowed or not
LogSearchStats Sets if search statistics should be saved or not.
MaximumSearchLimit Sets the maximum number of returned hits.
MinCharacterWildcard The minimum number of characters a wildcard can represent
SearchEngine Sets which search engine to use
SearchViewHandling Sets if searches are handled by the search view or in the template.
StopWordThresholdPercent Sets the percentage of hits that a word should be present in before ignoring the word completely
StopWordThresholdValue Sets the minimum number of objects in the database before the stopword functionality is used.

[Session]

SettingSummary
ActivityTimeout Sets the number of second before a user is considered inactive.
CookieTimeout Sets the number of seconds that the session cookie lasts.
SessionNameHandler Sets how session names should be generated
SessionNamePerSiteAccess Prepends session names with the current siteaccess.
SessionNamePrefix Sets the prefix eZ publish should use when creating session names.
SessionTimeOut Sets the number of seconds a session lasts.

[SetupSettings]

SettingSummary
CriticalTests Sets the tests that must be passed in order to complete the setup procedure.
OptionalTests Sets the tests optional tests run during the setup procedure.
OverrideSiteDesign Sets the sitedesign that should be used by the setup wizard.
PageLayout Sets which pagelayout template to use for the setup wizzard.

[ShopSettings]

SettingSummary
ClearBasketOnCheckout Sets when the basket is cleared.
RedirectAfterAddToBasket Controls where the user is redirected after adding an item to the basket.

[SiteAccessRules]

SettingSummary
Rules Sets which modules and views to enable or disable.

[SiteAccessSettings]

SettingSummary
AnonymousAccessList Specifies a lists of modules and views that are accessible regardless of the RequireUserLogin setting.
AvailableSiteAccessList Sets the siteaccesses that your eZ publish installation provides.
CheckValidity Sets if the setup wizard should be activated or not.
DebugAccess Turns on debug output for access matching.
DebugExtraAccess Enables verbose access matching debug information.
ForceVirtualHost Sets if eZ publish should force virtual host mode.
HostMatchElement Sets which element (separated by a dot) to use when using element host matching.
HostMatchMapItems Sets the mapping between hostname and siteaccess when using map host-matching.
HostMatchRegexp Sets the regular expression that is used to fetch the siteaccess from the hostname with regexp hostmatching.
HostMatchRegexpItem Sets which submatch to use to determine the siteaccess name with regexp hostmatching.
HostMatchSubtextPost Sets the postfix that occurs in the hostname behind the siteaccess when using text host matching.
HostMatchSubtextPre Sets the prefix that occurs in the hostname in front of the siteaccess when using text host matching.
HostMatchType Sets which type of host matching to use to select the siteaccess.
MatchOrder Sets the matching algorithms that will be tried to determine which siteaccess to use.
PathPrefix Not documented yet.
RequireUserLogin Sets if you allow anonymous access to your site.
ServerVariableName Not documented yet.
ShowHiddenNodes Sets if hidden nodes should be shown by default or not.
URIMatchElement Specifies which element (separated by "/") of the URI that contains the siteaccess.
URIMatchRegexp Sets the regular expression that is used to extract the siteaccess from the URI.
URIMatchRegexpItem Sets the submatch that is used for siteaccess matching when using regexp URIMatching.
URIMatchType Configures the URI match access method

[SiteSettings]

SettingSummary
DefaultAccess Sets the default site access when the URI access method is used.
IndexPage Sets the page to display when the root "/" of your site is accessed.
LoginPage Sets if eZ Publish should use a custom pagelayout for the log in page.
MetaDataArray Sets the site metadata that is used on several places on your site.
SiteList Sets the siteaccesses available to outside sources (currently used for webdav only)
SiteName The name of your site.
SiteURL Sets the URL of your site. Used e.g when generating links for notifactions and emails.
SSLPort The port that that should be used for SSL requests.

[TemplateSettings]

SettingSummary
AutoloadPathList Sets the directories inside eZ Publish itself where eZ Publish will look for operator and function definitions.
Debug Turns on/off template debug output.
ExtensionAutoloadPath Sets the extensions that contain template function or operator definitions.
NodeTreeCaching Sets if the template interprator should cache parsed template files.
ShowMethodDebug Sets if debug information about called functions and operators should be displayed.
ShowUsedTemplates Enables a table in the debug displaying all the templates used to render the current page.
ShowXHTMLCode Sets if eZ Publish should display template load debug inline or not.
TemplateCache Main switch for all the template related caches.
TemplateCompile Sets if the template compiler should be used or not.
TemplateCompression Sets if compiled templates should be compressed or not.
TemplateOptimization Sets if the template compiler should try to optimize the produced PHP code.
UseFormatting Sets if the template compiler should keep whitespace in the compiled template.

[TipAFriend]

SettingSummary
FromEmail Sets the from address used when sending tip a friend e-mail.
MaxRequestsPerTimeframe Set the maximum number of tip a friend mail the system will send to one email address.
TimeFrame Sets the time frame for the tip a friend functionality.

[UnitSettings]

SettingSummary
BinaryUnits Sets which units eZ publish considers binary units.
UseSIUnits Sets if eZ Publish should use OSI or SI prefixes for binary numbers

[URLTranslator]

SettingSummary
MaximumWildcardIterations Sets how many times the wildcard matches can iterate
Translation Enables/disables the URL translation functionality
WildcardTranslation Enables subtree URL translation

[UserSettings]

SettingSummary
AnonymousUserID Sets the eZ Publish user that should be used for anonymous page requests.
AuthenticateMatch Sets the fields that are accepted for login authentication.
DefaultSectionID Sets the section ID of self registered users.
DefaultUserPlacement Sets the parent object of all users who register themselves
ExtensionDirectory Sets the extensions that contain login handlers
GeneratePasswordIfEmpty Sets if eZ Publish should generate passwords if the password field is empty.
GeneratePasswordLength Sets the length of passwords generated by eZ Publish.
HashType Sets the algorithm used to encrypt the user passwords stored in the database.
LoginHandler Sets the various methods eZ publish will try to authenticate user logins.
LogoutRedirect Sets which page to redirect to when a user has logged out.
RegistrationEmail Sets the receiver of notification emails about new users.
RegistrationFeedback Sets the kind of feedback that is sent to users that have registered.
RequireUniqueEmail Sets if all users must have unique email addresses when registering.
UpdateHash Sets if eZ publish should update hashes if you have changed the HashType setting
UserClassGroupID Sets which classes you can create in the user section in the administration interface.
UserClassID Sets the class to use for user registration
UserCreatorID Sets the user that will bet set as the creator of self registering users.
UserGroupClassID Sets the class ID of the class that represents user groups.
UseSpecialCharacters Sets if special characters are allowed in passwords.
VerifyUserEmail Sets if new users have to verify their account by email.

Balazs Halasy (23/02/2005 10:51 am)

Svitlana Shatokhina (19/01/2007 12:39 pm)

Balazs Halasy, Svitlana Shatokhina


Comments

  • Missing [ContentSettings] TranslationList

    The configuration setting [ContentSettings] TranslationList is currently undocumented.
    • Re: Missing ...

      Missing [SiteSettings][Dir]
    • [ContentSettings] TranslationList is deprecated

      The "TranslationList" setting is deprecated and should not be used.
  • TranslationList deprecated...

    Is deprecated but currently used in the default site.ini auto-generated by eZp 3.10 (and 3.9 of course)...