Enterprise Server 10 full installation – Home

This article describes the installation of Enterprise Server 10 on a system on which it is not yet installed.

Before you start

Before starting the installation, make a plan of what is needed: which features of Enterprise Server and its clients do you want to make use of and which additional (third-party) software does this require?

Examples:

Control user authorizations externally by integrating LDAP.
For print workflows it is highly recommended to integrate Adobe InDesign Server. This makes it possible to hand off tasks to InDesign Server (such as the generation of layout previews, thumbnails or PDFs), crop images in Content Station, and more.
Enable messaging so that changes that a user makes — such as changing the properties of a file — are immediately visible to other users.
Integrate Elvis DAM.

As a starting point, use the Compatibility Matrix to verify which software versions you need and if any upgrades are required.

Important: Use of MAMP/WAMP/LAMP not supported
MAMP, WAMP or LAMP are single-distribution packages for Mac OS, Windows or Linux that combine the installation of Apache, PHP, and MySQL. These make them potentially ideal for quickly setting up a new Enterprise Server environment. However, such packages are meant for development purposes and are not to be used in live production environments.
The use of MAMP, WAMP or LAMP for installing an Enterprise Server environment is therefore not supported.

Upgrading InDesign and InCopy

When you are upgrading to a new version of Adobe InDesign or InCopy, keep the following in mind:

All InDesign and InCopy users should use the same Adobe version (Adobe CC 2018, Adobe CC 2019, Adobe 2020, and so on). This is because documents created in a newer version cannot be opened in a previous version.
Convert any InDesign and InCopy templates to the new version of InDesign and InCopy. Do this by opening the file and re-saving it.

Step 1. Setting up the database

Install and set up the database for storing all Enterprise Server related data.

Steps for Oracle

Important: Oracle is not supported for Enterprise Server versions 10.2 or higher.

Step 1. Perform the installation by following the instructions by Oracle.

Notes:

Oracle 12c introduced a 'Non-Container Database' and a 'Container Database'. Both can be used for Enterprise.

In the Oracle Enterprise Manager, access the Character Sets tab and select the following:
When installing Enterprise Server 10.0.5 or higher:
Unicode AL32UTF8 or UTF8. (AL32UTF8 is recommended, for Chinese, Japanese or Korean AL32UTF8 is required)
UTF8 - ... as the National Character Set
When installing Enterprise Server 10.0.0 to 10.0.4:
Unicode (AL32UTF8)
UTF8 - ... as the National Character Set

Step 3. Create the database users, either as a combined user or as separate users.

Step 2. Installing and configuring PHP

Step 1. Install PHP.

Step 2. Configure PHP by editing the php.ini file as described below.

Step 2a. Ensure that variables_order is set to EGPCS:

variables_order = "EGPCS".

Step 2b. Change the following settings to at least the shown values:

upload_max_filesize = 250M

post_max_size = 250M

memory_limit = 750M

Step 2c. Ensure that request_order includes "C", for example:

request_order = "GPC"

Step 2d. Add the correct time zone, for example:

date.timezone = Europe/Amsterdam

Note: For a full list of time zones, see http://nl3.php.net/manual/en/timezones.php.

Step 2e. Add the following entries and set the path according to your setup:

session.save_path =
upload_tmp_dir =

Example:

session.save_path = C:\PHP\sessiondata

upload_tmp_dir = C:\PHP\uploadtemp

Note: Ensure that both folders have full Read and Write access enabled for the Web Server user, for example the Internet Guest User.

Step 3. Enable the following PHP modules:

Note about installing the JSON module: Although the PHP manual states that 'The JSON extension is bundled and compiled into PHP by default', it seems that this is not always the case for all CentOS/RHEL distributions. As a result, the Health Check for Enterprise Server may fail unexpectedly during the execution of its test items later in the installation process. To check if the extension is loaded, open the Health Check page once the server is fully installed and then open the PHP Info page. Search for 'json support' for which the value 'enabled' should be set. If that is not the case, install the JSON extension for PHP with for example the yum install php-json command as mentioned in the PHP documentation and restart the web server. Then open the PHP Info page once more to validate whether the JSON extension is loaded by PHP.

Step 4. Enable the DB module for PHP:

For MySQL: Follow the PHP manual for installing the MySQLi driver.
For MSSQL: Follow the instructions in the Microsoft documentation: Microsoft PHP Driver for SQL Server.
For Oracle: Follow the PHP manual for installing the OCI driver.

Step 5. Save the file.

Step 6. Restart the Web service.

Step 3. Configuring the Web Server

Please take note of the following information, depending on the Web Server used.

Apache

To manually configure the Apache configuration files for PHP, edit conf/httpd.conf to enable PHP support in both the Load Module list and Add Module list.

Some Apache installations overrule the character set of HTML pages. As a result, accented characters are not displayed correctly by the Enterprise Maintenance applications. This can be fixed by changing or adding AddDefaultCharSet in the Apache configuration file conf/httpd.conf to:

AddDefaultCharSet UTF-8

–or–

AddDefaultCharSet off

Also set the DefaultType to:

DefaultType text/html

Note: The default Web page for Enterprise should be index.htm. However, for Apache it can be index.php as well in which case the Enterprise logon page remains empty. To avoid this problem, make sure the index.htm file is listed above the index.php file in the httpd configuration file.

Microsoft IIS

It is recommended to increase the maximum size that IIS allows for uploads. This is done by changing the 'Maximum allowed content length' setting.

Note: Reaching the limit can result in errors such as 'HTTP error 413' when for example a user tries to save a file to the database.

For information about changing this setting, see the following links:

web-site-scripts.com: Increasing maximum allowed size for uploads on IIS7
docs.microsoft.com: Request Limits <requestLimits>

Step 4. (Optional) Configuring the ExifTool

Note: The ExifTool requires Enterprise Server 10.1 or higher.

When images are uploaded, Enterprise Server extracts metadata. This metadata is used for populating basic metadata fields (such as author, credit, format, and so on), as well as specific fields such as width and orientation (used for cropping images).

The ExifTool is part of the Enterprise Server installation and can optionally be configured.

(Optional) Configuration

Info: This feature requires the following versions of Enterprise Server:

Enterprise Server 10.5.4 or any higher version of Enterprise Server 10.5
Enterprise Server 10.7.1 or any higher version of Enterprise Server 10.7

The order in which image properties are resolved can be based on the metadata containers (such as 'Exif', 'XMP', an 'IPTC') that are extracted by the ExifTool application.

Different metadata containers can contain different values for the same image attribute.

Example: 'Credit' => [ 'IPTC', 'XMP' ] means that first the 'IPTC' metadata container is used to resolve the 'Credit' attribute. If this gives a result, the 'XMP' container is ignored. Only in case of no result is the 'XMP' container used.

To do this, configure the following option:

File: config_overrule.php file
Name of option: EXIFTOOL_METADATA_ORDER
Possible values: See below.
Example:

if( !defined( 'EXIFTOOL_METADATA_ORDER' ) ) {
	define( 'EXIFTOOL_METADATA_ORDER', serialize(
			[
				'Author' => [ 'EXIF', 'IPTC', 'XMP' ],
				'Credit' => [ 'IPTC', 'XMP' ],
				'ColorSpace' => [ 'EXIF', 'XMP' ],
				'Comment' => [ 'XMP', 'IPTC' ],
				'DocumentID' => [ 'IPTC', 'XMP' ],
				'Description' => [ 'EXIF', 'IPTC', 'XMP' ],
				'DescriptionAuthor' => [ 'IPTC', 'XMP' ],
				'Copyright' => [ 'EXIF', 'IPTC', 'XMP' ],
				'Keywords' => [ 'IPTC', 'XMP' ],
				'Slugline' => [ 'IPTC', 'XMP' ],
				'Source' => [ 'IPTC', 'XMP' ],
				'Format' => [ 'File', 'XMP' ],
			]
		)
	);
}

Uncomment the attribute and change the order of the containers as needed.

Notes:

Not all containers are applicable for every attribute.
The ordering is only supported for the attributes that are listed.

Step 5. Installing Enterprise Server

Step 1. Download the Enterprise Server application from the software release page.

Note: The name of the file is EnterpriseServer_10.x.x_Buildyy.zip, where "x" stands for the Server version number and "y" for the build number. For example: EnterpriseServer_10.0.0_Build100.

Step 2. Unzip the file.

A folder named 'Enterprise' is created containing files such as index.php, index.html, index.htm.

Step 3. Copy the complete Enterprise folder to the server machine’s Web root folder (such as webroot).

Step 4. Create a folder named FileStore and apply access rights.

Note: The default location for the FileStore folder is as follows:

Mac OS: /FileStore

Windows: c:\FileStore

This is not a location we advise to use for production systems; it has just been chosen to make an easy initial installation possible. The location can always be changed at a later stage (but note that the whole directory also has to be copied to the new location).

Make sure that read and write access is set for the following users:

Mac OS: “www”

Windows: “IUSR_<servername>”

Linux: “nobody”

Tip: A typical setup would be to create a root FileStore and create the other directories in it.

Step 5. Verify the following options in the configserver.php file or the config.php file:

Tip: (For Enterprise Server 10.1 or higher only) Easily manage and configure settings of all configuration files by adding them to a single configuration file.

Configure database access using the following options:

Option	File
DBTYPE	configserver.php
DBSERVER	configserver.php
MSSQL_EXTRA_CONNECTION_OPTIONS¹	configserver.php
DBSELECT	config.php
DBUSER²	config.php
DBPASS	config.php

¹ Only for Enterprise Server 10.5.2 – 10.5.x, Enterprise Server 10.6.1 – 10.6.x, or any higher version of Enterprise Server. Makes it possible to set extra connection attributes for connecting to a MSSQL database, for example for setting the Failover_Partner or MultiSubnetFailover. For a list of the supported options see the Microsoft documentation.

² The DBUSER is the single database user that is used by the application server to access the database. This database user account needs SELECT, INSERT, UPDATE, and DELETE privileges, plus ALTER TABLE privileges for the creation and deletion of custom properties. The application server itself authorizes all requests for the user logged on via the Enterprise user tables which are completely separate from the database users. Default is ‘root’. For MSSQL Server you could use ‘sa’ as default.

Configure the web access using the following options:

Option	File
BASEDIR	config.php
INETROOT	config.php

Configure file access using the following options:

Option	File
ATTACHMENTDIRECTORY	config.php
WOODWINGSYSTEMDIRECTORY	config.php
TEMPDIRECTORY	config.php
EXPORTDIRECTORY	config.php

(Optional. This step is only required when configuring Enterprise Server 10.1 or higher; this option is not used in Enterprise Server 10.0.) Configure the path to the ExifTool using the following option:

Option	File
EXIFTOOL_APP_PATH	configserver.php

Step 6. Installing ionCube loaders

For security reasons, Enterprise Server uses ionCube to encrypt some of its PHP modules.

The process of checking the currently installed version of ionCube and guiding you through any upgrade steps is built in to Enterprise Server.

Step 1. Try accessing the Enterprise Server Health Check page by entering the following URL in a Web browser:

http://<your server URL>/Enterprise/server/wwtest

Example: http://localhost/Enterprise/server/wwtest

The installation of ionCube is automatically tested. During this process, you might see various progress bars appear. Depending on the result of the test, the following will happen:

The Health Check page appears. This means that ionCube Loader is correctly installed. No further action is required.

The ionCube Loader Wizard for Enterprise Server appears. This means that the ionCube Loader is not correctly installed or that an incorrect version is installed. The information provided on the page will give you an indication of the exact problem and how to resolve it.

Step 2. Repeat step 1 until the Health Check page appears. This is an indication that ionCube is correctly installed.

Step 7. (Optional) Determining the location of the File Transfer Server

The File Transfer Server is a feature of Enterprise Server which separates files from operational data during an upload or download process, resulting in a higher performance and lower memory footprint.

You can optionally move the File Transfer Server or the File Transfer Folder to another system to:

Offload file traffic over HTTP to a dedicated server farm or network
Let file traffic run over a dedicated URL, other than client-server service communication
Offload the file traffic to the File Store to another physical file location

To do so, follow the steps as described in Installing the File Transfer Server on another system optionally followed by following the steps in Securing the File Transfer Server through HTTPS.

Step 8. Creating Enterprise database tables

Create tables in your installed database for storing data relating to using Enterprise.

Creating the database tables is an automated process that is triggered by running the Database Connection test on the Health Check page in Enterprise Server.

Step 1. In Enterprise Server, access the Health Check page.

Step 2. At the bottom of the page, click Clear All.

Step 3. Only select the Database Connection test.

Step 4. Click Test.

The test is executed and the result is displayed next to the test. It should display “OK”.

Note: If the test fails, an error is displayed together with instructions for solving it. Follow the instructions and then run the test once more.

Step 9. Activating licenses

To complete the setup process of Enterprise Server, its license needs to be activated first. This allows you to access the Maintenance pages of Enterprise Server and allows users of client applications to log in to the Server. At this time, you might also want to activate all client applications.

For information about activating licenses for Enterprise Server and its client applications, see Managing licenses in Enterprise Server 10.

Step 10. Initializing Enterprise Server plug-ins

Many of the Enterprise Server functionality is provided through plug-ins. These plug-ins need to be initialized first.

Step 1. In Enterprise Server, click Server Plug-ins in the Maintenance menu or on the Home page.

The Server Plug-ins page appears and any installed plug-ins will be automatically registered.

Note: Because the plug-ins are registered while the page is opened, the process of opening the page can take a few moments.

Step 2. Make sure that the required plug-ins are enabled. If needed, resolve any conflicts.

Note: Normally, no conflicts should arise and no further action will be required after accessing the page.

Step 11. Testing the Enterprise Server installation

The setup is now ready to be tested.

Step 1. Open a Web browser and enter the URL for the installed Server.

Example: http://localhost/Enterprise/

The log in screen appears.

Step 2. Log in using the following credentials:

User Name: woodwing
Password: ww

The main screen appears.

Step 1. Access the Health Check page.

Step 2. (Optional) In case not all licenses are activated yet, clear the check box for Licenses.

Step 3. (Optional) For those systems or features which are not installed yet (such as LDAP, Drupal, and so on), clear their check boxes.

Step 4. Click Test.

The test(s) are executed and the results are displayed next to each test. They should all display “OK”.

Note: If a test fails, an error is displayed together with instructions for solving it. Follow the instructions and then run the test once more.

Step 12. Integrating Apache Solr

Solr is an open source enterprise search server based on the Lucene Java search library and is integrated by Enterprise to speed up the searching process and to implement the faceted search feature.

Solr runs in a Java servlet container such as Tomcat or Jetty (included in the Solr distribution download).

Install and configure Solr as described in the following articles, depending on the supported version for your version of Enterprise Server:

Step 13. (Optional) Preview generation for additional file formats

Without installing additional components, Enterprise Server is capable of generating previews for images in JPG, PNG, or GIF format.

Support for additional image formats — such as PDF, TIFF and PSD — can be added by installing ImageMagick and/or Ghostscript.

For details, see Image preview generation in Enterprise Server 10.

Step 14. Configuring Enterprise Server

During the installation of Enterprise Server, the system was set up using default settings for use in a generic production environment. However, many more powerful features can be unlocked, mainly by making further changes to the configuration files, but also by making use of other technologies and third-party applications.

For an overview of the options that can be configured, use the following sources:

The list in the Configuration section of the Enterprise Server contents page.
The comments in the configserver.php file. It lists many options, most of which can be easily implemented by simply un-commenting them.

Tip: (For Enterprise Server 10.1 or higher only) Easily manage and configure settings of all configuration files by adding them to a single configuration file.

Step 15. Setting File Storage settings

By modifying the file storage settings you control the way the data is stored, including the following aspects:

File name conventions
Performance
Files stored externally or locally

Follow the steps as described in About file storage in Enterprise Server 10.

Step 16. Reviewing security settings

By reviewing the security settings you verify and optionally control the way the stored data is secured (internally and externally), including the following aspects:

Passwords
User privileges
SSL

For more information, see Security considerations for Enterprise Server 10.

Step 17. Customizing the interface

Specific aspects of the Server and client applications can be customized to match the look and feel of your company environment, including localization, terminologies used, colors, and icons.

Please refer to the articles listed on the contents page for Enterprise Server, Content Station 9, and Smart Connection.

Step 18. Setting up a Brand

Now that Enterprise Server itself is fully up and running, it is time to define your publications, set up Publication Channels, user accounts, access rights and more.

See Setting up a Brand in Enterprise Server 10.

Step 19. Connecting to Enterprise Cloud Services

Note: This step is optional but mandatory when Enterprise Server 10.8 or higher is used in combination with Content Station 11.52 or higher for working with Digital articles.

The Digital articles that are created in Content Station Aurora make use of various resources such as Component Sets, styles, custom swatches, and so on. These resources are stored in a central location in the cloud in a system named Enterprise Cloud Services.

Content Station needs access to these resources so that users can do the following:

Use the Digital editor
Create a Digital article
Create Component sets
Map components
Save swatches

Providing access is done by connecting Enterprise Server to Enterprise Cloud Services, as explained in Connecting Enterprise Servers and Elvis Server to Enterprise Cloud Services.

Document history

20 January 2022: Updated step 2 'Installing and configuring PHP' by adding a note about the JSON module.
21 December 2020: Added step 13 '(Optional) Preview generation for additional file formats'.