Alfresco Community Edition 3.

2
Installing and Configuring Alfresco Community Edition 3.2

Installing and Configuring Alfresco Community Edition 3.2

Contents
Preface.................................................................................................................. 2 Audience......................................................................................................2 Conventions................................................................................................ 2 Typographic conventions........................................................................ 2 Command conventions........................................................................... 2 System paths.......................................................................................... 3 Frequently occurring tasks....................................................................... 4 Opening a command prompt.................................................................. 4 Running batch files................................................................................. 4 Adding folder paths to the Windows path variable................................. 5 Changing the default shell...................................................................... 5 Resources....................................................................................................5 Before installing...................................................................................................7 Installation files.......................................................................................... 7 Alfresco....................................................................................................7 SharePoint Protocol Support.................................................................. 8 Alfresco WCM......................................................................................... 8 Alfresco Web Service client.................................................................... 8 Alfresco SDK AND APIs......................................................................... 8 Extensions............................................................................................... 9 Microsoft Office Add-ins..........................................................................9 Software requirements...............................................................................9 Installing a JDK.......................................................................................... 9 Verifying the JAVA_HOME environment variable location....................10 Installing MySQL...................................................................................... 10 Installing MySQL................................................................................... 10 Configuring MySQL............................................................................... 10 Verifying the MySQL installation........................................................... 11 Installing Alfresco..............................................................................................12 Installing Alfresco on Windows.............................................................. 12 Installing Alfresco on Windows (full installation)................................... 12 Installing Alfresco on Windows (excluding JDK)...................................13 Installing Alfresco Tomcat bundle on Windows.................................... 15 Installing Alfresco on Redhat Linux.......................................................15 Installing Alfresco on Red Hat Linux.....................................................15 Installing the Alfresco Tomcat bundle on Linux.................................... 16 Installing Alfresco on Mac.......................................................................17 Installing the Alfresco WAR on any platform........................................ 18 Modifying the directory paths for Tomcat 6.x........................................18 Download the extension samples......................................................... 19 Deploying Share into a separate Tomcat instance............................... 19 Installing Alfresco components.............................................................. 20
Installing and Configuring Alfresco Community Edition 3.2 - i

...........................................................24 Installing SWF Tools.............................................................. 33 Modifying global properties.......................... 27 Running Alfresco............................................................................................. 64 Configuring core services......................................... 70 ii .. 41 Share themes................................................................................................... 36 Modifying system configuration files.............. 65 Tuning the JVM...26 Installing an Alfresco Module Package........................................................ 68 Configuring the repository cache................................2........................................................................................ 60 Alfresco Explorer configuration settings...........26 Installing Microsoft Office SharePoint Protocol Support............2 ...................................................................................................................................................................61 Configuring databases........................Installing and Configuring Alfresco Community Edition 3.................................................................35 Modifying Spring bean definition files..... 35 Upgrading configurations to Enterprise Edition 3.............. 34 Setting composite properties in the global properties file......................................................................................................................................... 34 Java command line............65 Command line configuration..root.............. 33 Configuration overview........................................................................ 69 Configuring extended services...................... 37 Customizing individual configuration items...................... 44 Customizing Alfresco Explorer.........................................20 Installing OpenOffice.............................. 31 Stopping the deployment engine.................................................................................................................................. 31 Stopping the Alfresco virtualization server. 70 Configuring metadata extraction..................................33 Global properties...................................................................................31 Starting the Alfresco virtualization server.................... 37 Repository system configuration files..............................................................................................................................................................................................................................................................................................................................................................................................................Installing and Configuring Alfresco Community Edition 3.....................31 Starting the deployment engine......................................... 30 Starting Alfresco Share..................................................................................................................................................................................................................................62 Configuring a PostgreSQL database.........2 Installing Alfresco WCM.......................................................62 Overriding database connection properties............................................ 30 Starting Alfresco Explorer.....22 Installing Microsoft Office Add-ins................ 22 Installing ImageMagick. 68 Customizing dir................................................... 70 Adding a MIME type......................................................................................................................... 38 Customizing Alfresco Share.........................23 Installing Flash Player.41 Forms................................................ 24 Installing TinyMCE language packs..........30 Starting the Alfresco server....................................................................................................................................................... 30 Stopping the Alfresco server.............................................................................................................. 62 Configuring a MySQL database..................................... 32 Configuring Alfresco....................................................................

...........................................................80 Configuring the authentication chain......................71 Setting up replication.............................................................................................................. 99 Configuring the email server...................... 73 Customizing content transformations................................................................................................................................................................................................................ 75 Mounting a subsystem with composite properties.......99 Configuring the RMI email service.....Installing and Configuring Alfresco Community Edition 3....................... 74 Subsystem properties............. 101 IMAP Protocol support.................................................................................................................................. 77 Configuring authentication.............................................................................................................................................................................................................................................................................................2 ........................................................................... 92 Synchronization configuration properties......................................................................................................... 76 Extension classpath........................ 75 Mounting a subsystem........................................... 71 Configuring the connection pool......... 81 Configuring LDAP........ 86 Configuring Kerberos............102 Marking Sites as IMAP favorite.............................................................................................................................................................................. 79 Authentication chain functions........................ 108 Debugging an Alfresco installation...........73 Alfresco subsystems................. 103 Configuring the virtualization server.........................................................98 Configuring the email server and email service............................... 100 Handling messages by target node type...............103 WCM deployment.....................101 Virtual view email format..............................................................................................................................................................................................................................105 Troubleshooting.........................93 Configuring the FTP file server.......................................................100 Configuring the email service....92 Synchronization deletion............................78 Authentication chain................................................... 101 IMAP mount points....................................... 108 Configuring the JVM................................................................. 92 Collision resolution..............................................................................................................................................................................................................................................................................................................................................................................2 Versioning..................................................................... 93 Configuring SMB/CIFS server...................................................................77 Authentication subsystem types...................iii .......................................... 108 Installing and Configuring Alfresco Community Edition 3..................80 Configuring alfrescoNtlm........................................ 88 Configuring synchronization...................78 Authentication subsystem components..................................................................................... 83 Configuring pass-through...............97 Configuring NFS file servers................................................................................................... 92 Configuring file servers................... 103 Configuring Web Content Management.....................................................101 Enabling the IMAP Protocol........................ 74 Subsystem configuration............................................... 73 Subsystem categories....................................................... 79 Default authentication chain..

............................................................2 .......................................................................................................................... 110 Troubleshooting CIFS.................... 111 Active Directory tips..2 Configuring Eclipse..................................................................................................................................................................................... 111 OpenLDAP tips..............Installing and Configuring Alfresco Community Edition 3..................109 Testing and debugging links.............................................................Installing and Configuring Alfresco Community Edition 3........................................ 108 Setting log levels.. 109 Error messages............................................. 114 iv ........... 109 Troubleshooting NFS.........................................................

2 .2 Copyright Copyright 2009 by Alfresco and others.com. including the Export Administration Regulations of the U. trademarks. and restrictions of the United States and any foreign agency or authority and assume sole responsibility for any such unauthorized exportation. Installing and Configuring Alfresco Community Edition 3. You may not use this documentation if you are a competitor of Alfresco. for any purpose. contact us at documentation@alfresco. No part of this document may be reproduced or transmitted in any form or by any means. electronic or mechanical. This copyright applies to the current version of the licensed program. or other intellectual property except as expressly provided in any written agreement from Alfresco. The United States export control laws and regulations. Department of Commerce. copyrights. products. you may not use the documentation for purposes of evaluating its functionality or for any other competitive purposes. contact Customer Support by email at support@alfresco. service marks. You agree to comply with all export laws. except with Alfresco's prior written consent. The trademarks.1 . In addition. or other intellectual property rights of Alfresco and others used in this documentation ("Trademarks") are the property of Alfresco and their respective owners.com. Information in this document is subject to change without notice. The furnishing of this document does not give you license to these patents. and other applicable laws and regulations apply to this documentation which prohibit the export or re-export of content. regulations.S. without the express written permission of Alfresco. services. logos. If you need technical support for this product.Installing and Configuring Alfresco Community Edition 3. If you have comments or suggestions about this documentation. and technology to certain countries and persons.

For example. Some configuration tasks also require knowledge of your environment and configuration processes. Used to indicate anything that is not covered by Bold. Used to emphasize importance and for variable expressions.Installing and Configuring Alfresco Community Edition 3.Installing Alfresco describes how to install Alfresco and components • Chapter 2 . code. and then press another key. This includes items that users select. however.Troubleshooting describes how to analyze and troubleshoot various scenarios Audience This guide provides information to assist in the installation and configuration of Alfresco. Formatting convention bold Type of information Used when referring to any item in the User Interface (UI).Configuring Alfresco describes how to configure Alfresco core and extended services • Chapter 3 . No specialist knowledge is assumed to install and configure Alfresco. the information provided in this guide assumes that you are familiar with the environment on which you are installing. and items in a list. This includes file and path names. such as menu options. and prerequisites • Chapter 2 . a standard convention to open a new document is: 2 . command buttons. For example: CTRL+P or ALT+F4 monospace italics Command conventions This guide uses a standard convention to indicate a series of commands in succession.Installing and Configuring Alfresco Community Edition 3. For example: kill -9 <process_id> CAPITALS Used to refer to specific keys on the keyboard. or ALT KEY+KEY Used to refer to key combinations when a user must press and hold down the first key. software requirements. CTRL. standard output.Before installing describes the installation files. This guide contains the following chapters: • Chapter 1 . and so on. text the user types. such as parameters. For example: SHIFT. Conventions This guide uses the following terms and conventions.2 . Typographic conventions The following typographic conventions identify certain types of information.2 Preface The purpose of this guide is to provide information on installing and configuring Alfresco Community Edition.

3 . On the menu bar. The location of this directory varies depending on your application server. For example. click Document. for Tomcat. click New. so backslashes must be escaped.2 .properties> file This is where you store all the configuration settings for your environment. <configRootShare> The <configRootShare> directory is where the default configuration files for Share are stored. <configRootShare> is <TOMCAT_HOME>\webapps\share\WEB-INF. For example: • (Tomcat) tomcat/shared/classes/ <alfresco-global. click File.2 File > New > Document This means: 1. This directory can be found in <classPathRoot>\alfresco\extension. System paths The following standard conventions describe common system paths: • Explicit Windows paths use back slashes C:\Adirectory • Explicit Linux paths use forward slashes /srv/adirectory • Back slashes also indicate the same path can apply in both Windows or Linux environments \adirectory\ <classPathRoot> directory (Windows) The <classPathRoot> denotes a directory whose contents are automatically added to the start of your application server’s classpath. The file should be placed in <classPathRoot>. <configRoot> is <TOMCAT_HOME>\webapps\alfresco\WEB-INF. The location of this directory varies depending on your application server. 3. for Tomcat. <extension> directory The <extension> directory is where you store Spring configuration that extends and overrides the system configuration. The file is in Java properties format. In the menu. 2. For example. In the sub-menu. This directory can be found in <classPathRoot>\alfresco\extension. <web-extension> The <web-extension> directory is where you store Spring configurations that extend and override the system Share configuration. Installing and Configuring Alfresco Community Edition 3. <configRoot> The <configRoot> directory is where the default configuration files are stored.Installing and Configuring Alfresco Community Edition 3. For example: • (Tomcat) C:\Alfresco\tomcat\shared\classes <classPathRoot> directory (Linux) The <classPathRoot> denotes a directory whose contents are automatically added to the start of your application server’s classpath.

in a command prompt. to start Alfresco. 3. Type alf_start. you may prefer to run Alfresco from a batch file.2 Frequently occurring tasks This section describes tasks that are frequently used or referred to in this guide. 2. double-click the file name alf_start. A batch file is a Windows file with a . type dir alf_*. and press ENTER. 4. To check that you are in the correct directory. type cd c:\alfresco. 5. 1. In Windows Explorer.Installing and Configuring Alfresco Community Edition 3.bat. Opening a command prompt You may need to run and edit scripts in a command prompt when installing on a Windows-based system. In the Run dialog box. click Start > Run. type cmd. 1. Click OK. Double-click a file name with a extension.bat extension.bat. The Run dialog box closes and a command prompt opens. 2.2 . and look for alf_start. Running batch files When you have installed Alfresco on a Windows-based system. Alternatively. On the Windows task bar. For example. 4 .Installing and Configuring Alfresco Community Edition 3. 3. browse to C:\Alfresco.

On the Windows desktop. add one. Adding folder paths to the Windows path variable You may need to add folder paths to the Windows Path variable when installing on a Windows-based system. 7. For example. The new path will be used the next time a command prompt is opened.sh file to change to your preferred shell. type the full path to the file you want to find.sh file. In the Edit System Variables window. Installing and Configuring Alfresco Community Edition 3. In the System Properties window. 1. 6. 3. 1. In the pop-up menu. right-click My Computer. If the command prompt closes before you have time to see the error that caused the program to terminate.). or if the program is terminated by a command error. highlight Path. If the last character is not a semi-colon (. Changing the default shell When you run Alfresco on the Unix. For example: path C:\jdk 8. 5. or Solaris operating systems. Linux. 3. 2. Open the alfresco. Click OK in each open window. You can edit the alfresco. Edit the shell command to specify your preferred shell. 2.sh file. and then click Environment Variables. click the Advanced tab.5 .Installing and Configuring Alfresco Community Edition 3. 4. the default shell is sh. Save the alfresco. and click Edit. you can run the batch program by opening a command prompt yourself. click Properties. After the final semi-colon. insert the cursor at the end of the Variable value field.2 . Resources The resources in the following table provide additional information related to using Alfresco.2 The command prompt is closed on normal completion. or a service is started. In the System Variables window. change the #!/bin/sh line to #!/bin/bash.

and articles.com http://www.Installing and Configuring Alfresco Community Edition 3.2 .2 Knowledge Base Description How to use the MS Office Add-in. including links to various resources. Alfresco web site for all information about Alfresco. Lists the most requested information from support and how to contact Alfresco Support. Alfresco Community Edition wiki. Frequently Asked Questions (FAQ). such as webinars and forums. http://wiki. Additional information on specific Community Edition features and applications in white papers.2 Resource MS Office Add-in End User Help Using Content Management from within Microsoft Office tutorial Installing and Configuring Alfresco ECM for Community Edition 3. How to use the Alfresco Explorer user interface.com http://www.com/services/support/faq 6 .Installing and Configuring Alfresco Community Edition 3. Installing Alfresco and related components. community-contributed information on all aspects of the Alfresco Community Edition environment. and configuring core and extended services.alfresco.alfresco.alfresco.

Web Studio.gz Linux.2and Explorer web clients.2-OOo-Setup. MacOSXInstall.7 .2.alfresco. File name Alfresco-Community-3.tar. DM and WCM.2 Before installing This chapter describes how to prepare your system for installing Alfresco.Installing and Configuring Alfresco Community Edition 3. DM and WCM. Use this file if no Alfresco component is installed on your system.gz alfresco-community-war-3. By choosing an installation file that contains only the necessary components. Alfresco Description Full Alfresco installation wizard for Windows including Share and Explorer web clients. Web Studio.gz Records Management.com. Web Studio. and SharePoint functionality. Preconfigured Tomcat bundle for any platform including alfresco-community-tomcat-3.tar. Alfresco WAR files for deployment in existing application servers (.tar. Records Management. you can download an installation file that does not contain JDK. Use this file if you already have JDK installed but need to install Full Alfresco installation wizard for Linux including Share and Explorer web clients. Installation files There are a number of different installation files available to you. and SharePoint functionality.2 .zip). Full Alfresco installation wizard for Windows excluding JDK.zip alfresco-community-war-3. Use this file if no Alfresco component is installed on your system.2-Linux-x86Install Full Alfresco installation wizard for Mac including Share Alfresco-Community-3. Preconfigured Tomcat bundle for Windows (. Alfresco runs within an instance of the Tomcat application server. if you already have a JDK installed. The installers and the Tomcat bundles are preconfigured with Tomcat.tar. DM and WCM.exe Alfresco-Community-3. The following tables help you to determine what files to download and install.2. Use this file if no Alfresco component is installed on your system.2-Full-Setup. use the Alfresco WAR file. this lets you reduce your download time. For example. Records Management.exe Alfresco-Community-3. Use this bundle if you already have the required software installed.2. If you wish to install Alfresco within another application server.zip Installing and Configuring Alfresco Community Edition 3. This installer ensures that you have all the recommended software installed and ensures that configurations are set. Apple Mac OS (. The installation files are available to download from Alfresco at http://wiki.gz).tar.gz) Alfresco WAR files for deployment in existing application servers (zipped) alfresco-community-tomcat-3. and SharePoint functionality. each of which you can choose depending on what is already installed on your system. Solaris.2. Use this bundle if you already have the required software installed.

including alfresco-community-sdk-3.2.2.2.properties.gz alfresco-web-service-client-3.tar.gz the source files Alfresco Software Development Kit.amp Alfresco WCM Description File name WCM install for adding WCM functionality to alfresco-community-wcm-3.2-Linux-x86Install alfresco-truncateMalformedXml.tar.2 .gz Sample extensions files such as alfresco.zip Alfresco-DeploymentCommunity-3.gz) WCM install for adding WCM functionality to an AlfrescoCommunity Edition install (zipped) Windows installer for Deployment/FSR Linux installer for Deployment/FSR XML utility alfresco-community-wcm-3.2. zipped Add-in for PHP integration phpIntegration. including alfresco-community-sdk-3.zip global.tar.alfresco-community-sample-extensions-3.tar.2-Setup.2.2 SharePoint Protocol Support Description Microsoft SharePoint Protocol support connector functionality File name vti-module.properties alfresco-community-sampleextensions-3.tar.exe Alfresco-DeploymentCommunity-3.amp Alfresco Web Service client Description WSDL-based API providing standard remote access to the Alfresco repository (.Installing and Configuring Alfresco Community Edition 3.amp 8 .2.gz) WSDL-based API providing standard remote access to the Alfresco repository (zipped) File name alfresco-web-service-client-3.zip Alfresco SDK AND APIs Description File name Alfresco Software Development Kit.Installing and Configuring Alfresco Community Edition 3.2.tar.zip the source files.2. zipped Sample extension file such as alfrescoglobal.gz an AlfrescoCommunity Edition install (.

amp org.org Flash Player Version 10. install and configure the database before you install Alfresco. If you do not install OpenOffice.2.2. If you do not install SWF Tools.zip alfresco-community-office2003-addins-3. a text file to a PDF file. you will not see PDF previews. if not.alfresco.2.2. Recommendation OpenOffice.amp alfresco-bm-3. If you intend to use a different database.9 . deprecate JCR Benchmarking toolkit FaceBook integration Records Management sample functionality MediaWiki integration File name alfresco-mmt-3. you will not have access to the transformation functionality.zip alfresco-community-word2003-addin-3.2 . already included in main server bundles iGoogle gadgets Blog publishing. Alfresco Share requires Flash Player Version 10.zip alfresco-community-powerpoint2003addin-3.jar alfresco-fb-doclib. install a version for you. Alfresco comes preconfigured with the MySQL database. Alfresco Share uses the pdf2swf utility for previewing PDF files.2 Extensions Description Module Management Tool. Alfresco uses OpenOffice for transforming documents from one format to another.2. for example.x to upload multiple files and view Flash previews.2.mediawikiintegration.x SWF Tools Installing a JDK A Java SE Development Kit (JDK) must be installed on your system before you install Alfresco. This task explains how to install JDK manually.Installing and Configuring Alfresco Community Edition 3.jar aggadget.amp alfresco-recordsmanagement. but image previews will still be available. Component Java SE Development Kit (JDK) Database JDK 6 is required. you see the upload screen for single files.zip Software requirements The following table lists the required software that must be on your system before you install Alfresco.zip alfresco-blog-integration.module. If you do not install Flash.amp Microsoft Office Add-ins Description Add-in for Microsoft Excel 2003 Add-in for Microsoft Office 2003 Add-in for Microsoft PowerPoint 2003 Add-in for Microsoft Word 2003 File name alfresco-community-excel2003-addin-3. Some Alfresco installation wizards will detect whether you have a JDK on your machine and. Installing and Configuring Alfresco Community Edition 3.

mysql. and click Next. 8.com/downloads 2. Navigate to where you downloaded the JDK. Locate and select the appropriate package for your platform. Installing MySQL This task describes how to install a MySQL database for use with Alfresco. 10 . In the Wizard Completed window. 2. 1. specify a location on your system in which to download and install MySQL. and click Next.sun. and double-click the installer file. Skip the MySQL registration.Installing and Configuring Alfresco Community Edition 3. Configuring MySQL The MySQL configuration wizard starts immediately after the MySQL Server Setup wizard closes. 1. 3. and the MySQL Server Instance Configuration wizard opens.com 2. JDK is installed on your system. Browse to the MySQL download site: http://dev. 5. Select the Typical setup type. Note: Some of the Alfresco installation wizards install an embedded instance of MySQL that is configured with the correct settings. Enter the following: • (Windows) echo %JAVA_HOME% • (Linux) echo $JAVA_HOME To add or update the variable location in Windows. The MySQL Server Setup wizard guides you through the MySQL installation. The MySQL Server Setup wizard closes.2 . 3. Installing MySQL This section describes how to set up a MySQL open source relational database management system (RDBMS) for use with Alfresco. Note: Alfresco requires MySQL 5.0. 4. 4. 5. Verifying the JAVA_HOME environment variable location The JAVA_HOME environment variable location must be set to where the JDK is installed. If prompted.67 or higher. followed by the Configuration wizard. this section describes the configuration settings that you should use.2 1. see Adding folder paths to the Windows Path variable. 9. If you prefer to install MySQL database independently. 7. click Finish. click Next. verify that the JAVA_HOME environment variable is set. Select and download the Java Development Kit (JDK) 6 for your platform. Click Install. Install the JDK on your system. If prompted. At the Welcome window. Next. 6.Installing and Configuring Alfresco Community Edition 3. Open a command prompt. Browse to where you downloaded MySQL. specify a location in which to download. This section describes how to configure MySQL to work with Alfresco. Browse to the Sun Microsystems Java download website: http://java.

Select Best Support for Multilingualism. and click Next. Accept the default networking options (Enable TCP/IP Networking. 5. Click Execute. Select Modify Security Settings. and press ENTER. 10. This sets the default character set to be UTF-8. and click Next. This creates a database that uses InnoDB as its storage engine. Port Number 3306). and click Next. 1. Next. If no errors are reported. this task describes how to verify that it was installed correctly. 12. A message informs you the configuration is complete and MySQL is installed. (Windows) Select Install as Windows Service and Include Bin Directory in Windows PATH. 3. select Transactional Database Only. 8. In the Welcome window. 4. Click Next. b. At the mysql> prompt. Type the root password admin. Open a command prompt. At the prompt. click Next. To set the approximate number of concurrent connections to the server. choose Dedicated MySQL Server Machine. type exit to exit MySQL. For database use. MySQL is set up. and click Next. Information about the installed MySQL version displays. and click Next. enter mysql -u root -p. and click Next. For production use. 3. 7. Verifying the MySQL installation Once you have installed MySQL. 2. and the default server SQL mode (Enable Strict Mode). Accept the default drive and path for the InnoDB tablespace settings. Set the following security options: a. and click Next. You have verified the MySQL installation was successful. Select Detailed Configuration.Installing and Configuring Alfresco Community Edition 3. then retype the password. Click Finish. 2. 13. Type the password that you set during the installation. 9. 6.2 1. select Decision Support (DSS) OLAP.11 . The option selected determines the memory allocation. MySQL is installed and running.2 . 4. you can verify that MySQL is correctly installed. Select Server Machine. 11. Installing and Configuring Alfresco Community Edition 3. and click Next.

Configure an Alfresco database. click Run. 6. prompting you to verify that you wish to run this software. A typical manual installation scenario includes the following procedures: 1. which contains the required software and components you need • Using a bundle that includes a preconfigured Tomcat server.Installing and Configuring Alfresco Community Edition 3. Double-click the downloaded file. Run Alfresco. batch files. and click OK.Installing and Configuring Alfresco Community Edition 3. 5. see Installation files. Depending on your system. Browse to the Alfresco Community Edition downloads area.2 Installing Alfresco This chapter provides information for installing Alfresco and Alfresco components. Install Alfresco components. In the Setup Type window. Install a supported database. database setup scripts. 3. When prompted to confirm that you want to install Alfresco on your computer. the Alfresco Web Archive (WAR). To run the installation wizard. select English. and a sample extensions folder • Using a standard WAR file to deploy on your existing application server For more information on the different installation files available to you. For example. The Installation wizard launches. 4. 6.2 . Installing Alfresco on Windows This section describes how to install Alfresco using the following methods: • Complete installation • Installation excluding JDK • Tomcat bundle installation Installing Alfresco on Windows (full installation) The installation wizard for Microsoft Windows installs all the software and components that you require for running Alfresco. click Next. You may see an Open File . Install Alfresco. you can install Alfresco using one of the following methods: • Using an installation wizards. and download the following file: Alfresco-Community-3. select one of the following options: Option Typical Description To select all the components within the Alfresco full installation. 2. you can install Alfresco using a number of different methods. 3. Install a Java SE Development Kit (JDK).2-Full-Setup.Security Warning message. 12 .exe 2. 4. click Yes. 5. 1. In the Welcome to the InstallJammer Wizard for Alfresco Community Edition window. At the Language Selection prompt.

In the InstallJammer Wizard Complete window. and prompts you to enter the root password of your chosen database and an alternative database port.13 .2-OOo-Setup. see Running Alfresco. 10. When you close the Readme file. In the Start Copying Files window.2 Custom To select individual components: • Default Component (includes DM) • WCM • Java • OpenOffice • SharePoint Protocol • MySQL Database Note: By default. select the MySQL Database option. a prompt notifies you when OpenOffice and the SharePoint Protocol are being installed. but it excludes the Java Developer Toolkit (JDK). 1.properties. 12. then follow the instructions in Configuring databases 8. You will be prompted to specify an alternative port number after the installation starts. the Database Configuration window notifies you that the default database port 3306 is already used by the embedded MySQL database. you need to modify and run the example scripts in the extras directory to create the alfresco database and user for this instance of MySQL. (Optional) Select the database to use. Installing Alfresco on Windows (excluding JDK) This section describes how to use the Alfresco OpenOffice installation wizard. and click Next. you are directed to the release notes. If you chose the Typical option. 7. The installation is complete.2 . click Next to accept the default location for Alfresco or click Browse to choose another location. including OpenOffice. The Readme files opens.Installing and Configuring Alfresco Community Edition 3. Browse to the Alfresco Community Edition downloads area. 11. select the Custom option and deselect the MySQL Database option. Alfresco installs an embedded MySQL database instance. The installation starts. Installing and Configuring Alfresco Community Edition 3. You can choose one of the following: • If you wish to use an existing MySQL server rather than the embedded MySQL database. This installation file includes all the required components for Alfresco.exe 2. which is installed locally in the Alfresco directory and runs on port number 3306. deselect the MySQL Database option. In the Choose Destination Location window. (Optional) If you have an existing MySQL database. 9. To run Alfresco. Click Next. and download the following installation file: Alfresco-Community-3. Note: If you are using your existing MySQL database. Double-click the downloaded file. click Finish. review the settings. The installation wizard writes the server name and host to the configuration file called alfrescoglobal. • If you wish to install the embedded MySQL database in addition to your existing MySQL database. (Optional) Click Next. • If you wish to use a production database other than MySQL. 13.

4. 8. 3. select one of the following options: Option Typical Custom To select individual components: • Default Component (includes DM) • WCM • Java • OpenOffice • SharePoint Protocol • MySQL Database Description To select all the components within the Alfresco full installation. Note: By default. In the Choose Destination Location window. 5. The Browse for Folders window displays. click Next to accept the default location for Alfresco or click Browse to choose another location. You need to modify and run the example scripts in the extras directory to create the alfresco database and user for this instance of MySQL. The Readme files opens. 7. and click Next. To run the installation wizard. At the Language Selection prompt. which is installed locally in the Alfresco directory and runs on port number 3306. Browse to your JDK installation and click OK. prompting you to locate your JDK installation.2 You may see an Open File . The installation is complete. 14 . deselect the MySQL Database option. 10.Installing and Configuring Alfresco Community Edition 3. click Finish. 13. When you close the Readme file.Installing and Configuring Alfresco Community Edition 3. • If you wish to install the embedded MySQL database in addition to your existing MySQL database. • If you wish to use a production database other than MySQL. 14. In the Start Copying Files window. select English.2 . (Optional) Click Next. In the Welcome to the InstallJammer Wizard for Alfresco Community Edition window. the Database Configuration window notifies you that the default database port 3306 is already used by the embedded MySQL database. select the MySQL Database option. review the settings. In the InstallJammer Wizard Complete window. Alfresco installs an embedded MySQL database instance. select the Custom option and deselect the MySQL Database option. 6. click Yes. The installation wizard writes the server name and host to the alfresco-global. Click Next. You can choose one of the following: • If you wish to use an existing MySQL server rather than the embedded MySQL database. click Run. The Installation wizard launches.Security Warning message. prompting you to verify that you wish to run this software. you are directed to the release notes. and prompts you to enter the root password of your chosen database and an alternative database port. 11. and click OK. You may see a prompt to notify you when the components are being installed. You will be prompted to specify an alternative port number after the installation starts.properties file. 12. then follow the instructions in Configuring databases 9. (Optional) Select the database to use. (Optional) If you have an existing MySQL database. In the Setup Type window. When prompted to confirm that you want to install Alfresco on your computer. The installation starts. click Next.

Browse to the AlfrescoCommunity Edition downloads area.2 . Locate the property dir.org. ensure that you have the following software installed on your system: • JDK 6 • MySQL database • MySQL database 1. Comment out the settings for the remaining databases. For more information on installing these components. Extract the downloaded file into the location you specified. Alfresco also requires Flash Player. Save the alfresco-global. and OpenOffice.Installing and Configuring Alfresco Community Edition 3. Installing Alfresco Tomcat bundle on Windows This section describes how to install Alfresco using the Tomcat bundle on a Windows platform. refer to Configuring databases Installing Alfresco on Redhat Linux This section describes how to install Alfresco on Redhat Linux using the following methods: • Installation wizard • Tomcat bundle Installing Alfresco on Red Hat Linux The installation wizard for Red Hat Linux install the software and components that you require for running Alfresco. 6. Note: These instructions are for working on a Graphical User Interface (GUI) in an X11 environment. refer to Installing Alfresco components. Ensure that the JAVA_HOME environment variable points to the location of your JDK install. Replace backslashes with slashes. Change the property to show an absolute path for the alf_data directory. and download the following installation file: alfresco-community-tomcat-3.zip 2. Add the property settings for your preferred database. Execute the downloaded file.root=C:/Alfresco/alf_data Note: This directory is created for you when you start the server.2 To run Alfresco. Before you start.2. Refer to Installing a JDK.properties file. 7. For further details on databases.15 . 9. This installation wizard does not include JDK or an embedded database. and download the following installation file: Alfresco-Community-3. ensure that you have a JDK installed. 10. see Running Alfresco. 5. Open the alfresco-global.2-Linux-x86-Install Note: Ensure that you have the correct permissions set for executing the file. 1.root.properties file. 2. 3. Browse to the Alfresco Community Edition downloads area. Specify C:\Alfresco as the location for the download. For example: dir. 8. SWF Tools. Before you install Alfresco. 4. Installing and Configuring Alfresco Community Edition 3.

Before you start. In the Choose Destination Location window. Click OK. In the Setup Type window. When prompted to confirm installation. Refer to Installing a JDK. a prompt notifies you when OpenOffice and the SharePoint Protocol are being installed. 5. A prompt notifies you when the SharePoint Protocol is being installed. Browse to the AlfrescoCommunity Edition downloads area. click Finish. select one of the following options: Option Typical Custom To select individual components: • Default Component (includes DM) • WCM • Java • OpenOffice • SharePoint Protocol Description To select all the components within the Alfresco full installation. In the OpenOffice Location window. The Installation wizard launches. Note: The installer looks for <path>/soffice. select English.2 . you are directed to the release notes.2 3. and download the following installation file: 16 .Installing and Configuring Alfresco Community Edition 3.Installing and Configuring Alfresco Community Edition 3. In the Start Copying Files window. If you do not want to use OpenOffice for your document conversions. In the Welcome window. Click Next. Alfresco also requires Flash Player. cp soffice. browse to your OpenOffice location and click OK. 11. and OpenOffice. To run Alfresco. 15. select the Alfresco installation folder as the location. As a temporary workaround. Click Next. 7. SWF Tools.org. prompting you to locate your JDK installation. Installing the Alfresco Tomcat bundle on Linux This section describes how to install the Alfresco Tomcat bundle on Linux. If you chose the Typical option.exe will help the installer finish correctly.exe. The Browse for Folder window displays. 6. The installation starts. review the settings and click Next. refer to Installing Alfresco components. 4. The Readme file opens. enter the root password of your MySQL database and a port number. Click Next. 9. 13. 8. 16. 10. Browse to your JDK installation and click OK. ensure that you have a JDK installed. When you close the Readme file. click Next. 14. At the Language Selection prompt. click Next to accept the default location for Alfresco. For more information on installing these components. 12. and click OK. The installation is complete. In the InstallJammer Wizard Complete window. (Optional) In the Database Configuration window.bin soffice. click Yes. see Running Alfresco. 1.

(Optional) If you deployed previous versions of Alfresco. 3. 5.tar.sh to point the APPSERVER variable to the Tomcat bundle location /opt/alfresco/tomcat. Note: If you change this location from/opt/alfresco/. 6. This installation wizard does not include JDK or an embedded database. prompting you to locate your JDK installation.root=/opt/alfresco/alf_data This directory is created for you when you start the server. In the Setup Type window. click Yes. Ensure that the JAVA_HOME environment variable points to the location of your JDK install.properties file. Before you install Alfresco. 8. Browse to the Alfresco Community Edition downloads area. 10.2-MacOSXInstall 4. Browse to your 8. Double-click the downloaded file to unpack it.2. edit alfresco. Add the property settings for your preferred database. you can remove any temporary files created by your application server. ensure that you have the following software installed on your system: • JDK 6 • MySQL database 1. Locate the property dir. click Next. 7.2 . 5. 6.properties file. 11. For further details on databases. and download the following installation file: Alfresco-Community-3.gz 2. Open the alfresco-global.Installing and Configuring Alfresco Community Edition 3. In the Welcome window. . and click OK. 3. The Browse for Folder window displays. The Installation wizard launches.gz 2.2-MacOSXInstall.17 Description To select all the components within the Alfresco full installation. Specify /opt/alfresco/ as the location for the download. select one of the following options: Option Typical Custom To select individual components: • Default Component (includes DM) • WCM Installing and Configuring Alfresco Community Edition 3. Change the property to show an absolute path for the alf_data directory. When prompted to confirm installation. 4. For example: dir.2 alfresco-community-tomcat-3. 7. Comment out the settings for the remaining databases.tar. select English. Save the alfresco-global. 9. Extract the downloaded file into the location you previously specified.root. refer to Configuring databases Installing Alfresco on Mac The installation wizard for Mac installs all the software and components that you require for running Alfresco. Run the following executable file: Alfresco-Community-3. At the Language Selection prompt.

Click Next. XML files. Tomcat 6. click Next to accept the default location for Alfresco. 4. In the Choose Destination Location window. Specify a location for the download. 2. Change the value shared. Installing the Alfresco WAR on any platform Use the Web Archive (WAR) file to install Alfresco on any platform. The installation starts.2 • Java • OpenOffice • SharePoint Protocol 9. The WAR zip includes the binaries for ImageMagick and pdf2swf. Locate <TOMCAT_HOME>. Copy the alfresco.x does not contain the shared/classes and shared/lib directories.tar.x to use the correct directory structure and files for Alfresco. The installation is complete. 2. Java classes. an application server. In the InstallJammer Wizard Complete window.2. some of the directories that were present in Tomcat 5. When you close the Readme file.Installing and Configuring Alfresco Community Edition 3. Extract the downloaded file. a supported database. Select and download one of the following files: • alfresco-community-war-3. 10.x If you install Tomcat 6.Installing and Configuring Alfresco Community Edition 3.x separately.2 . Alfresco uses these directories to locate some of the configuration override files. servlets. review the settings and click Next. The Readme file opens. see Running Alfresco. 1.war file to the appropriate location for your application server. A WAR file is a JAR file used to distribute a collection of files (JavaServer Pages. Open the <TOMCAT-HOME>/conf/catalina. a prompt notifies you when OpenOffice and the SharePoint Protocol are being installed. Create the shared/classes directory. To run Alfresco. you must remove any temporary files created by your application server. 3. 5. Note: If you deployed previous versions of Alfresco. In the Start Copying Files window. you are directed to the release notes. 1.properties file. Use this method of installing Alfresco if you already have installed a JDK. 12.x are not present. Browse to the Alfresco Community Edition download area. This section describes how to configure Tomcat 6.war file and share.loader= to the following: 18 . tag libraries and static Web pages) that together constitute a web application.zip • alfresco-community-war-3. For example. Modifying the directory paths for Tomcat 6.2. and the additional Alfresco components. 11.gz 3. click Finish. If you chose the Typical option. 4. for example: <TOMCAT_HOME>/webapps.

to 8180): <!-. Modify the /conf/server.xml file. Start the new Share Tomcat.. If you are running the Share Tomcat on a separate machine. you must modify the override file in the Share Tomcat web-extension directory. Move the share.gz 3. (Optional) Configure the original Alfresco Tomcat deployment.jdk6/jre/lib/endorsed Download the extension samples Each Alfresco distribution includes a download containing sample extension files.jar 5.zip • alfresco-community-sample-extensions-3. The extension samples are available for you to configure. 5. 7. http://yourserver:8080 8. Change the port number in the section (for example.. Change any instance of the server and port to the correct name or IP address of the Alfresco server.base}/shared/lib/ *. Open the webscript-framework-config-custom. Ensure that a copy of the commons-el... but Linux-based deployments can use the same methods. Specify a location for the download.war file from the original Tomcat \webapps directory to the new Tomcat / webapps directory. 2. 2.2 .Define a non-SSL HTTP/1. 1. 1. Select and download one of the following files: • alfresco-community-sample-extensions-3.xml file for the new Tomcat instance as follows: a. Browse to the Alfresco Community Edition downloads area. Start the original Tomcat. or your own methods. b.base}/shared/classes. 4. These instructions are for Windows deployments.2. Copy the JDBC drivers for the database you are using to: lib/ 6. 3.1 Connector on port 8080 --> <Connector port="8080" .tar.loader=${catalina.. Deploying Share into a separate Tomcat instance This task provides information for running Share in a separate Tomcat instance. 6. Once you have downloaded the sample files. Ensure that a copy of the commons-el. Installing and Configuring Alfresco Community Edition 3. such as the Spring configuration. Change the port number in the line (for example.2 shared.19 .jar file is in the Share Tomcat lib directory. to 8006): <Server port="8005" shutdown="SHUTDOWN"> b. 7.Installing and Configuring Alfresco Community Edition 3. copy them into <classPathRoot>.${catalina. You can use Alfresco supplied batch files.jar file is in the lib directory. If you are using Java SE 6. You can use copies of the Alfresco supplied batch files. copy any jar files that needed to go into the Tomcat common/endorsed directory into the following directory: . You can use these sample extensions for advanced Alfresco customizations. Install a new Tomcat instance. as follows: a.2.

Browse to the Alfresco home directory. • Installing Alfresco WCM • Installing OpenOffice • Installing ImageMagick • Installing Microsoft Office® Add-ins • Installing Flash Player • Installing SWFTools • Installing TinyMCE language packs • Installing an AMP • Installing SharePoint Protocol Support Installing Alfresco WCM This section describes how to set up Alfresco Web Content Management (WCM). 1.2 Installing Alfresco components This section describes how to install components that integrate with Alfresco. 2. Download the file into the Alfresco home directory. 2. copy the file wcm-bootstrap-context.zip • (Linux) alfresco-community-wcm-3. Select one of the following files: • (Windows) alfresco-community-wcm-3. For example: • (Windows) C:\Alfresco • (Linux) /opt/alfresco 4. 5. 6. In the root of the Alfresco home directory. search for the following text: The Web Forms folder was successfully created: and The Web Projects folder was successfully created: 20 .tar. allow this because no existing files will be overwritten. configured.xml to the <extension> directory. and started the Alfresco server.2. 1. open alfresco.gz 3.Installing and Configuring Alfresco Community Edition 3. Installing WCM to an existing instance of Alfresco This task describes how to install WCM to an existing instance of Alfresco.2 .log. To restart the Alfresco server.log. Restart the Alfresco server. Browse to the Alfresco Community Edition download area. WCM is installed and configured. In alfresco.2. In the Alfresco home directory.Installing and Configuring Alfresco Community Edition 3. If your unzip program asks about existing directories. This ensures that the Alfresco server starts to use the installed WCM components. see Starting the server. and unzip the downloaded file. Verifying the WCM installation Verify the WCM installation after you have installed. These can be installed any time before or after installing Alfresco.

started. 5. Installing and Configuring Alfresco Community Edition 3. For example. 7. Check that the following additional spaces are in your Alfresco repository: • Web Projects in Company Home • Web Forms in Data Dictionary WCM has been installed. The published files are then typically published by a web server such as Apache for static content. 1. The directory in which to store log data. In the Deployment Settings window. configured. 2. To use the Website Preview feature. click Next. Installing the WCM standalone deployment receiver The standalone deployment receiver allows a web project from WCM to be deployed to a remote file server. At the Language selection prompt. click Next to accept the default location for Alfresco or choose another location. If you are using RMI as your transport protocol. Browse to the AlfrescoCommunity Edition download area. and verified. 10.2 . Alternatively. enter the following settings: Deployment setting Temporary Data Location Log Location Metadata Location Target Location Name of default file system target Description The directory in which to store temporary data files. For example. Enter a user name and password for the user account that will administer the deployment receiver. typically a web or application server. start the Alfresco virtualization server (see Starting the Alfresco virtualization server). 4. In the Choose Destination Location window. enter the port numbers for the following: Deployment RMI Registry Port Number RMI Service Port Number Description The port number for the RMI registry.Installing and Configuring Alfresco Community Edition 3.2 3. The default name of the file system target is default.2-Setup. The port number to use for the RMI service. for example.2-Linux-x86-Install 3. Choose this so that there are no conflicts with other services.exe • (Linux) Alfresco-DeploymentCommunity-3. click OK. Note: For Windows directory locations. 6. At the Install Alfresco Standalone Deployment Receiver prompt. or an application server. click Yes. Download one of the following files: • (Windows) Alfresco-DeploymentCommunity-3. The directory in which to store metadata. C:/directory1/directory2. you can use the slash character as a separator. The directory in which to store deployment files. In the Welcome to the Alfresco Standalone Deployment Receiver window. the backslashes need to be escaped. Click Next. 9. C:\alfresco\deployment on Windows or /opt/alfresco/deployment on Linux. use C: \\directory1\\directory2. Choose the default of 44101 to avoid conflict the other services. 8.21 . such as Tomcat or JBoss for dynamic content.

To change the settings. Download the latest (stable) version of OpenOffice for your platform. Note: If you installed Alfresco using an installation wizard. and can be done any time after Alfresco is installed. a text file to a PDF file. 8. Change the installation directory to: • (Windows) c:\Alfresco\OpenOffice • (Linux) /opt/alfresco/OpenOffice 9. Browse to the location of your downloaded file.Installing and Configuring Alfresco Community Edition 3. For example. 5. Installing OpenOffice Within Alfresco. you can transform a document from one format to another. Alfresco uses ImageMagick to manipulate images for previewing. Optionally.2 11. A wizard guides you through the installation. 1. specify a download destination. Set the img.Installing and Configuring Alfresco Community Edition 3. see Configuring the standalone deployment receiver. and click Next. In the Start Copying Files window. When prompted. and click Next.2 . click Finish.exe.exe.properties file to point to the OpenOffice binary soffice.exe=C:/Alfresco/ImageMagick/bin/convert. If ImageMagick is not on your system. 1. for Windows: a.root= and img.exe= property to img. Set the img. Browse to the OpenOffice. you must install and configure ImageMagick. or to add further deployment targets. select the files for which you want OpenOffice to be the default application. In the InstallJammer Wizard Complete window. 7. b. 12.org 2.openoffice.root= property to img. 22 . for example. To have access to these transformation facilities in Alfresco. Accept the license agreement. stop and restart the server. 10.org download site: http://download. is configured with a single file system deployment target. Enter Customer information as appropriate. and then close the program.exe= properties in the <classPathRoot>/alfrescoglobal. Installing ImageMagick To enable image manipulation in Alfresco.properties file to point to the ImageMagick root directory.exe= property in the <classPathRoot>\alfresco-global. 4. ImageMagick is already be installed. 2. Select the set up type and Custom. 11. OpenOffice may already be installed. You can run the convert command. and click Next. Start one of the OpenOffice programs for the initial registration. If the Alfresco server is running. Modify the ooo. 6.root=C:/Alfresco/ImageMagick. click Next. The deployment receiver. 12. Note: If you installed Alfresco using one of the installation wizards. out of the box. which is part of ImageMagick and usually located in /usr/ bin. 3. you must install OpenOffice. This is optional. and install the application. browse to the ImageMagick download site and install the appropriate package for your platform. Verify if ImageMagick is already installed on your system. 3. Modify the img. and click Next.

5. In the Web Client URL field. For example: http://server:8080/alfresco/webdav/ Installing and Configuring Alfresco Community Edition 3.exe= property to img. such as Word.2. including Outlook if you use Word as an email editor. they are also compatible with Microsoft Office 2007. There is no known workaround at the time of writing. These components are . b.exe. Run the Microsoft setup file: alfresco-community-office2003-addins-3. and PowerPoint. run the Office Setup program and expand the list of available options for each application. If required. Note: If you are running Office 2007 on Windows Vista.2. enter the location of Alfresco Explorer. run Word. You can also use individual installers to add Alfresco to one of the three Office applications. and Visual Studio 2005 Tools for Office Second Edition runtime. 4. append webdav/ to the Alfresco Explorer URL.NET 2. for example.23 .zip • alfresco-community-powerpoint2003-addin-3.zip This example refers to the Office installer that installs all three Add-ins. To find these options. Run setup. however.root= property to img. • The installing user has Windows administrator privileges. / ImageMagick/ Installing Microsoft Office Add-ins This task describes how to install Alfresco Add-ins for Microsoft® Office applications. Excel. Therefore. The setup is complete. The Alfresco Add-Ins have been designed with Microsoft Office 2003 in mind. the setup program will download the required components from the Microsoft website. In the WebDAV URL field. Set the img. This is a known problem with Vista and affects many applications. note that Microsoft have rewritten the WebDAV parts of Vista which means you will experience READ ONLY access to the Alfresco repository over WebDAV.0 framework. These individual installers are: • alfresco-community-word2003-addin-3. including Microsoft's own SharePoint Server. Run the Office application.zip • alfresco-community-excel2003-addin-3.2 . A Welcome window with configuration options displays.2. For example. You may require your original Office 2003 install media to add these required components. 1. CIFS access is unaffected and works as it does with Windows XP. use CIFS to obtain read/write access to Alfresco using Windows Vista.exe. Set the img.Installing and Configuring Alfresco Community Edition 3.exe=/ImageMagick/bin/convert. Before you start. Browse to the Alfresco Community Edition download area.NET Programmability Support option is installed for each of the Office applications that you are installing the Add-ins (such as Word. and PowerPoint).root=/ImageMagick. Excel.zip 3.2.2 For Linux: a. You can return to the configuration options at any time using the link at the bottom of the Add-In window. make sure that: • The . • Any Microsoft Office applications on your system are NOT running. Note: Ensure that you do not include a slash (/) at the end of the path. 2. For example: http://server:8080/alfresco/ 6.

2. This is optional and may be installed after you have installed Alfresco. but you should verify for the correct address. Browse to the location of your downloaded file and install the application. you must install the complete SWF Tools. The pdf2swf utility generates one frame per page of fully formatted text inside a Flash movie.Installing and Configuring Alfresco Community Edition 3.adobe. you can map a network drive to the Alfresco CIFS interface instead. If you are using the CIFS interface. A wizard guides you through the installation. click Close. enter your Alfresco user name and password. 4. the options to Create start menu and Create desktop shortcut are selected. 4. Accept the license agreement and click Next. This is optional and may be installed after you have installed Alfresco. Browse to the location of your downloaded file and and install the application. To install the pdf2swf utility. By default. The Add-in will try to auto-complete this value. Browse to the Adobe Flash Player download website: http://www.com/products/flashplayer 2. 5. 6. 3. In the Authentication area. 3. The Add-In will always try to automatically log you in to Alfresco in order to present your checkedout documents and your assigned tasks.1 from 2007-02-28 because it does not support some functionalities Alfresco needs to render the preview. However.2 .Installing and Configuring Alfresco Community Edition 3. Browse to the SWF Tools website. 7. Select whether you want to install the SWF Tools for all users or only for the current user. it is very important that you are authenticated automatically. sometimes the Add-In needs to present your Alfresco user name and password for authentication. 8. Installing SWFTools on Windows 1. If you are not in an Enterprise environment.2 7. It is recommended that you enter and save your Alfresco credentials. authentication is usually automatic. Installing SWF Tools Alfresco Share uses the pdf2swf utility of the SWF Tools for previewing PDF files. All values are stored in the Windows registry and your password is encrypted against casual hacking attempts. Select the installation directory. Limitations in the Microsoft Office APIs mean that an error is shown instead of an authentication dialog box if the Alfresco CIFS interface rejects your connection attempt. Download the latest (stable) version of the SWF Tools for your platform.8. 9. For example: \\server_a\alfresco\ or \\servera\alfresco\ If you intend to use the CIFS interface to save documents via the Add-in.exe. where it may not be possible to configure automatic authentication. Installing Flash Player Alfresco Share uses the Flash Player for viewing Flash previews and also when you use the multi-file upload facility. 24 . The Windows version is designated with the suffix . In the CIFS Server field. enter the path to the CIFS server. Click Save Settings. A wizard guides you through the installation. Download the latest (stable) version of Flash Player for your platform. Click Next to begin the install process. 1. When the installation is complete. Note: Download a version post 0.

properties file to point to the SWF Tools root directory. 9./configure If you see a message on Red Hat Linux that states your operating system is unknown. The Unix version is designated with the suffix . Type the following command to install the programs.1 from 2007-02-28 because it does not support some functionalities Alfresco needs to render the preview. Browse to the SWF Tools website. Note: Download a version post 0. For the most up-to-date instructions on installing the SWF Tools./configure–build=x86_64-pc-linux-gnu If you have an issue on Solaris with the lame libs.gz. /usr/bin/ The SWF Tools are installed. 3. ensure that the following packages are installed on your machine: • zlib-devel • ibjpeg-devel • giflib-devel • freetype-devel • gcc • gcc-c++ You can download and install all of these packages using the following command: yum install zlib-devel libjpeg-devel giflib-devel freetype-devel gcc gcc-c++ 1. For Linux.properties file to point to the SWF Tools root directory. The following version has been tested and verified by Alfresco as being fully functional: http://www. Installing SWF Tools on Linux Alfresco Share uses the features provided in the development snapshots of the tools. so you need to compile a development snapshot. 4./configure -disable-lame 6. 2. you can disable the making of portions of SWF Tools that use lame by using the following setting: . data files.tar. refer to the SWF Tools website.exe= property in the alfresco-global. Modify the swf. Type the following command to compile the package: make Optionally. Change to the directory containing the source code.gz (you may have to copy this URL and paste it into a download manager).exe= property in the alfreso-global.25 . and documentation: make install By default.2 8.swftools. (Linux) Before you compile. Type the following command to configure the package for your system: . you can run the make check command to run any self-tests that come with the package. Modify the swf. for example: swf. the files are installed to the /usr/local/bin directory. For example. 7.8. /usr/bin/ Installing and Configuring Alfresco Community Edition 3. The install file contains detailed instructions on how to compile and install the SWF Tools. Unpack the tar. Click Finish. 5.tar.2 .exe=C:/Alfresco/bin/pdf2swf Note: Ensure that you do not include a slash (/) at the end of the path.exe=/usr/bin/pdf2swf Note: Ensure that you do not include a slash (/) at the end of the path.gz file. For example. there is no binary version.org/ swftools-2008-10-08-0802. 8. Download the latest version of the SWF Tools for your platform. for example: swf. then use the following setting: .Installing and Configuring Alfresco Community Edition 3.

and Italian (it).com/download_i18n.bat command.php 2. refer to the SWF Tools website. Run the following command: java -jar alfresco-mmt. content model. The MMT is also available as a separately downloadable JAR file from the Alfresco release download area (alfresco-mmt-3. The location of the WAR file for your Alfresco installation.Installing and Configuring Alfresco Community Edition 3. Browse to the TinyMCE website: http://tinymce.2 . Japanese (jp).jar).Installing and Configuring Alfresco Community Edition 3. run the apply_amps. 1. Unpack the language file: • For Share. French (fr). unpack to: <TOMCAT_HOME>/webapps/share/modules/editors/tiny_mce • For Explorer. All AMP files found in the directory and its sub directories are installed. alternatively. Install command [options]. If you have a translation that is not supplied with Alfresco. Enables detailed output containing what is being updated and to where it is being copied. German (de). Download the required TinyMCE language pack. -directory 26 . This batch file applies all the AMP files that are located in the amps directory. Note: For Tomcat. Install command [options]. This default bundle includes English (en). Ensure that the browser cache is cleared or refresh the page. This section describes how to install an AMP in an Alfresco WAR using the Module Management Tool (MMT).moxiecode. then you must add the appropriate TinyMCE language pack for the translation to work correctly. Spanish (es). the default language packs are already installed. Browse to the /bin directory: • (Windows) C:\Alfresco\bin • (Linux) /opt/alfresco/bin 2. which is in the root Alfresco directory. Indicates that the AMP file location specified is a directory. If you installed Alfresco using one of the installation wizards or bundles. 1. and the directory structure that is used to distribute additional functionality for Alfresco. content. For the most up-to-date instructions on installing the SWF Tools. Installing TinyMCE language packs Translations in Alfresco use the language pack supplied in the default bundle. and it is included in the Alfresco installers.2. The MMT is used to install and manage AMP files.2 The SWF Tools are installed. 3. Installing an Alfresco Module Package An Alfresco Module Package (AMP) is a bundle of code. unpack to: <TOMCAT_HOME>/webapps/alfresco/scripts/tiny_mce 4.jar install <AMPFileLocation> <WARFileLocation> [options] Where: Option <AMPFileLocation> <WARFileLocation> -verbose Description The location of the AMP file that you want to install.

Indicates that the WAR will not be backed up before the AMP is installed. then the files for the older version are removed from the WAR and replaced with the newer files. You can also use Microsoft Office SharePoint Protocol Support to enable online editing for Office documents within Alfresco Share. Previews installation of AMP without modifying WAR file. The following commands show examples of how to install the example-amp. and assumes that the AMP file is in the same directory as the WAR file: java -jar alfresco-mmt.jar install example-amp. Some application servers (notably Tomcat) do not always fully clean up their temporary working files. Installing Microsoft Office SharePoint Protocol Support The Microsoft Office SharePoint Protocol Support offers Microsoft users greater choice by providing a fully-compatible SharePoint repository that allows the Microsoft Office Suite applications (for example. Installing and Configuring Alfresco Community Edition 3. It enables your users to modify Office files without checking them in and out. PowerPoint. for example. It is not recommended that you overwrite an existing file in an AMP. This enables your users to leverage the Alfresco repository directly from Microsoft Office. -nobackup This command installs the files found in the AMP into the Alfresco WAR. and the repository will be bootstrapped to include the new module functionality and data.2 -force -preview Install command [options]. The MMT makes a backup copy of the updated file and stores it in the WAR. 3. When an update of the module occurs and the old files are removed. a manual restore may be necessary if recovery to an existing state is required. Forces installation of AMP regardless of currently installed module version.2 . it is recommended that you delete (or move) the Tomcat work and temp directories while Tomcat is shut down.amp.amp alfresco. however it is sometimes necessary. the installed module configuration will be detected. If the module represented by the AMP is already installed and the installing AMP is of a higher release version.jar list <WARFileLocation> This command provides a detailed listing of all the modules currently installed in the WAR file specified. this backup will be restored prior to the installation of the new files.war -verbose The modified Alfresco WAR can then be redeployed back into your application server. and this can interfere with successful installation of an AMP file. For example: java -jar alfresco-mmt. Word. When the repository is next started. The following example will install the AMP file: java -jar alfresco-mmt.27 . Alfresco locks the file while it is being modified and releases the lock when the file is saved and closed. Excel) to interact with Alfresco as if it was SharePoint. To remedy this situation. the console will show that the custom class was initialized during startup. It is good practice to use this option before installing the AMP. the changes that will update existing files. In these cases. Install command [options].war -preview Review the modification to check the changes that will update any existing files.jar install example-amp. It reports the modifications that will occur on the WAR without making any physical changes.Installing and Configuring Alfresco Community Edition 3.amp alfresco. On restarting the application server. Verify that the AMP is installed using the MMT list command. Problems may occur if multiple installed modules modify the same existing file.

6.Installing and Configuring Alfresco Community Edition 3. 1. 2. Browse to the Enterprise download area.amp file into the alfresco. Shut down your Alfresco server.war file using the Module Management Tool (MMT). Installing the SharePoint Protocol Support AMP The SharePoint Protocol support functionality is installed from an Alfresco AMP. Install the vti-module. Browse to the AlfrescoCommunity Edition download area.amp file.Installing and Configuring Alfresco Community Edition 3.2 The following diagram shows the architecture of the SharePoint Protocol Support in relation to an Alfresco installation. Note: If you installed Alfresco using an installation wizard. the SharePoint Protocol may already be installed. 28 . it responds to the SharePoint requests from Office. The SharePoint Protocol Support architecture embeds a Jetty web server within the Alfresco repository. the SharePoint Protocol Support is installed by default.2 . Download the vti-module. Move the file to the amps directory. 3. If you use the Windows or Linux installers to install Alfresco. When you install this file.amp file holds the functionality for the SharePoint connector. 4. The vti-module. and therefore allows Alfresco to appear as the SharePoint server. The Microsoft Office clients communicate directly with the Jetty server using WebDAV-like calls with proprietary extensions and on different port number from Alfresco Share. 5. These instructions describe how to install the SharePoint Protocol Support into the Alfresco WAR. This port number can be configured in the SharePoint Protocol Support properties files.

alfresco.alfresco. Use this property to specify the IP address or host name of the Alfresco server. Custom properties and overrides can be set in the alfresco-global.properties file.properties file. Verify that you have applied the SharePoint AMP to Alfresco by checking that you have the following directory: /webapps/alfresco/WEB-INF/classes/alfresco/module/org. Replace your-share-host with the location of your Share instance. following the instructions in Installing SharePoint Protocol Support.2 .context=/alfresco vti. Do not change the properties in this file. the default / alfresco sets the URL to http://your-sharehost:7070/alfresco.port Description Use this property to configure on which port the SharePoint server listens. Use this property to specify the URL that you enter in the Microsoft Office Shared Workspace. alternatively.alfresco.module. run the apply_amps. Use this property to specify the Share instance.alfresco.module. Add the following properties: vti. 8.properties in <TOMCAT_HOME>/webapps/alfresco/WEB-INF/classes/alfresco/ module/org. use only the alfresco-global.share. The default port number is 7070. 7.shareHostWithPort The vti. vti.vti/ context Configuring SharePoint Protocol Support The SharePoint Protocol Support functionality uses the properties in the default configuration file called vti. Ensure that you have applied the SharePoint Protocol Support AMP.module.29 .server. For example. 4. The default is set to /alfresco.context vti.2 Note: For Tomcat.alfresoHostWithPort=http://your-host:8080 vti. Replace your-host with the location of your Alfresco server.deployment.alfresoHostWithPort vti. Start your Alfresco server to expand the directory structure. Restart your Alfresco server.vti/context.Installing and Configuring Alfresco Community Edition 3.properties file. Property vti-server. Open the alfresco-global.vti/context contains the full list of properties.properties file in <TOMCAT_HOME>/webapps/alfresco/WEB-INF/classes/ alfresco/module/org.bat command.share.alfresco. Configuring SharePoint Protocol for Online Editing There is a known issue with Office 2003 and 2007 Office documents opening as read-only in Internet Explorer for all versions before Vista SP1. 3. The Microsoft SharePoint Protocol Support functionality is installed and configured. Save the alfresco-global.alfresco.properties file. This property includes the prefix http:// which allows for HTTPS support. Installing and Configuring Alfresco Community Edition 3. 2. This batch file applies all the amps that are located in the amps directory.port=7070 vti.deployment.alfresco. which is in the root Alfresco directory. 1.shareHostWithPort=http://your-share-host:8080 The following table describes the properties.

you can start Alfresco Explorer using a browser. In Windows.sh start. Alfresco Share opens.bat. the configuration is set for you. Running Alfresco This section describes how to start and stop the following: • Alfresco server • Alfresco Explorer • Alfresco Share • Virtualization server • Standalone deployment receiver Note: Before running Alfresco. Log in using admin as the default user name and password. You can edit the alfresco. alternatively. from the Start menu. Browse to the location of your Alfresco installation. and select All Programs > Alfresco Community Edition > Alfresco Explorer. In Windows. you may need to modify the configuration settings. A command prompt opens with a message indicating the server has started. 2.Installing and Configuring Alfresco Community Edition 3. If you have installed Alfresco using one of the installation wizards. • (Windows) • Browse to C:\alfresco.Installing and Configuring Alfresco Community Edition 3. browse to http://localhost:8080/share. alternatively. If you installed Alfresco on your local machine. If you installed Alfresco on your local machine. Starting Alfresco Explorer Once you have installed Alfresco.2 Please refer to the knowledge base article 870853 on the Microsoft website to enable the Online Editing functionality. Starting the Alfresco server Once you have installed Alfresco. Browse to the location of your Alfresco installation. and double-click alf_start.2 . you can test the installation by starting the server. you can click the Start menu. Refer to the Configuring Alfresco chapter for more information on how to set up Alfresco for your system. and select All Programs > Alfresco Community Edition > Alfresco Share. INFO: Server startup in nnnn ms • (Linux) Browse to /opt/alfresco/ and run alfresco. Log in using admin as the default user name and password. 30 . you can start Alfresco Share using a browser. browse to http://localhost:8080/alfresco. Alfresco Explorer opens.sh file to change to your preferred shell. 2. or • If you installed Alfresco using the installer. select All Programs > Alfresco Community Edition > Start Alfresco Server. 1. Starting Alfresco Share Once you have installed Alfresco. 1. you can click the Start menu. The default shell is sh.

When deploying to a deployment engine running on a multi-NIC system. and select All Programs > Alfresco Community Edition > Stop Alfresco Server. The command prompt that opened during startup closes. and run alfresco.start. • (Linux) To start the standalone deployment engine.bat. • (Linux) Browse to /opt/alfresco/. Alfresco has now stopped. Stopping the Alfresco virtualization server • (Windows) • Browse to C:\alfresco.2 Stopping the Alfresco server • (Windows) • Browse to C:\alfresco. • (Linux) Browse to /opt/alfresco/ and run virtual. open a command prompt and run the deploy_start. Starting the Alfresco virtualization server If you have installed Alfresco WCM. • (Windows) • Browse to C:\alfresco.Installing and Configuring Alfresco Community Edition 3. you can use the Website preview feature by starting the Alfresco virtualization server.bat. and select Programs >Alfresco Community Edition > Stop Virtual Server. It is also possible to install the standalone deployment engine as a Windows service.bat.31 . it may be necessary to bind the RMI registry to a particular IP address.sh stop. which can automatically start when Windows starts.bat: Installing and Configuring Alfresco Community Edition 3. or • Click the Start menu.alf_sh start.stop.2 . • (Windows) To start the standalone deployment engine: • Open a command prompt.sh script. To do this. The Start menu action is available if you have used the deployment installer to install the Standalone Deployment Engine. and double-click virtual. This action is calling the deploy_start.sh stop. add the following to the Java command in deploy_start. Bourne shell scripts are provided for UNIX and Windows batch files are provided for Windows.stop. Starting the deployment engine The standalone deployment engine is implemented as a set of Java libraries and is multi-platform. • (Linux) Browse to /opt/alfresco/. or • Click the Start menu. and double-click alf. or • Click the Start menu. and run sh virtual_alf. and run the deploy_start script.sh or deploy_start.bat script. and select All Programs > Alfresco Community Edition > Start Virtual Server. or • Select Start Menu > All Programs > Alfresco Standalone Deployment Receiver > Start Alfresco Standalone Deployment Receiver. and double-click virtual.

open a command prompt. and run the deploy_stop.x.hostname=x.x is the IP address assigned to the NIC to which you want to bind. Stopping the deployment engine The standalone deployment engine is implemented as a set of Java libraries and is multi-platform.Installing and Configuring Alfresco Community Edition 3. Bourne shell scripts are provided for UNIX and Windows batch files are provided for Windows.Installing and Configuring Alfresco Community Edition 3. and run deploy_stop.2 .x Where x. or • Select Start Menu > All Programs > Alfresco Standalone Deployment Receiver > Stop Alfresco Standalone Deployment Receiver.sh script. 32 .x.bat. • (Windows) To stop the standalone deployment engine: • Open a command prompt.x.2 -Djava.server. • (Linux) To stop the standalone deployment engine.x.rmi.

which you can extend or override in the global properties (alfresco-global.properties • <configRoot>/alfresco/hibernate-cfg.properties • <configRoot>/alfresco/subsystems/<category>/<type>/*. To do so. you can also extend or override the Spring bean definitions that control Alfresco’s Java classes.Installing and Configuring Alfresco Community Edition 3. or <web-extension> directory to extend Share.properties) file. and database driver and Hibernate properties. The system property settings are found in the following files: • <configRoot>/alfresco/repository. the location of the content and index data.33 . the file contains sample settings for running Alfresco. you need to modify the alfresco-global. Global properties The global properties alfresco-global.2 Configuring Alfresco This chapter provides information on configuring Alfresco.xml to the <extension> directory.2 . It is divided into the following sections: • Configuration overview • Customizing Alfresco Explorer • Customizing Alfresco Share • Configuring databases • Configuring core services • Configuring extended services • Alfresco subsystems • Configuring authentication • Configuring synchronization • Configuring file servers • Configuring the email server and email servivce • IMAP Protocol support • Configuring Web Content Management (WCM) Configuration overview Alfresco is preconfigured with a set of system configuration parameters. you can download the sample extension files.properties Many of the system configuration parameters are completely exposed as properties. including databases and the Alfresco core and extended services. the database connection properties. the alfresco-global. for example.properties file manually. For examples of Spring bean extensions. add or copy a Spring bean file named *-context. Installing and Configuring Alfresco Community Edition 3.properties file contains the customizations for extending Alfresco. A standard global properties file is supplied with the Alfresco installers and bundles.properties file is modified with the settings that you chose during installation. If you install Alfresco using one of the installation wizards. the location of third-party software. If you install Alfresco using one of the Tomcat bundles or the WAR file. Note: For advanced configuration. By default.

default. 5. 8. Open the <classPathRoot>\alfresco-global. browse to the $TOMCAT_HOME/shared/classes/ directory.mountPoints property as an example. Setting composite properties in the global properties file This section uses the the imap. If you do not specify a dialect.2 Modifying global properties 1.properties file. Specifies the location of the ImageMagick installation.username=alfresco db. Add your global custom configurations. Select a JDBC driver used with each connection type. For example. 7.server.exe= img. (Optional) Set the Hibernate dialect for your database.host=localhost db.root=C:/Alfresco/alf_data 4. for example when you added a new component instance but did not specify its properties. Specifies the name of the main Alfresco database user. 3. The ImapConfigMountPointsBean class that holds the component beans has four properties of its own: • beanName • store • rootPath • mode 1. use the format: <property>. Change the database connection properties. Specifies the port that the database uses. Browse to the <classPathRoot> directory. Add a root location for the storage of content binaries and index files in the dir.<component property> These values would show up. Specify the location of the following third-party software: Property ooo. 6. Specifies the password for the Alfresco database user. Hibernate will attempt to detect the dialect of your database automatically from the JDBC connection. For example.port=3306 Description Specifies the name of the database. Specifies the host where the database is located. Property db. 10. 2.password=alfresco db. for Tomcat 6. 34 . Open the alfresco-global.Installing and Configuring Alfresco Community Edition 3.properties file. 9.2 . 2.exe= Desctiption Specifies the location of the OpenOffice installation.name=alfresco db. dir.root= swf.Installing and Configuring Alfresco Community Edition 3. Save your file. Specifies the location of the SWF tools installation. Uncomment the section for the database that you require. To set some overall defaults for all component instances.root= property.

The most common use of the Java command line is in a multiple-machine environment where the basic.35 .Repository_archive.mountPoints.mountPoints. The Java command line provides an alternative method of setting the properties.properties file to the alfresco-global.2.properties file. 3. You can set any property that is specified in the alfresco-global.mode=archive Java command line All the Alfresco properties can be set using using the standard alfresco-global. Setting properties on the Java command line • Add a -Dprop=value to JAVA_OPTS or for anything that is sent to the Java command line.default.2 introduces the concept of subsystems.default.mountPoints.server.2 For example: imap. For example. When you upgrade to Enterprise Edition 3. For example.default.<component instance name>.properties configuration file.root=/alfresco/data -Ddb. an administrator is likely to configure all Alfresco installs to behave similarly by setting properties in the configuration files.Repository_virtual.2 .Repository_archive This defines that the property contains two ImapConfigMountPointsBean instances. For example: imap. There may be circumstances where it is more convenient to change properties on the fly.value. contentstore locations. To define component properties specific to each component instance.server. -Ddir.properties file.server. 4.childname} imap.2. and Hibernate. including CIFS. and CIFS domain name.mountPoints=Repository_virtual. named Repository_virtual and Repository_archive. use the format: <property>. the recommendation is that you move all your repository and database configurations from the <extension>custom-repository. To set up the imap.mode=virtual This example does not define a default for beanName because there is a way of populating it for each instance.mode=virtual imap.store=${spaces.value.server.url=xxxx.mountPoints. set the master composite property using a comma-separated list.company_home.properties file.server. common customizations are set using standard properties and the machine-specific values are set using command line options.value.2 This page describes the important changes for upgrading to AlfrescoEnterprise Edition 3.<component property> For example: imap. you should move the configuration settings for the following properties: Sample custom content and index data location property: Installing and Configuring Alfresco Community Edition 3. Because ImapConfigMountPointsBean implements the BeanNameAware Spring interface and has a beanName property. Upgrading configurations to Enterprise Edition 3. JGroups.store} imap.rootPath=/${spaces. For example.server. these instance names are automatically set as the bean names. AlfrescoEnterprise Edition 3.mountPoints. but will use the Java command line to vary settings like the database connection.mountPoints with a composite value.Installing and Configuring Alfresco Community Edition 3. Overall defaults for subsystem properties are set in the alfresco-global.server.

name= • db.exe=.root=. FTP. and NFS servers • Third-party – Owns the OpenOffice. Modifying Spring bean definition files For advanced configuration. Note: If you continue to use the custom-repository.root= Sample database connection properties: • db.properties file and the associated Spring context file custom-repository-context. For example.exe=soffice • img. you can also extend or override the Spring bean definitions that control the Alfresco Java classes in the following directories: • The <extension> directory contains the configuration files for extending Alfresco.Installing and Configuring Alfresco Community Edition 3. Subsystems are available for the following components: • Authentication – Handles the authentication-related functions with third-party authentication systems • Synchronisation – Performs synchronization of local user and group information with enterprise directories services such as LDAP • IMAP – Handles the IMAP Service • File Servers – Handles the CIFS.properties file to the alfresco-global.url= • hibernate. the settings may override those set in the alfresco-global.dialect= Also.properties file. For more information on the <extension> and <web-extension> paths.2 . Browse to the <extension> directory.2 • dir. then restart the server for the settings to take effect./ImageMagick • swf.password= • db. This new method simplifies the setup and maintenance of these systems and it also simplifies future upgrades.username= • db. refer to System paths.properties configuration.port= External locations for third-party products: • ooo.xml. SWFtools.driver= • db. When you have moved your configurations. and ImageMagick content transformers If you currently have configuration using any of these services. • The <web-extension> directory contains the configuration files for extending Alfresco Share.properties file to set your configurations. move any Hibernate settings from the custom-hibernate-dialect.properties file requiring more complex ongoing administration and maintenance and possibly leading to unexpected results. it is recommend that you move or reconfigure them using the new alfresco-global. 1.host= • db.Installing and Configuring Alfresco Community Edition 3. for Tomcat 6: • (Windows) C:\Alfresco\tomcat\shared\classes\alfresco\extension 36 ./bin/pdf2swf Database connection properties: • db. delete the custom-repository.

use the following approach. there is a risk that you will lose your changes when you next upgrade.xml This file is the starting point of the Spring configurations. The file defines some of the core system properties. This file only performs imports. 4. If you need to roll back the changes for troubleshooting.2 • (Linux) tomcat/shared/classes/alfresco/extension Each file has a copy with a . such as Firefox. Stop and restart Alfresco after each rollback. Make a copy of the default file you want to modify. <configRoot>\classes\alfresco\repository.properties).war\WEB-INF The system configuration files are maintained by Alfresco and contained in <configRoot> and <configRoot>\classes\alfresco. Before you start.37 . including a wildcard import of all classpath*:alfresco/extension/*-context. 3. 3.2 .xml Core Alfresco beans are defined here. 4. Add your configurations to the file. For more information on the <configRoot> and <configRootShare> paths. the files expand to <configRoot>. back up all your configuration files for security.xml files. and rename it. To minimize the risk. When the server starts.sample extension. Check any XML is well-formed.sample extension.properties). roll them back in the reverse sequence to which you applied them. Modifying system configuration files The system configuration files that are read by Alfresco are contained in the <configRoot> and <configRootShare> directories. Open the configuration file with the . including: • dir. Make only one logical change at one time (one logical change may mean several physical changes). The following four files represent the core of the application configuration: 1. 2. 2. Make your customization. 2. Repository system configuration files The Alfresco system configuration files are in the application WAR file. Before making further changes. If you choose to modify the system files directly. 3. refer to System paths. <configRoot>\classes\alfresco\application-context.sample extension.properties This file is imported by the repository-properties bean.root Installing and Configuring Alfresco Community Edition 3. 5. including the importing of properties using the repositoryproperties bean. For example: • Tomcat: <TOMCAT_HOME>\webapps\alfresco\WEB-INF • JBoss: <JBOSS_HOME>\server\default\tmp\deploy\tmp*alfresco-exp. Save the file without the . 1. <configRoot>\classes\alfresco\core-services-context. The preferred method of configuring Alfresco is to extend the default files using the global properties file (alfresco-global.Installing and Configuring Alfresco Community Edition 3. You can use any XML editor or you can open the file in a browser. The preferred method of configuration is to extend the system files using the global properties file (alfresco-global. test each logical change by stopping and restarting Alfresco. The path for <configRoot> is different depending on your application server.

but you should change this to your own location. • dir.auditcontentstore This folder is where the audit's content store is stored.xml.Installing and Configuring Alfresco Community Edition 3. 2.update This property controls whether the system bootstrap should create or upgrade the database schema automatically. For example. • db. • dir.OracleDriver 3. For example. The alf_data folder is where they are stored by default. Normally. Each property is defined on one line. which is in hibernate-context. <configRoot>\classes\alfresco\domain\hibernate-cfg. 4.2 . backed-up location for data storage. • update: checks and updates the database schema as appropriate • validate: checks the database schema and fails if it is not compliant 4.driver property. you only require one line: db. • db.properties This file defines Hibernate default system properties. open the alfresco-global. Customizing individual configuration items The Alfresco configuration is implemented using three types of files: • Properties files • Configuration files • Bean files Customizing properties files Properties files contain properties and end with the extension .properties file. this is the only Hibernate property that will need changing. It is relative by default. The file is imported by the hibernateConfigProperties bean. 1. The important Hibernate property is: • hibernate.dialect This alters the SQL dialect that Hibernate uses when issuing queries and updates to the database. but must point to a permanent. to override the db. Comment out all the properties you do not want to modify by adding the “#” character.hbm2ddl.jdbc. A . Save the file.properties file has no header.schema. • hibernate.indexes This folder contains all Lucene indexes and deltas against those indexes.2 This folder is where the binary content and Lucene indexes are stored.auto This determines whether Hibernate updates the database schema or just validates it. 38 . so you do not need to take any action to preserve the header. Open the file you want to customize.properties.* These are the default database connection properties.Installing and Configuring Alfresco Community Edition 3. depending on the database you are running against. Uncomment all the properties that you want to activate by removing the “#” character.driver=oracle.

Installing and Configuring Alfresco Community Edition 3. c. Copy the original <config> statement. Customize the contents of the remaining <config> tags. the following code snippet is from the <configRoot>/classes/alfresco/webclient-config.</languages> </config> 5. A configuration file contains <alfresco-config> tags outside the <config> tags. For example: <config evaluator="xx" condition= “yy” replace= “true” > Attention: Any configuration within a section marked this way completely replaces any configuration found in the Alfresco-maintained files. Delete the children you do not want. Save your customized file.. add a replace= “true” attribute to the configuration element.2 Customizing a configuration file Configuration files end with the extension . to replace the list of languages shown in the login page. such as another language. 3. Use the replace= “true” attribute. Configuration files: The configuration files contain configurations that either augment or replace the standard configuration. Open the configuration file that you want to customize. 6.xml. A typical configuration file is <extension>/web-client-config-custom. and define <config> tags. You must preserve these tags in your customized file. The other <language> items will remain enabled.xml file: <config evaluator="string-compare" condition="Languages"> <languages> <language locale="en_US">English</language> <language locale="fr_FR">French</language> </languages> </config> 2. For example. b. add the following: <config evaluator="string-compare" condition="Languages" replace="true"> Installing and Configuring Alfresco Community Edition 3. Delete each pair of <config> </config> tags that you do not want to modify. you only need a single <language> item. if you wanted Spanish in addition to English and French: <config evaluator="string-compare" condition="Languages"> <languages> <language locale="es_ES">Spanish</language> . The system configuration files are located in: <configRoot>\classes\alfresco\web-client-config-* Replacing a configuration To replace the configuration.xml.39 . To delete part of an item: a. For example.2 . 1. For example. For example. to delete French from the example in Step 1: <config evaluator="string-compare" condition="Languages" replace="true"> <languages> <language locale="en_US">English</language> </languages> </config> 4. To add another item.

the resultant bean must still have four values. see Configuring Explorer.the original four values plus the added value. However. the following overrides the publicAction property from the previous example: 40 . you need a single <language> item. to add another language. if you want to add a value.MailActionExecuter" parent="action-executer"> <property name="publicAction"> <value>true</value> <!-. 3.2 <languages> <language locale="fr_FR">French</language> <language locale="de_DE">German</language> </languages> </config> Modifying one property The attribute replace completely replaces the configuration. then the resultant bean must have five values . For example.repo.2 .alfresco. you can add the changed piece. Customizing a bean file Bean files end with the extension . You can modify <bean> tags to define properties or point to customized files. For example.action.. For example. > Important: When you override a <bean>.xml file: <bean id="mail" class="org. the overriding <bean> must contain any information from the default bean that you want to keep. For example.Installing and Configuring Alfresco Community Edition 3. You must preserve these items in your customized file. if a core bean has four values. the entire effects of the original bean are lost. Open the bean file that you want to customize. Modify the contents of the remaining <bean> tags.Installing and Configuring Alfresco Community Edition 3. There are two common uses of beans: • To define properties • To point to one or more of your customized files A typical bean file is <extension>/custom-repository-context. To modify one property. and <beans> tags outside the <bean> tags. For example. Delete each pair of <bean> </bean> tags that you do not want to modify.xml.xml and contain <bean> tags. A bean file contains <? xml> and <!DOCTYPE> headers. if you want Spanish in addition to English and German: <config evaluator="string-compare" condition="Languages"> <languages> <language locale="es_ES">Spanish</language> . as well as any additional information.setting to true --> </property> <property name="mailService"> <ref bean="mailService"></ref> </property> </bean> 2. and you want to modify a single value. The effect is the same as if you had overridden a <config> by using replace="true". the following <bean> is from the <configRoot>/classes/alfresco/actionservices-context. The other <language> items remain enabled. 1.executer. Therefore. </languages> </config> For example configurations.

xml.sample • <web-extension>/custom-slingshot-application-context. These themes are installed in the <configRootShare>\classes\alfresco\site-data\themes directory. 5.setting to false --> </property> <property name="mailService"> <ref bean="mailService"></ref> </property> </bean> 4.xml. The default theme is called default. Many of these mechanisms are provided by the underlying Surf platform.sample • <web-extension>/webscript-framework-config-custom. Add any <config> items that you want to include. Installing themes A single default theme is supplied with Alfresco.xml file in the <configRootShare> \classes\alfresco directory. 2. 4. Open the <configRootShare>\classes\alfresco\web-framework-configapplication. Change the theme definition to <theme>themeName</theme>.xml. for example. Customizing Alfresco Share This section describes how to customize Share configuration items.xml file. Locate the following theme definition: <theme>default</theme> 3.MailActionExecuter" parent="action-executer"> <property name="publicAction"> <value>false</value> <!-. Share uses the theme defined in the default directory. Share themes This section describes how to enable the default theme available in Share. Save the file.2 .action. greenTheme.Installing and Configuring Alfresco Community Edition 3. 1.2 <bean id="mail" class="org. Uncomment any <config> items that you want to enable.repo. where themeName is the directory name within the themes directory. The installation wizards install the default theme and a sample green theme. 1. therefore a knowledge of Surf is useful for anyone wishing to implement substantial customizations. A number of options are available to customize Alfresco Share. Open the following files: • <web-extension>/web-framework-config-custom. which comprises the CSS and image assets used across all pages. Note: If you do not have the green theme installed.xml. Save the edited files without the .sample 3. 2. Installing and Configuring Alfresco Community Edition 3. you can download it and unzip the green theme into the themes directory. Modify the Share configuration files in the <web-extension> directory.41 . Themes consist of a directory containing a few CSS and images files and can be located in the theme directory (<TOMCAT_HOME>/ webapps/share/WEB-INF/classes/alfresco/site-data/themes).sample extension.alfresco.executer. The theme in use is defined in the web-framework-config-application.

The new theme is displayed in Share. Save the files.css 4. presentation. replace or add images to the /images directory. However. 1. stop and restart the server. as well as the corresponding XML file. Specify the new theme by searching for . Open the following files: a. an image directory.css file. 3. Locate the properties at the end of the presentation.2 4.css file. background-color d.theme-color-1:visited.theme-color-1. colour b. Copy the contents of the greenTheme directory to the new theme directory.yui-skin-greenTheme and replacing with . Make a new directory within the /themes directory.css b. which is not always practical. background c. ie6.2 .theme-color-1:hover { color: #6CA5CE. Edit the following four properties: a. this requires you to restart the server. whose name must match that of the theme's directory. Note: The theme change does not persist between new page reloads to different sections of Share.yuiskin-XXX where XXX is the name of the new theme directory. and a directory for assets for YUI. 5. / Theme colors / . Save the file. If the URL has a ? in it already. 1. if required. To change themes temporarily within any part of the site. border Any change to these properties will change the theme.css file and.css d. for example &theme=XXX).theme-color-1.css e.Installing and Configuring Alfresco Community Edition 3. use & instead. a. where XXX is the name of the theme to which you wish to switch. 3. ie7. Creating a new theme Additional themes may be defined by creating a new theme directory containing the necessary files. 42 . add ?theme=XXX to the URL. a. 2. it is often desirable to look at Share running with the default theme in order to compare certain sections between themes. 5. Open the presentation.css c. yui/assets/skin. Editing a theme A theme consists of some CSS files. base. When developing a theme. a. you need to change the presentation. In order to create a new look. 2. If the server is running.Installing and Configuring Alfresco Community Edition 3. Note: Do not include spaces in the directory name.

a.png).theme-color-2:hover { color: #038603.theme-color-2:visited. div.theme-color-3.2 } .theme-bg-color-4. a.theme-color-3:hover { color: #C7DBEB.theme-bg-color-3. div. a.theme-bg-color-3 { background-color: #DEE8ED.theme-bg-1 { / background-image: url(images/navbar-bg. } . } .2 .theme-bg-color-1 { background-color: #6CA5CE. a.theme-bg-color-5 { background-color: #2B6EB5. a.theme-color-2.theme-color-3:visited. a.theme-bg-color-2 { background-color: #fffbdd.theme-color-4:hover { color: #0D3B57.theme-bg-color-1.theme-bg-color-2.theme-color-4. } / Theme background colors / . a. } . div. } . div. } .theme-color-4:visited.43 .theme-bg-color-5.theme-bg-color-4 { background-color: #EBEFF1. } . a.theme-color-2. a.theme-color-4. / } Installing and Configuring Alfresco Community Edition 3. div. } .Installing and Configuring Alfresco Community Edition 3.theme-color-3.

The content of the form is completely driven from configuration custom types.theme-border-2 { border-color: #2B6EB5. Use of forms in Share Forms are used in the View Metadata and Edit Metadata pages within Share.Installing and Configuring Alfresco Community Edition 3. 5. meaning that Alfresco uses only one configuration syntax and one set of UI controls for forms. This section allows changes to the YUI components.theme-bg-2 { / background-image: url(images/navbar-bg-2. custom aspects. Locate the YUI Theme Changes section. Both DM (Document Management) and WCM (Web Content Management) forms use the same services. built on the Surf framework. } . / } / Theme border type/colors / .theme-border-1 { border-color: #457f63.2 .Installing and Configuring Alfresco Community Edition 3. border-style: dotted. The following screen shot shows the form component on the Edit Metadata page. Their properties and associations can be displayed within Share.png). This framework provides a convention for implementing forms. Edit the properties in this section to change the theme. Forms Alfresco presents data view and entry forms throughout its user interface.2 . Forms architecture The forms engine consists of four major parts: 44 . } 4.

as the user types or when a field loses focus). lightweight JavaScript library.2 . The forms runtime is responsible for the execution of a form. which includes the forms runtime The following diagram shows a high-level architecture diagram of the forms engine. submission. It manages all input.2 • Form service • Form component • Form configuration • JavaScript formUI component. An unobtrusive JavaScript pattern is used. The forms runtime provides the following capabilities: • Mandatory property handling • Validation (enforceable at submission.Installing and Configuring Alfresco Community Edition 3. and it consists of a small.45 . where behavior is added to the HTML form elements when the page loads. events. which includes: • Regular expression matching • String length • Email address • Is number • Numeric range • Date range • List of values Installing and Configuring Alfresco Community Edition 3. validation (client or call-back).

When the user interacts with the form. The form service looks for a form processor that can process the kind of item. 46 . 10. the following sequence of events occurs. 1. 2. The form component Freemarker template iterates around the fields and includes the relevant controls. The form component receives the result from the form service and combines it with the form configuration to produce the form UI model.Installing and Configuring Alfresco Community Edition 3. the form is ready for the user to interact. The form component retrieves the list of fields to display (if any) and requests a form definition for those fields and the item from the form service via its REST API. 2.2 . The REST API takes the result from the form processor/form service and constructs the form definition JSON response. The form processor executes any registered filters before and after the main processing. refer to Forms appendix At this point. The form service looks for a form processor that can process the kind of item. 9. the forms runtime constantly checks the validation rules enabling and disabling the Submit button appropriately. The form component looks up the form configuration for the item being requested. The following parameters are available: • compactMode: Determines whether the picker will be shown in compact mode • showTargetLink: Determines whether a link to the document details page will be rendered to content items category. 8. association. 5. 7. 6. The form processor is asked to persist the form data.ftl The association control is used to allow objects in the repository to be picked and ultimately associated with the node being edited. The browser submits the form by calling the REST API. The following controls are available.ObjectPicker component to allow the user to browse the repository and pick objects. 4.Installing and Configuring Alfresco Community Edition 3. 1. The form processor executes any registered filters before and after the main processing. 3. 3. The browser receives the response and processes it appropriately. The form processor is asked to generate a form definition. The REST API takes the result from the form processor/form service and constructs the JSON response. The FormUI JavaScript instantiates the forms runtime and registers all validation handlers.ftl The category control is used to allow the user to select categories for the node being edited. 4. and each field has a control and an optional set of parameters. For a description of the available form controls. The control uses the JavaScript Alfresco.2 • Repeating fields (for handling multi-valued properties) Forms event sequence When a request is made to a page containing the form component. The control uses the JavaScript Alfresco. The form component Freemarker template instantiates the FormUI JavaScript component. Form controls Controls are represented by a Freemarker template snippet. the following sequence of events occurs. When the user submits the form. 5.ObjectPicker component to allow the user to browse the category hierarchy. 6.

if omitted the field.ftl The checkbox control renders a standard HTML check box control. • size: The size of the list.ftl The invisible control renders nothing at all.ftl The date control renders a date field allowing free form entry of dates. how many options are always visible • styleClass: Allows a custom CSS class to be applied to the select list size. mimetype.ftl The selectone control renders a standard HTML select list.ftl The size control renders a read only human readable representation of the content size. The following parameters are available: • property: The name of a content property to retrieve the current mime type from.ftl The textarea control renders a standard HTML text area field. This control has no parameters.Second|2.Installing and Configuring Alfresco Community Edition 3.value value is used textarea. The following parameters are available: • showTime: Determines whether the time entry field should be displayed encoding.2 . The following parameters are available: • styleClass: Allows a custom CSS class to be applied to the check box date. If a value for an option also needs to be specified.ftl The encoding control renders a selectable list of encodings.value value is used • styleClass: Allows a custom CSS class to be applied to the select list invisible. The following parameters are available: • property: The name of a content property to retrieve the current content size from.Third". The following parameters are available: • dataTypeParameters: A JSON object representing the period definitions to show in the list selectone. If appropriate a time field is also rendered. for example "First. The following parameters are available: • rows: The number of rows the text area will have • columns: The number of columns the text area will have Installing and Configuring Alfresco Community Edition 3. use the "First|1. The following parameters are available: • property: The name of a content property to retrieve the current encoding from. it can be used when a form definition needs to be requested and returned but not displayed. if omitted the field. The following parameters are available: • options: A comma separated list of options to display.ftl The period control renders a selectable list of periods and an expression entry field.2 The following parameters are available: • compactMode: Determines whether the picker will be shown in compact mode checkbox.value value is used • styleClass: Allows a custom CSS class to be applied to the select list period. if omitted the field.Third|3" format.Second. as well as a calendar widget allowing dates to be selected visually. that is.47 .ftl The mimetype control renders a selectable list of mime types.

by default. Open the <web-extension>\share-config-custom. Save the file. meaning that control templates can be re-used. If the path value should be a relative path. the 48 . In order for valid XHTML code to be generated. The XML syntax is described as follows: default-controls The type element defines what control to use. However.2 • styleClass: Allows a custom CSS class to be applied to the text area textfield. and so on. it is looked up relative to the alfresco/web-extension/site-webscripts package. 1. The following parameters are available: • styleClass: Allows a custom CSS class to be applied to the text field • maxLength: Defines the maximum number of characters the user can enter • size: Defines the size of of the text field Configuring forms The default system forms are specified in the <configRootShare>\classes\alfresco\webframework-config-commons. the message and message-id attributes provide a way to override this message. The name attribute contains the prefix form of the data type.xml. it is relative from the alfresco package. There are several files that can be used to hold the configurations. 2. The template attribute specifies the path to the template snippet to use to represent the field. Forms configuration syntax The share-config-custom. 3. keyup. dependencies The dependencies element defines the list of JavaScript and CSS files required by any custom controls being used in the application. the validation messages are not shown (the Submit button is enabled/disabled). This file contains all the default controls and constraint handlers for the Alfresco content model and the form configuration for the cm:content and cm:folder types. for example LIST.xml These files are loaded by SURF and therefore any configuration to the forms will affect all SURF-based applications. blur. for example: • <web-extension>\webscript-framework-config-custom.xml file. The validation-handler attribute represents the name of a JavaScript function that gets called when the field value needs to be validated. This will be a standard DOM event. If the path value is absolute. constraint-handlers The constraint element defines what JavaScript function to use to check that fields with constraints are valid before being submitted. The control-param element provides a mechanism to pass parameters to control templates. for example d:text. normally found in the application server shared classes location.Installing and Configuring Alfresco Community Edition 3. you can use a custom configuration file named share-config-custom.xml • <web-extension>\web-framework-config-custom. To ensure that the configurations you make to forms affect only the share application. The id attribute is the unique identifier given to the model constraint in the Alfresco content model.ftl The textfield control renders a standard HTML text field.Installing and Configuring Alfresco Community Edition 3. for each type defined in the Alfresco content model. Modify the forms configuration settings using the XML configuration syntax. The event attribute defines what event will cause the validation handler to get called.xml file uses an XML configuration syntax. that is.xml file. This file also contains an example of configuring the cm:content type. You should apply all your forms customizations to a custom configuration file. The validation handler called usually has a default message to display when validation fails.2 .

and by default they may not be returned by the server. the field-visibility element is effectively ignored and therefore does not have to be present. If this element is present. If the form element exists within a config element without an evaluator and condition. If this element is present. The template attribute specifies the path to the template to be used when the form is in view mode. and create. the field will appear in all modes. which is relative to the alfresco/webextension/site-webscripts package. The id attribute represents the unique identifier for a field. the for-mode attribute would contain view. for example. to only show a field in view and edit modes. The id attribute represents the unique identifier for a field. The submission-url allows the action attribute of the generated form to be overridden so that the contents of the form can be submitted to any arbitrary URL. The force attribute can be used to indicate to the form service that it should do everything it can to find and return a definition for the field.edit. edit. There are fields that may be optional for an item. The value is usually an absolute path.2 . the field-visibility element is effectively ignored and therefore does not have to be present. The value is usually an absolute path.Installing and Configuring Alfresco Community Edition 3. field-visibility The field-visibility element defines which fields are going to appear on the form. view-form The view-form element allows the default template that auto generates the form UI to be overridden. The optional id attribute allows an identifier to be associated with the form.49 . if the aspect is not applied to the node. The template attribute specifies the path to the template to be used when the form is in edit mode. The optional for-mode attribute indicates when the field should appear. hide The hide element normally comes into play when multiple configuration files are combined as it can be used to hide fields previously configured to be shown. The template attribute specifies the path to the template to be used when the form is in create mode. the path should be an absolute path from the root of the web application (but not including the web application context).2 dependencies need to be known ahead of time so the relevant links can be generated in the HTML head section. form The form element represents a form to display. The value is usually an absolute path. which is relative to the alfresco/webextension/site-webscripts package. If this element is present. Valid values for the attribute are view. the field-visibility element is effectively ignored and therefore does not have to be present. If present. it would indicate that server needs to try and find the property on an aspect in the content model. If the form element exists within a config element that provides an evaluator and condition. normally found in the application server shared classes location. The src attribute of both the JavaScript and CSS elements contains the path to the resource. unless a custom template is used. create-form The create-form element allows the default template that auto generates the form UI to be overridden. For example. the field will only appear for the modes listed. show The show element specifies a field that should appear on the form. the form will only be found if the item being requested matches the condition. which is relative to the alfresco/webextension/site-webscripts package. a field definition for the property will not be returned If force is true. edit-form The edit-form element allows the default template that auto generates the form UI to be overridden. normally found in the application server shared classes location. If the attribute is not specified. the form is always found. for example cm:name that should not be displayed. cm:name. normally found in the application server shared classes location. thus allowing multiple forms to be defined for the same item. An example might be a property defined on an aspect. The optional for-mode Installing and Configuring Alfresco Community Edition 3.

this is taken as a signal that all field visibility is to be manually configured. The appearance attribute specifies how the set will be rendered. Currently. d. The label and label-id attributes define the label to be used for the form. the set identifier is used. the optional set attribute contains the identifier of a previously defined set. hide it in other modes. and the value should reference a valid set definition. the separation allows the appearance to be defined for fields that are not explicitly mentioned within the field-visibility element.Installing and Configuring Alfresco Community Edition 3. and although it maybe slightly more verbose. The only mandatory attribute is id. the only supported and allowed values are fieldset and panel. as follows: a. field The field element allows most aspects of a field's appearance to be controlled from the label to the control that should be used. If present. edit. For example. set The optional set element provides the basis of creating groups of fields. which specifies the field to be customized. the set will not be rendered. Finally. the field identifier does not have to be present within the field-visibility element. However. previously defined. If there is no field-visibility configuration (show or hide tags) then all fields are visible in all modes. If neither is present. have an implicit element. Show or hide rules. appearance The optional appearance element controls the look and feel of the controls that make up the form. the field will never appear.2 . b. The label and label-id attributes provide the title for the set when it is rendered. If present. If an appearance attribute is not supplied. If neither are supplied. The default set will be displayed with a label of Default. All other fields remain visible as before. the description returned from the Form Service is used (this could also be empty).edit. Valid values for the attribute are view. c. with later rules potentially invalidating previous rules. e. to hide a field in view and edit modes. which only apply for specified modes.Installing and Configuring Alfresco Community Edition 3. this element will be processed and the information available to custom templates defined with the view-form. the template attribute specifies the path to the template snippet to use to represent the 50 . If the attribute is omitted. the field belongs to the default set. At that point. If the attribute is not specified. the field label returned from the Form Service is used. If neither attribute is present. A default set with an identidier of "" (empty string) is always present. For example. If there are one or more hide tags then the specified field(s) will be hidden in the specified modes. the field will be hidden for the modes listed. The id attribute gives the set a unique identifier that other set definitions and fields can refer to. and any fields without an explicit set membership automatically belong to the default set. it is up to those templates whether they use the available data. Unlike the field-visibility element. The description and description-id attributes are used to display a tool tip for the field. and create. <show id="name" for-mode="view"/> would show the name field in view mode and by implication. The read-only attribute indicates to the form UI generation template that the field should never be shown in an editable form. Show and hide rules will be applied in sequence.2 attribute indicates in which modes the field should not appear. As soon as a single show tag appears in the configuration XML. control The control element allows the control being used for the field to be configured or customized. The parent attribute allows sets to be nested. all fields default to hidden and only those explicitly configured to be shown (with a show tag) will be shown. the for-mode attribute would contain view. edit-form and create-form elements. The algorithm for determining whether a particular field will be shown or hidden works. The configuration of what fields are present and how they appear has been separated to provide the maximum flexibility.

Each attribute effectively overrides the equivalent attribute. If there are multiple forms on the page containing the same field this identifier will not be unique. mandatory : true disabled : false. The model for the template includes the field and form being generated.51 . If the disabled property is set to true. as this is guaranteed to be unique for the page. If the path value is relative. A control is the label for a field and the interface that the user interacts with for setting the value of the field. <#if form. Customizing forms The following sections describe examples of how to customize forms. template : "controls/textfield. The model property fieldHtmlId should be used as the identifier for the control. The structure of the field object is shown. The control-param sub-elements provide a mechanism to pass parameters to control templates. The state of the disabled property must always be adhered to when implementing controls as this is driven from the field definition returned from the FormService and from the read-only attribute in the form configuration. control: { params: {}. normally found in the application server shared classes location. in the following: { kind : "field". using the cm:name property as an example. dataType : "d:text". value : "plain-content. The form mode can be retrieved from the form. description : "Name". If the path value is absolute. configName : "cm:name". The main purpose of this element is to allow aspects of the constraint to be overridden for a particular field. id : "prop_cm_name". The control is also responsible for rendering an appropriate UI representation for the mode the form is currently in. respectively. represented by a field and form object. it is looked up relative to the <web-extension>/ site-webscripts package.2 field overriding the default-control template. A control is a Freemarker template snippet that includes the markup to define the control. type : "property". it is relative from the alfresco package.mode property. name : "prop_cm_name".Installing and Configuring Alfresco Community Edition 3.txt". the control should never allow the value to be edited. label : "Name". A pattern used by most the out-of-the-box controls is shown below. Customizing forms controls: One of the most common customization is to add new controls.ftl" } } Although the id property provides a unique identifier for the field it is only scoped to the current form. dataKeyName : "prop_cm_name". repeating : false.mode == "view"> Installing and Configuring Alfresco Community Edition 3. constraint-handlers The constraint sub-elements define the JavaScript function to use for checking that fields with constraints are valid before being submitted. This template could either be the one defined locally or the template defined in the defaultcontrol element for the data type of the field.2 .

Displaying Type metadata: The configuration to define the fields for the cm:content type exists in the system file called webframework-config-commons. date.2 . * * @param field {object} The element representing the field the validation is for * @param args {object} Object containing arguments for the handler * @param event {object} The event that caused this handler to be called. The structure of the args parameter is dependent on the handler being implemented. maybe null * @static */ function handler-name(field.Installing and Configuring Alfresco Community Edition 3. maybe null * @param form {object} The forms runtime class instance the field is being managed by * @param silent {boolean} Determines whether the user should be informed upon failure * @param message {string} Message to display when validation fails. The handler is responsible for taking the value from the field and uses the args parameter to calculate whether the current value is valid or not. form. Alfresco. Configure the type metadata in the share-config-custom. that is. /** * Validation handler for a field. returning true if it is valid and false if it is not.xml file in <web-extension>. and so on. silent.. event. Customizing the validation handler: A validation handler is a small JavaScript function that gets called by the forms runtime when a field value needs to be validated. The following snippet shows the forms definition in the share-config-custom. The interface for a validation handler is shown below. so that the value property can be accessed. this usually requires a hidden form field..forms. period. </#if> The final rule for controls is that they must supply the field current value in a DOM element that has a value property and the id property set to the value of fieldHtmlId Freemarker variable. which is normally an HTML input DOM element.xml file.Installing and Configuring Alfresco Community Edition 3..validation. silent. args. event.xml. association. For advanced controls.mandatory = function mandatory(field.2 // view representation goes here. message) The definition of the built in "mandatory" validation handler is shown below.. args. message) The field parameter is usually the HTML DOM element representing the field's value. <#else> // edit and create representation goes here. <config evaluator="node-type" condition="cm:content"> <forms> <form> <field-visibility> <show id="cm:name" /> <show id="cm:title" force="true" /> <show id="cm:description" force="true" /> <show id="mimetype" /> <show id="cm:author" force="true" /> <show id="size" for-mode="view" /> <show id="cm:creator" for-mode="view" /> <show id="cm:created" for-mode="view" /> <show id="cm:modifier" for-mode="view" /> <show id="cm:modified" for-mode="view" /> 52 . form. By default. these will be the parameters of the constraint defined on the field.

4. whereas the cm:creator. Add more fields to the default configuration. and cm:modified properties are visible in view mode only. The force attribute forces the NodeFormProcessor to search the entire Alfresco content model for the property or association definition before returning anything. The NodeFormProcessor knows about these properties and generates a field definition to represent them so that they will appear in the forms. <config evaluator="node-type" condition="my:example"> <forms> <form> <field-visibility> <show id="my:text" /> <show id="my:dateTime" /> <show id="my:association" /> </field-visibility> </form> </forms> </config> 3.Installing and Configuring Alfresco Community Edition 3.2 </field-visibility> </form> </forms> </config> The configuration defines that the cm:name property is visible in all modes. <config evaluator="node-type" condition="cm:content"> <forms> <form> <appearance> <field id="cm:description"> <control> <control-param name="rows">20</value> <control-param name="columns">20</value> </control> </field> </appearance> </form> </forms> </config> Note: The full prefix version of the type is required in the condition attribute. The following example configuration shows the my:text.xml file. Installing and Configuring Alfresco Community Edition 3.xml file. The aspects that appear can be defined on a type by type basis. Save your file. 2. 1. Open the <web-extension>/share-config-custom. cm:modifier. Open the <web-extension>\share-config-custom. 1. Enter the configuration for custom types. The mimetype and size properties are known as transient properties because they do not exist as properties in the model.2 . These properties are formed from the cm:content property. my:dateTime and my:association properties being configured for the custom my:example type. and you can control the ordering of the fields. Displaying aspect metadata: Add the properties and associations defined on aspects by adding them to the list of fields to show for a type. The following example shows how to show the node's DBID property for all cm:content nodes.53 . The force attribute ensures that the NodeFormProcessor searches the entire Alfresco content model for the property or association definition before returning anything. cm:created.

which allow some basic customization. Save the file.2 2. Open the <web-extension>\share-config-custom.fields from my example aspect --> <show id="my:aspectProperty" /> <show id="my:aspectAssociation" /> </field-visibility> </form> </forms> </config> 4. 2. Change the number of rows and columns used for the textarea control that the cm:description field uses by default.Installing and Configuring Alfresco Community Edition 3. <config evaluator="node-type" condition="cm:content"> <forms> <form> <field-visibility> <show id="cm:name" /> <show id="cm:title" force="true" /> <show id="cm:description" force="true" /> <show id="mimetype" /> <show id="cm:author" force="true" /> <show id="size" for-mode="view" /> <show id="cm:creator" for-mode="view" /> <show id="cm:created" for-mode="view" /> <show id="cm:modifier" for-mode="view" /> <show id="cm:modified" for-mode="view" /> <!-.2 .xml file.cm:effectivity aspect --> <show id="cm:from"/> <show id="cm:to"/> </field-visibility> </form> </forms> </config> 3. <config evaluator="node-type" condition="cm:content"> <forms> <form> <appearance> <field id="cm:description"> <control> <control-param name="rows">20</value> <control-param name="columns">80</value> </control> </field> </appearance> 54 . 1. <config evaluator="node-type" condition="cm:content"> <forms> <form> <field-visibility> <!-. The following example configuration shows the cm:from and cm:to properties for the cm:effectivity aspect.Installing and Configuring Alfresco Community Edition 3. The following example shows how to add the fields of an example aspect to all forms for the cm:content type. Add custom aspects to the default configuration by overriding the configuration. Enter the configuration for custom types. Configuring a form control: Most of the built in controls have parameters.

2 </form> </forms> </config> 3. Grouping fields: For longer forms. 1. For example: <config evaluator="node-type" condition="cm:content"> <forms> <default-controls> <type name="d:mltext"> <control-param name="rows">20</control-param> <control-param name="columns">80</control-param> </type> </default-controls> </forms> </config> 4. The following example configuration shows how to group some fields from an imaginary custom my:example type. Open the <web-extension>\share-config-custom. configure the control in the default-controls element. <config evaluator="model-type" condition="my:example"> <forms> <form> <field-visibility> <show id="cm:name" /> <show id="my:text" /> <show id="my:mltext" /> <show id="my:boolean" /> <show id="my:int" /> <show id="my:long" /> <show id="my:double" /> <show id="my:float" /> <show id="my:status" /> <show id="my:restricted-string" /> <show id="my:date" /> <show id="my:dateTime" /> </field-visibility> <appearance> <set id="text" appearance="fieldset" label="Text Fields" /> <set id="number" appearance="panel" label="Number Fields" /> <set id="date" appearance="fieldset" label="Date Fields" /> <field <field <field <field <field <field <field <field id="cm:name" set="text" /> id="my:text" set="text" /> id="my:mltext" set="text" /> id="my:boolean" set="text" /> id="my:int" set="number" /> id="my:long" set="number" /> id="my:double" set="number" /> id="my:float" set="number" /> <field id="my:date" set="date" /> <field id="my:dateTime" set="date" /> </appearance> Installing and Configuring Alfresco Community Edition 3.55 . you can group fields together in logical grouped or nested sections. Enter the configuration for custom types. Save the file. If all textarea controls in the application need to have these settings.xml file.Installing and Configuring Alfresco Community Edition 3. 2.2 .

The following example configuration shows the fields of the my:example type in a nested set. Open the <web-extension>\share-config-custom. To specify a different label. <set id="" appearance="panel" label="General" /> You can also use a message bundle key.2 . The appearance of the default set can be controlled in the same way as other sets. 56 . Changing the default set label: Fields that do not specify a set belong to the implicit default set. <set id="" appearance="panel" /> This will render a panel around all the fields with a label of Default. 2. <config evaluator="model-type" condition="my:example"> <forms> <form> <field-visibility> <show id="cm:name" /> <show id="my:text" /> <show id="my:mltext" /> <show id="my:boolean" /> <show id="my:int" /> <show id="my:long" /> <show id="my:double" /> <show id="my:float" /> </field-visibility> <appearance> <set id="builtin" appearance="fieldset" label="Built In" /> <set id="custom" appearance="fieldset" label="Custom Data" /> <set id="text" parent="custom" appearance="panel" label="Text" /> <set id="number" parent="custom" appearance="panel" label="Numbers" /> <field id="cm:name" set="builtin" /> <field id="my:text" set="text" /> <field id="my:mltext" set="text" /> <field id="my:boolean" set="text" /> <field id="my:int" set="number" /> <field id="my:long" set="number" /> <field id="my:double" set="number" /> <field id="my:float" set="number" /> </appearance> </form> </forms> </config> 3. but without any visual grouping. Save the file. For example. Enter the configurations for the set label. for example. <set id="" appearance="panel" label-id="form. by default. Use the parent attribute in the set element. add the label attribute.xml file.set.2 </form> </forms> </config> Nested sets are also supported. They are rendered together. Save the file.Installing and Configuring Alfresco Community Edition 3. 1. the following label will be General. using an identifier of an empty string.general" /> 3.Installing and Configuring Alfresco Community Edition 3.

however.value}" style="background-color: green." <#if field. color: white. forms are rendered with the field labels positioned above the input control. The templates need to be stored in the site-webscripts directory. with a file name of my-textfield.mode == "view"> <div class="viewmode-field"> <span class="viewmode-label">${field.ftl" /> </field> </appearance> </form> </forms> </config> Changing the field label position: By default. width: 700px. • The following example configuration shows a very simple custom text field control that always displays with a green background. therefore.label?html}:<#if field. you can add new controls and reference them. which will usually be in the application server shared classpath.2 Providing a custom form control: If none of the out-of-the-box controls are sufficient.name}" value="${field.mandatory><span class="mandatory-indicator">*</span></#if></label> <input id="${fieldHtmlId}" type="text" name="${field. Controls are Freemarker template snippets. white text. <config evaluator="node-type" condition="cm:content"> <forms> <form> <appearance> <field id="cm:name"> <control template="/my-textfield.Installing and Configuring Alfresco Community Edition 3.value?html}</span> </div> <#else> <label for="${fieldHtmlId}">${field. they contain only the HTML markup required to represent the control.2 .label?html}:</span> <span class="viewmode-value">${field. Installing and Configuring Alfresco Community Edition 3.57 . For a production system. and 700 pixels wide. this example shows a hard coded style.ftl. <div class="form-field"> <#if form.disabled>disabled="true"</#if> /> </#if> </div> • The following example configuration shows this control being used for the cm:name property. use a CSS class.

Control dependencies can be provided via custom configuration. Add the following configuration: <config> <forms> <dependencies> <css src="/custom/forms/custom-label-layout. text-align: right. To enable these scenarios.css file. A different template can be provided for each form mode. which is usually be in the application server shared classpath.Installing and Configuring Alfresco Community Edition 3. margin-right: 1em.2 . Store the custom templates in the site-webscripts directory. the following CSS should be present in the custom-label-layout.4em. To move the labels to the left of the input control.form-container label { display: inline. float: left. There are scenarios where more control may be required over the layout. 1. <config evaluator="node-type" condition="cm:content"> <forms> <form> <edit-form template="/2-column-edit-form. Add the custom CSS in the custom-label-layout. 2.css" /> </dependencies> </forms> </config> 3. 1. width: 6em. Save the file.Installing and Configuring Alfresco Community Edition 3. it is possible to replace the default template with a custom template. margin-top: 0. } 4. provide a custom CSS to override the default style rules.css file: . The example below shows the Edit form for the standard cm:content type being configured to render with two columns of fields.2 To change this layout. located in the /custom/forms directory within the web application.ftl" /> </form> </forms> </config> 58 . The result of this customization is shown as: Providing a custom form template: The default template that renders the form UI generates one column of fields.

htmlid + "-form"> <#assign formUI><#if args. It uses some of the Freemarker macros available in form.showCaption> <div id="${formId}-caption" class="caption"><span class="mandatoryindicator">*</span>${msg("form.kind == "set"> <@renderSetWithColumns set=item /> <#else> <@formLib.appearance?exists> <#if set.ftl" as formLib /> <#if error?exists> <div class="error">${error}</div> <#elseif form?exists> <#assign formId=args.ftl file.mode != "view"> <form id="${formId}" method="${form.label}</legend> <#elseif set.Installing and Configuring Alfresco Community Edition 3.renderField field=item /> </#if> </#list> </div> <#if form.renderFormsRuntime formId=formId /> </#if> <div id="${formId}-container" class="form-container"> <#if form.ftl is available in the distribution in the samples folder.formUI}<#else>true</#if></#assign> <#if formUI == "true"> <@formLib.formUI??>${args.submissionUrl}"> </#if> <div id="${formId}-fields" class="form-fields"> <#list form.required.2 The example template 2-column-edit-form.fields")}</div> </#if> <#if form.renderFormButtons formId=formId /> </form> </#if> </div> </#if> <#macro renderSetWithColumns set> <#if set. <#import "/org/alfresco/components/form/form. The following example shows the contents of the 2-column-edit-form.items as item> <#if item.mode != "view"> <@formLib.lib.label}</div> <div class="form-panel-body"> </#if> </#if> Installing and Configuring Alfresco Community Edition 3.appearance == "panel"> <div class="form-panel"> <div class="form-panel-heading">${set.method}" accept-charset="utf-8" enctype="${form.enctype}" action="${form.lib.ftl but supplies its own renderSetWithColumns macro to render the HTML required to create the grid using the YUI grid CSS capabilities.showCaption?exists && form.59 .appearance == "fieldset"> <fieldset><legend>${set.2 .

sample file. on Tomcat. the Edit Metadata page for a cm:content type in Share has the following appearance.2 .xml file. a. The Explorer configuration file is called web-client-config-custom. Open the META-INF\web-client-config-custom.sample extension. a. Uncomment any <config> items that you want to enable.xml. Uncomment any <config> items that you want to enable.Installing and Configuring Alfresco Community Edition 3.children as item> <#if item. the META-INF directory is in $TOMCAT_HOME\webapps\alfresco \. • Modify the Explorer configuration file in the <extension> directory.xml. Save the file without the .2 <#list set.Installing and Configuring Alfresco Community Edition 3.renderField field=item /> </div> <#if ((item_index % 2) != 0) || !item_has_next></div></#if> </#if> </#list> <#if set. Customizing Alfresco Explorer There are several different ways that you can customize the Explorer configuration items.appearance == "panel"> </div> </div> </#if> </#if> </#macro> 2.kind == "set"> <@renderSetWithColumns set=item /> <#else> <#if (item_index % 2) == 0> <div class="yui-g"><div class="yui-u first"> <#else> <div class="yui-u"> </#if> <@formLib. b. b. When the configuration and template is in place. 60 . c. Open the <extension>\web-client-config-custom. c. Save the file. For example. • Modify the Explorer configuration file in the META-INF directory of a JAR file.appearance?exists> <#if set.appearance == "fieldset"> </fieldset> <#elseif set.

Move the custom JAR file into the WEB-INF\lib directory. For example. a. Set to true to remove the administrator action from the Administration Console.xml file. Locate the <alfresco-config> section. The configuration settings are activated using the <extension>\web-client-config-custom. Open the module-context. b.web.xml file.xml</value> </list> </property> </bean> c.2 . Open the <extension>\web-client-config-custom.xml file. Open the web-client-config-custom. • Modify the Explorer configurations within an AMP file.alfresco. the breadcrumbs in Explorer show the history based on where you have visited. 1. a. b. 2. Save the file. Use this method to package the Explorer customizations together with any Java classes you have as part of an extension. Alfresco Explorer configuration settings This section describes some of the configuration settings that can be used to modify the behavior of Alfresco Explorer.Installing and Configuring Alfresco Community Edition 3.2 d.WebClientConfigBootstrap" init-method="init"> <property name="configs"> <list> <value>classpath:alfresco/module/myModuleId/my-web-clientcustom. Set to true to prevent empty (zero byte) files from being uploaded.xml file. This means that you do not have to restart the server and applies versions to the configuration changes. By default. c.61 . Add your preferred settings to configure Alfresco Explorer. Set to true to prevent users from changing their passwords or configuring their person settings.config. • Modify the Explorer configuration file in the repository. Sets the default path-based view to a location-based view. d. Add the following bean definition: <bean id="myModule_configBootstrap" class="org. Save the file. This Installing and Configuring Alfresco Community Edition 3. Use this method to edit a file directly in the repository and then to reload it using the Explorer. Uncomment any <config> items that you want to enable. Browse to the following space: Company Home > Data Dictionary > Web Client Extensions. 3. you can set the following: Property <language-select>false</languageselect> <user-group-admin>false</user-groupadmin> <allow-user-config>false</allow-userconfig> <zero-byte-file-upload>false</zerobyte-file-upload> <breadcrumb-mode>location</breadcrumbmode> Description Set to true to enable automatic language selection from the browser locale.

Modify the configuration settings within the <alfresco-config> section. Remove the “#” sign from the beginning of each line for the database you want to activate. 62 .Installing and Configuring Alfresco Community Edition 3. The database connector allows MySQL database to talk to the Alfresco server. Overriding database connection properties This section describes how to override the database properties. Lines in these files are commented (begins with the “#” sign). Note: If you installed Alfresco using one of the installation wizards. the MySQL database connector is already in the correct directory. Save the file. 2.do not allow users to configure their person settings or change password --> <allow-user-config>false</allow-user-config> <!-.2 . Installing a MySQL database connector.do not display User/Group admin console pages --> <user-group-admin>false</user-group-admin> <!-.do not allow empty files to be uploaded --> <zero-byte-file-upload>false</zero-byte-file-upload> <!-. Configuring a MySQL database Setting up the MySQL database to work with Alfresco involves the following tasks: 1. Save the file.2 will show the full path to a space rather than a visit history. this section describes the configuration that you should use. Configuring the MySQL database connection. Note: Some of the Alfresco installation wizards install an embedded instance of MySQL that is configured with the correct settings. Installing a MySQL database connector The MySQL database connector is required when installing Alfresco with MySQL. Configuring databases This section describes how to configure supported databases for use with Alfresco. If you prefer to use your own instance of MySQL. 3.Installing and Configuring Alfresco Community Edition 3. For example. 2. Type a "#" at the beginning of each line for the database you want to deactivate.set location-based view for breadcrumb --> <breadcrumb-mode>location</breadcrumb-mode> </client> </config> </alfresco-config> 4. 1. 4. the <alfresco-config> setting is as follows: <alfresco-config> <config> <client> <!-. 3.pickup language automatically from browser locale --> <language-select>false</language-select> <!-. Open the <classPathRoot>\alfresco-global. 5. Creating the Alfresco database.properties file.

Browse to the MySQL data directory.2 1. Open a command prompt. the Alfresco database is already created for you. 8. Edit the line with an absolute path to point to the directory in which you want to store Alfresco data. Type the following: • (Windows) db_setup. type show databases. 9. You have now created the Alfresco database. including one named alfresco. 1.tar. 2. To replace the default database configuration for the MySQL (or other) database. Press ENTER. At the mysql> prompt. 4./alf_data 3. The next step is to create the Alfresco MySQL database.host}:${db. 6. type admin or the password you used to install MySQL. Open the alfresco-global. The MySQL connector is installed.port}/${db.url=jdbc:mysql://${db. To verify the database.com/ 2.properties file.x.gz file: mysql-connector-java-5. For example: dir.x. To check that the database is created correctly. Note: If you installed Alfresco using one of the installation wizards. If you receive an error message. At the Enter Password prompt.mysql. and verify the Alfresco folder exists.x-bin.63 . Installing and Configuring Alfresco Community Edition 3. Configuring the MySQL database connection To replace the default database configuration. Download MySQL Connector/J x. type mysql -u root -p. Press ENTER. A list of databases in MySQL should display. Set the host. 7. Type the following: • (Windows) cd <alfresco install dir>\extras\databases\mysql • (Linux) cd <alfresco install dir>/alfresco/extras/databases/mysql 3.zip or . The MySQL database is created in the Alfresco folder. and chose the MySQL database. Copy the JAR file into the <TOMCAT_HOME>/lib directory for Tomcat 6.bat • (Linux) mysql –u root –p <db_setup. add the mysql command to the Windows Path variable. port number. go to step 7.name} 5. you must modify the values in two files. and press ENTER to prepare the database. Locate the following line: db. 1.root=.2 . 2. and extract the following file from the downloaded .Installing and Configuring Alfresco Community Edition 3. you must modify values in the <classPathRoot> \alfresco-global. Locate the following line: dir. Browse to the MySQL download site: http://dev.properties file.sql 5.jar 3. and recreate the MySQL database. Creating the Alfresco database This section describes how to set up a MySQL database to work with Alfresco. and name to the location of your MySQL JDBC driver.root=C:/Alfresco/alf_data 4.

Installing and Configuring Alfresco Community Edition 3.2

db.url=jdbc:mysql://your-host:3306/alfresco 6. (Optional) Enable case sensitivity. The default, and ideal, database setting for Alfresco is to be case-insensitive. For example, the user name properties in the <configRoot>\classes\alfresco\repository.properties file are:
# Are user names case sensitive? user.name.caseSensitive=false domain.name.caseSensitive=false domain.separator=

If your preference is to set the database to be case-sensitive, add the following line to the alfresco-global.properties file: user.name.caseSensitive=true Note: You also must ensure that the MySQL database is set to use UTF-8 and InnoDB. Refer to Configuring MySQL 7. Save the file. You have now configured the MySQL database to work with Alfresco.

Configuring a PostgreSQL database
This section describes how to configure a PostgreSQL database for use with Alfresco. 1. Browse to the Alfresco Community Edition download area, and download the following AMP file: postgresql-3.2-community.amp 2. Stop the Alfresco server. 3. Install the AMP file using the Module Management Tool (MMT). Refer to Installing an Alfresco Module Package. For Tomcat, copy the AMP file to the $TOMCAT_HOME\amps directory, and then run the apply_amps.bat command, which is in the root Alfresco directory. This batch file applies all the AMP files that are located in the amps directory. 4. Copy the appropriate PostgreSQL driver JAR to: $TOMCAT_HOME/lib 5. Create a database named alfresco. 6. Create a user named alfresco. 7. Set the new user's password to alfresco. 8. Ensure the Alfresco user has the required privileges to create and modify tables. 9. Open the <classPathRoot>\alfresco-global.properties file. 10. Locate the following line: dir.root=./alf_data 11. Edit the line with an absolute path to point to the directory in which you want to store Alfresco data. For example: dir.root=C:/Alfresco/alf_data 12. Modify the following connection properties:
db.name=alfresco db.username=alfresco db.password=alfresco db.host=localhost db.port=3307

13. Add the following PostgreSQL connection properties:
db.driver=org.postgresql.Driver db.url=jdbc:postgresql://${db.host}:${db.port}/${db.name} 64 - Installing and Configuring Alfresco Community Edition 3.2

Installing and Configuring Alfresco Community Edition 3.2 hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect hibernate.query.substitutions=true TRUE, false FALSE

14. Comment out the MySQL database connection properties. 15. Save the file. 16. To allow password-authenticated connections through TCP/IP, ensure the PostgreSQL configuration file contains the following:
host all all 127.0.0.1/32 password

For PostgreSQL version 8.1.3, the file name is pg_hba.conf. For every other version, the file name is postgresql.conf. 17. Change the ownership of the directory tree specified. The tree must be owned by the user running the Alfresco server. 18. Start the Alfresco server.

Configuring core services
This section describes how to configure Alfresco core services.

Tuning the JVM
The hardware requirements for the Alfresco repository, and Explorer and Share, are variable and depend on the number of concurrent users that access the system. You can tune the memory and garbage collection parameters for the JVM to be appropriate for your situation. This section suggests metrics and estimates, but your system may vary. Note: Concurrent users are users who are constantly accessing the system through Alfresco Explorer with only a small pause between requests (3-10 seconds maximum) with continuous access 24/7. Casual users are users occasionally accessing the system through Alfresco Explorer or WebDAV/CIFS interfaces with a large gap between requests (for example, occasional document access during the working day). Disk space usage The size of your Alfresco repository defines how much disk space you will need; it is a very simple calculation. Content in Alfresco is, by default, stored directly on the disk. Therefore, to hold 1000 documents of 1 MB will require 1000 MB of disk space. You should also make sure there is sufficient space overhead for temporary files and versions. Each version of a file (whether in DM or WCM) is stored on disk as a separate copy of that file, so make sure you allow for that in your disk size calculations (for DM, use versioning judiciously). Use a server class machine with SCSI Raid disk array. The performance of reading/writing content is almost solely dependent on the speed of your network and the speed of your disk array. The overhead of the Alfresco server itself for reading content is very low as content is streamed directly from the disks to the output stream. The overhead of writing content is also low but depending on the indexing options (for example, atomic or background indexing), there may be some additional overhead as the content is indexed or metadata is extracted from the content in each file. JVM memory and CPU hardware for multiple users The repository L2 Cache with initial VM overhead and basic Alfresco system memory is set up with a default installation to require approximately 512 MB (maximum). This means you can run the Alfresco repository and Explorer with many users accessing the system with a basic single CPU server and only 512 MB of memory assigned to the Alfresco JVM. However, you must add additional memory as your user base grows, and add CPUs depending on the complexity of the tasks you expect your users to perform, and how many concurrent users are accessing the client.
Installing and Configuring Alfresco Community Edition 3.2 - 65

Installing and Configuring Alfresco Community Edition 3.2

Note: For these metrics, N concurrent users is considered equivalent to 10xN casual users that the server could support. Number of users
For 50 concurrent or up to 500 casual users

Recommended memory / CPU settings per server
1 GB JVM RAM

2x server CPU (or 1 x Dual-core)
For 100 concurrent users or up to 1000 casual users 1 GB JVM RAM

4x server CPU (or 2 x Dual-core)
For 200 concurrent users or up to 2000 casual users 2 GB JVM RAM

8x server CPU (or 4 x Dual-core) Concurrent users are considered to be users constantly accessing the system through the Alfresco webclient with only a small pause between requests (3-10 seconds maximum) - with continuous access 24/7. Casual users are considered to be users occasionally accessing the system through the Alfresco webclient or webdav/CIFS interfaces with a large gap between requests (for example, occasional document access during the working day). Permanent Generation (PermGen) Size The default PermGen size in Sun JVMs is 64M, which is very close to the total size of permanent objects (Spring beans, caches, and so on) that Alfresco creates. For this reason it is easy to overflow the PermGen as the result of configuration changes or with the addition of custom extensions. It is recommended that you increase the PermGen to avoid OutOfMemory errors, for example, XX:MaxPermSize=128M is a good starting point. Note: The size of the PermGen is now increased in the Alfresco startup scripts, so provided you are using those scripts, no changes should be necessary. Maximum JVM Heap Size 32/64bit An important calculation to keep in mind is: (Managed Heap + native heap + (thread stack size * number of threads)) cannot exceed 2GB on 32bit x86 Windows or Linux systems This is a limitation of the Sun Java VM. It means that even if you install 4GB of RAM into your server, a single instance of the JVM cannot grow beyond 2GB on a 32bit server machine. Note: A 64 bit OS/JVM has much bigger values. It is recommended that a 64bit OS with large memory hardware (>2GB assigned to the JVM) is used for deployments of >250 concurrent or >2500 casual users. You can also set up your machine to cluster if you prefer to solve multi-user access performance issues with additional machines rather than a single powerful server.

JVM settings
Alfresco generates a high proportion of temporary objects, both in client threads as well as in the background processes. To reduce the number of temporary objects that spill into the OldGen portion of the heap, you need to set the NewSize option as large as possible. The following settings reduce the garbage collections and reveal (with GC printing and JMX tracing) that the OldGen was not growing noticeably over and above the permanent space allocated for caches. Cache sizes are still estimated top out around 520M. So, for a typical 32 bit installation with at least 2GB available for the VM, you can use the following settings:
JAVA_OPTS= -server -Xss1024K -Xms1G 66 - Installing and Configuring Alfresco Community Edition 3.2

significantly increase the server startup time. then the spillover of temporary objects (from NewSize being too small) will cause hold-ups on memory assignment as the garbage collector does sweeps.5G) -XX:NewSize=2G (OldGen at least 3. It can be reduced. you will need to run JConsole (and Java 6) to observe the rate of spillover from Eden space to Survivor to OldGen. Many may only use 256K.67 . Once -Xmx increases. This will. If. The NewSize should be kept as large as possible. to ensure that the rate of spillover of temporary objects is kept down. the OldGen can be increased to 2G. Some installations may require a little over 512K on occasion. for example. and so on). -Xcomp -Xbatch The following can also be adjusted to control the garbage collection behaviour: -XX:+UseConcMarkSweepGC -XX:+CMSIncrementalMode -XX:CMSInitiatingOccupancyFraction=80 Low end machines: This section applies if you have less than 2GB available. however. the OldGen size stabilizes. for instance.5G) If you need these levels. 512M should be left as a buffer to account for miscellaneous (PermGen. reduce the stack size to 512K and then to 256K and note any memory-related errors in the logs.Installing and Configuring Alfresco Community Edition 3.2 . So the following variations might be applied: -Xmx2G -Xmx3G -Xmx4G -Xmx6G -Xmx8G -Xms1G -Xms1G -Xms2G -Xms3G -Xms4G -XX:NewSIze=512M (OldGen at least 1G) -XX:NewSize=512M (OldGen at least 2G) -XX:NewSize=1G (OldGen at least 2. after the system has been running for a while. at least 1GB should be reserved for OldGen. but will highlight missing dependencies that may occur later. then the NewSize can be increased appropriately. The following diagram (using VisualGC) shows how varying the NewSize value affects overall garbage collection activity: Installing and Configuring Alfresco Community Edition 3.5G) -XX:NewSize=3G (OldGen at least 4. JConsole. Effects of NewSize: Given that the OldGen is composed primarily of cache data of up to about 520M. you can add the following options. If the per-thread memory consumption is too high for your installation. The stack size of 1024K (-Xss1024K) is generous. If the machine is supporting 500 simultaneous operations.2 -Xmx2G -XX:MaxPermSize=128M -XX:NewSize=512m If you wish to have Hotspot precompile the classes. but the memory consumption should be watched on a monitoring tool.

recovery.cluster.dialect. Activate the properties in the <classPathRoot>\alfresco-global. Setting properties on the JVM • (Windows) At a command prompt. For example.domain.2 . enter the following: export JAVA_OPTS==Ddir.root=e:/alfresco/data • (Linux) At a command prompt. 2.Installing and Configuring Alfresco Community Edition 3.repo.hibernate. if you wish to distribute a system that has a core set of properties overridden but need to customize the last few for each installation. enter the following: Set JAVA_OPTS=-Ddir.dialect=org.tracking.username=alfresco -Ddb.root property is specified in<configRoot>\alfresco\repository.mode=AUTO -Dalfresco.properties.properties file. For example: -Ddb.password=alfresco -Dhibernate.root The dir.Installing and Configuring Alfresco Community Edition 3.AlfrescoOracle9Dialect -Dhibernate.properties file.alfresco. add the final configuration values.2 Command line configuration The beans that load the alfresco-global.root=/srv/alfresco/data Mixing global properties and system property settings You can use a combination of global properties and system properties for certain customizations. On each installation. 1. 1. and points to the directory alf_data containing the content and the Lucene indexes. 3. 68 .default_schema=ALFRESCO_DEV -Dindex. Set all common defaults for your system. Open the alfresco-global.properties will give preferential treatment to any JVMset properties.name=ALFRESCO_DEV Customizing dir.cronExpression='0/5 * * * * ?' -Dindex.

it will not automatically allocate that number of slots. It is useful to have this running. on occasion. Instead. refer to: http://ehcache.xml. to point to the current location of the alf_data directory. The default ehcache-default.childAssocs" maxElementsInMemory="25000" eternal="true" timeToIdleSeconds="0" timeToLiveSeconds="0" overflowToDisk="false" /> The comment shows the approximate amount of Java heap memory required for the specific example. Save the file without the .root=c:/alfresco/alf_data 4.sourceforge. 3. Cache settings depend on the amount of memory available to your Alfresco server.CurrentCount) must be as low as possible.domain. It is best to err on the side of caution.Installing and Configuring Alfresco Community Edition 3. A typical trace is as follows: The criteria are: • (MissCount . so the amount of memory used is not as high as the approximate value may suggest. This value can be changed to tune the size of the cache for your system. Locate the following line: dir.xml file is enough for most systems and is currently set for 512MB of cache heap memory. timeToIdleSeconds . This is the recommended default for a Java heap size of 1GB.timeToLiveSeconds timeToIdleSeconds and timeToLiveSeconds control the automatic timeout of cached objects.net/ Individual cache settings All cache settings are in: <configRoot>\alfresco\ehcache-default.NodeImpl. Some object references are shared by the caches. Configuring the repository cache The Alfresco repository uses Ehcache in-memory caches.sample extension. they are added to the linked list as required.root=./alf_data Note: This line can differ depending on your installation.hibernate. For information on Ehcache.2 2.alfresco. Caches greatly improve repository performance but they use Java heap memory. maxElementsInMemory The maxElementsInMemory controls the maximum size of the cache. These caches are transaction safe and can be clustered. change the line to: dir. Each cache is configured in an XML block similar to the following: <!-. For example. When maxElementsInMemory is reached. the cache discards the oldest objects before adding new objects.69 . which means that memory is only required for objects that are actually in memory. overflowToDisk overflowToDisk controls whether the cache should overflow to disk rather than discarding old objects. they may crowd out transient session memory and slow down the system. Ehcache caches are implemented using a linked-map system. to identify the caches with a low HitCount/MissCount ratio.2 . • (HitCount/MissCount) must be as high as possible. > Important: Do not directly modify this file. Cache tracing can show which caches fill quickly for your specific server usage pattern. If the caches grow too large. If you set the maxElementsInMemory to a high value.repo. Estimated maximum size affects the permanent memory taken up by the cache. Edit the line with an absolute path. name The name attribute is the name of the cache and generally indicates the type of objects being cached.approx 50MB memory required --> <cache name="org. Installing and Configuring Alfresco Community Edition 3.

Paste these tags in the <extension>\mimetypes-extension. you create two new files in the <extension> directory: 1.Installing and Configuring Alfresco Community Edition 3. Adding a MIME type To add a MIME type.xml. Ensure you have created and added the new file to the <extension> directory so that you can point to your new file.sample extension.2 Tracing the caches This task describes how to trace the repository caches. Browse to the directory: <configRoot>\alfresco\mimetype\ 2. Configuring metadata extraction Metadata extractors offer server-side extraction of values from added or updated content. 3. 5.xml</value> b. Open the following files: a. Save the file without the . Override the following bean to change the trigger schedule: ehCacheTracerJob 4. which points to your modified file: <value>classpath:alfresco/extension/mimetypes-extension.sample This file contains the following line. 8. mimetype-map-openoffice. To output detailed Ehcache usage information.xml.xml. 70 .alfresco. 1.sample extension.xml b. Refer the contents of both files to view the MIME types. set the following logging category to DEBUG: org. 9. 1. Modify the inserted MIME type to match your requirements. To point to your new file: a. 7.cache.2 . Save the file without the . 4. Configuring extended services This section describes how to configure extended services in the Alfresco server. Browse to the file: mimetype-map-extension. the new files are created by copying default files and modifying them.xml.sample file immediately after the <example></example> tags. Copy the pair of <mimetype> </mimetype> tags that is most similar to what you want to add.EhCacheTracerJob 2. 6. mimetype-map. Definitions of the default set of extractors are in <configRoot>\alfresco\content-services-context. the job will collect detailed cache usage statistics and output them to the log/ console.Installing and Configuring Alfresco Community Edition 3. Browse to the file <configRoot>\alfresco\scheduled-jobs-context.repo. depending on how logging has been configured for the server. A file containing the added or modified MIME type 2.xml 3. Override the following property to activate the trigger: schedulerFactory When triggered. A file containing a <bean> that points to your new MIME type file In both cases.

users must specify versionable on a case-by-case basis. The first version of the content is the content that exists at the time of versioning.xml. Open the data dictionary <configRoot>\alfresco\model\contentModel. Open the data dictionary file: <configRoot>\alfresco\model\contentModel. all versionable content has auto-version on. Making all content versionable 1. Disabling the auto-versioning feature 1. the version history is started. By default. content that is created in the repository is not versionable. when content is updated.MyExtracter: <bean id="com. The definition must include the mandatory aspect versionable. When creating content. the version number is updated.. 2. Immediately after the closing </properties> tag.Installing and Configuring Alfresco Community Edition 3.company. Declare a new extractor in <extension>\custom-repository-context. insert the following lines: <type name="cm:content"> <properties> . Restart the Alfresco server.xml. Search for the <type>: <type name="cm:content"> 3. you can modify the definition of that content type in the data dictionary.71 . If you want auto-versioning to be off for all content. as follows: <property name="cm:autoVersion"> <title>Auto Version</title> <type>d:boolean</type> <default>false</default> </property> 4.2 1. </properties> <mandatory-aspects> <aspect>cm:versionable</aspect> </mandatory-aspects> </type> 4.MyExtracter" class="com. When content is versionable. Save the file. By default. Installing and Configuring Alfresco Community Edition 3. 5. Save the file. Restart the Alfresco server. 5.MyExtracter" parent="baseMetadataExtracter" /> Versioning Versioning allows you to track content history. Change the boolean default to false. you can modify the definition of that content type in the data dictionary. Setting up replication Replication allows you to continuously copy a database to a different server. The following example shows a new extractor written in class com. Search for the following <aspect>: <aspect name="cm:versionable"> 3.company.2 .company.xml 2. The auto-version capability can be turned off on a content-by-content basis in the user interface. As a result.. If you want all content to be versionable at the instant of creation.

server-id for the master is usually server-id 1.Installing and Configuring Alfresco Community Edition 3. either as you would normally restore a backup or with the statement LOAD DATA FROM MASTER. Restore the data from the master.cnf (Linux) or my. If the master is already using the binary update log. The databases will not necessarily be exactly synchronized. When they are restarted. 72 . Make a backup of the database. The server-id must be a unique number. There are also two other options: master-port. 2. With one or more slaves you can stop the slave server to use a traditional backup method on its data files. although you can change this. add the following lines to my. but first review the following comments about locking the master. a time in seconds for the slave to attempt to reconnect if the master goes down. It is the SQL statements that manipulate the data that is copied. If one of the three servers fails. The amount by which the slave is behind the master depends on factors such as network bandwidth and geographic location. Grant the slave permission to replicate: GRANT REPLICATION SLAVE ON *. you can use one server for service while another server can copy to the failed server. The slaves need not be running continuously. which could be quite lengthy. All statements that change the master database are stored in the master's binary logs. 5.2 To enable replication you set one server (the slave) to take all its updates from the other server (the master). Note: Replication is not another form of back up. if the database is actually in use. During replication. and master-connect-retry. If the master is not using the binary update log. Even with identical hardware. so you may not be able to spare the downtime. The default is 60 seconds.2 . or use the RESET MASTER statement to clear all binary logs and immediately begin the backup. The latter will lock the master for the duration of the operation. If a user mistypes a DELETE statement on the master. the deletion is faithfully reproduced on the slave.* TO <slave_user> IDENTIFIED BY '<slave_password>' 3. Open a MySQL command prompt on the master server. used if the master is running on a non-standard port (3306 is default). and restart the server: [mysqld] log-bin server-id=1 Note: By convention. You must do normal backups as well as replication. Add the following to the configuration file on the slave: master-host=master-hostname master-user=slave-user master-password=slave-password server-id=2 The slave user and slave password are those to which you set when you granted REPLICATION SLAVE permission on the master. 4. no data is actually copied. either note the offset at the moment of the backup (the next step). and any slaves from 2 onwards. different to the master or any other slaves in the system. The slave reads these logs and repeats the statements on its own database. Do not be without at least one slave or comparable solution if high reliability matters to you. The effect of replication is to allow you to have a nearly current standby server. they catch up. Each slave uses as much space as the master (unless you choose not to replicate some tables) and must do as much write work as the master does to keep up with the write rate. The other server can be on the same computer or on a different computer. Using more than one server allows you to share the read load. You can use two slaves. You can skip this step if you use the LOAD DATA FROM MASTER statement.Installing and Configuring Alfresco Community Edition 3.ini (Windows) configuration file on the master. the slave will always be behind the master. You may want to make a copy of the binary logs before doing this if you need to use the binary logs to restore from backup. Setting up MySQL replication 1. This will be used to start the slave server.

The main features of subsystems are: Multiple ‘instances’ of the same type The same template spring configuration can be initialized with different parameters in different instances. A subsystem can be thought of as miniature Alfresco server embedded within the main server. 1. A subsystem can be started.) 5. 6.max=100 3. Typically. a subsystem wraps an optional functional area.initial=10 db.sample extension from this file. This enables.apache. a subsystem is a configurable module responsible for a sub-part of Alfresco functionality. (It is unlikely that you would want to modify an existing transformer. the subsystem's beans cannot be seen by the main application context and communication with the subsystem must be through explicitly imported interfaces. Alfresco subsystems In Alfresco terminology.xml. Installing and Configuring Alfresco Community Edition 3. Set the connection pool properties. 4. 1. Modify the properties where appropriate. refer to: http://jakarta. paying particular attention to the validationQuery property.html Customizing content transformations This task describes how to customize content transformations. such as IMAP bindings. stopped. for example. If you save the file in the <extension> directory. The application context is a child of the main context.sample file. Open the <extension>\custom-connection-pool-context. For example: db. 3. and it has its own isolated Spring application context and configuration. This property is an SQL query that validates connections from this pool before returning them to the caller.73 .xml 2. Save the file with a meaningful name. 2. For explanations of each property shown in the file. and configured independently. therefore. or one with several alternative implementations. such as authentication. You can also set the basic pool information in alfresco-global. Locate the bean containing a transformer that is most similar to the transformer that you want to add. Remove the .2 Configuring the connection pool This task describes how to to override the connection pool.xml. it can reference all the beans in the main application context. 7.org/commons/ dbcp/configuration. Rename and modify the bean. However. This query must returns at least one row.2 . Open the file. Transformers start below the comment: <!-. Copy the following file: <configRoot>\alfresco\content-services-context.Installing and Configuring Alfresco Community Edition 3. Paste this file into the <extension> directory or in your preferred directory.properties.pool.pool. Delete every pair of <bean> </bean> tags except the pair containing the similar transformer. the chaining of multiple authentication subsystems through property file edits.Content Transformations --> 4. the filename must end with #context.

Authentication. Swapping of alternative implementations To switch over from native Alfresco authentication to NTLM passthru authentication. and ImageMagick content transformers.2 . 74 . Hidden implementation specifics Implementation specifics are not visible because all of its beans are hidden in a private container. including: • Password-based authentication • Single Sign-on (SSO) for WebClient.2 Own bean namespace There is no problem of bean name uniqueness if you need multiple instances of the same subsystem. for example. FTP and NFS servers Third Party Handles the OpenOffice. ldap. where multiple alternative implementations exist. The Alfresco-supplied subsystem categories are: Authentication Handles all authentication related functions. Subsystem configuration The prepackaged subsystem configuration files form part of the core product and should not be edited. Clearly defined interfaces with the rest of the system A subsystem's interfaces must be 'imported' in order to be used anywhere else in the system. Separate product from configuration A subsystem binds its configuration settings to properties and can even do this for composite data.Installing and Configuring Alfresco Community Edition 3. this vastly simplifies the problem of building an authentication chain as there is no need to edit any template Spring configuration. Again. you switch to a passthru authentication subsystem and the correct components are swapped in. • Type is a name for the particular flavor of implementation. Synchronization Performs regular synchronization of local user and group information with the user registry exporters (usually LDAP directories) in the authentication chain. File Servers Handles the CIFS. Web Scripts and SharePoint Protocol • CIFS and FTP authentication • User registry export (LDAP only) The subsystem is chained so that multiple instances of different types can be configured and used together. for example. There is no longer a need to edit or extend prepackaged Spring configuration in order to configure a subsystem for your own needs. WCM Deployment Receiver Handles the WCM Deployment Receiver. you can use the default type name of default. Subsystem categories Every subsystem has a category and a type. SWF Tools. WebDAV. IMAP Handles the IMAP service. • Category is a broad description of the subsystem's function. Where a subsystem has only one implementation. This is done by mounting them as dynamic proxies.Installing and Configuring Alfresco Community Edition 3.

management.alfresco.75 . This is an object that wraps the Spring application context that owns the subsystem and its beans. that is. 2.properties files. To mount a susbsystem. Each subsystem directory should contain one or more Spring XML bean definition metadata files.subsystems. An appropriate one is added into the application context automatically. The XML bean definitions may contain place holders for properties that correspond to configuration parameters of the subsystem. these place holders begin with ${ and end with }.Third party transformer Subsystem --> <bean id="thirdparty" class="org.ChildApplicationContextFactory" parent="abstractPropertyBackedBean"> <property name="autoStart"> <value>true</value> Installing and Configuring Alfresco Community Edition 3. As per standard Spring conventions. See Modifying global properties for more information on how to configure a prepackaged subsystem.OpenOfficeURI"> <constructor-arg> <value>${ooo. as the child application context will recursively expand place holders for its own properties and all the place holders recognized by its parent. there could be a mysubsystem.properties files in its subsystem directory.user}</value> </constructor-arg> </bean> There is no need to declare a PropertyPlaceholderConfigurer bean.2 . Mounting a subsystem A subsystem can be mounted. The identifier that you define for the bean automatically becomes the subsystem category and defines where the factory will look for configuration files. 1. Locate the following bean definition: <!-. Open the core bootstrap-context.alfresco. These files are loaded by the child application context that belongs to the subsystem instance. with names matching the *-context.xml file (the file that controls the startup of beans and their order). containing the following: ooo.properties file.xml and . in the search paths. In the following example. It initializes its application context as a child of the main Alfresco context with an appropriate PropertyPlaceholderConfigurer that will expand its configuration parameters.util.Installing and Configuring Alfresco Community Edition 3.repo. Note: Any instances that you define should extend the abstractPropertyBackedBean definition. its existence can be declared to the main server.user configuration parameter will be substituted into the bean definition when it is loaded: <bean id="userInstallationURI" class="org.xml pattern. These files should not be edited in order to configure the subsystem. use the ChildApplicationContextFactory bean. For example.2 The prepackaged subsystems are found in the <configRoot>\classes\alfresco\subsystems directory.user=${dir.root}/oouser Place holders are used for system-wide properties such as dir. Subsystem properties A subsystem declares default values for all the properties it requires in one or more .root in the -context. the value of the ooo. Properties files in the subsystem directory declare the configuration parameters and provide default values where these have not been supplied elsewhere.

imap.2 .alfresco.IMAP Subsystem --> <bean id="imap" class="org.imap.repo.server.ImapConfigMountPointsBean"> <property name="mode"> <value>virtual</value> </property> <property name="store"> <value>${spaces. A composite property is a special property whose value is a list of beans. For subsystems containing background processes or daemons (for example. So.2 </property> </bean> The autoStart property is set to true.management. the file server subsystem). it is very important to set this property.store}</value> </property> <property name="path"> <value>/${spaces. otherwise the subsystem will never activate.alfresco. resolved on initialization -> <bean id="Repository_virtual" class="org.company_home.ImapConfigMountPointsBean.config.mountPoints"> <value>org.ImapConfigMountPointsBean</value> </entry> </map> </property> </bean> The subsystem declares a single composite property called imap.mountPoints" class="org. Mounting a subsystem with composite properties A subsystem is limited to flat property sets for its configuration.childname}</value> </property> </bean> 76 .imap. • For example.repo. activating the beans it contains.config.Anything declared in here will actually be ignored and replaced by the configured composite propery value.Installing and Configuring Alfresco Community Edition 3. meaning that the child application context will be refreshed when the server boots up. therefore it is difficult to allow structured data in this configuration.ListFactoryBean"> <property name="sourceList"> <list> <!-. 3. The bean's ID should match the name of the composite property.server.repo.mountPoints with component type org.alfresco.alfresco.config. for example.actually a post-processed composite property! --> <bean id="imap.server.beans.repo.Installing and Configuring Alfresco Community Edition 3.ChildApplicationContextFactory" parent="abstractPropertyBackedBean"> <property name="autoStart"> <value>true</value> </property> <property name="compositePropertyTypes"> <map> <entry key="imap. • The configured value of this composite property is materialized in the child application context as a ListFactoryBean. in the IMAP subsystem configuration: <!--The configurable list of mount points . Save your file.config.subsystems.springframework. the IMAP subsystem is mounted as: <!-.factory.

Extension classpath The alfresco-global. so you could put overrides for file server properties in the following file: alfresco/extension/subsystems/fileServers/default/default/mychanges.ldap1:ldap Then you could put property overrides for alfrescoNtlm1 in the following file: alfresco/extension/subsystems/Authentication/alfrescoNtlm/alfrescoNtlm1/ mychanges. Create the path to match the following pattern to override specific properties of a subsystem instance: alfresco/extension/subsystems/<category>/<type>/<id>/*. 2.childname}</value> </property> </bean> </list> </property> </bean> Other beans in the subsystem application context can use imap.Installing and Configuring Alfresco Community Edition 3. or the provided identifier for chained subsystems. to each subsystem instance. For example.server.ImapConfigMountPointsBean"> <property name="mode"> <value>archive</value> </property> <property name="store"> <value>${spaces.mountPoints as though it were a regular list of ImapConfigMountPointsBeans. which will be default for single instance subsystems. For example.chain=alfrescoNtlm1:alfrescoNtlm.2 <bean id="Repository_archive" class="org. 1.store}</value> </property> <property name="path"> <value>/${spaces. The main benefits of the authentication subsystem are: Installing and Configuring Alfresco Community Edition 3. under $TOMCAT_HOME/shared/classes. Alfresco offers multiple alternative implementations of authentication subsystem.imap. you need to target different values for the same properties. for example.alfresco.properties The default type and ID of non-chained subsystems is default.repo. To do this.properties file can only be used to define properties that are global to the whole system. the Authentication subsystems. An authentication subsystem is a coordinated stack of compatible components responsible for providing authentication-related functionality to Alfresco. each engineered to work with one of the different types of back-end authentication server that you may have available in your enterprise.77 .2 .company_home. Add a property file to your application server's global classpath.config. if your authentication chain looked like this: authentication.properties Configuring authentication Authentication is one of the categories of the Alfresco subsystem. You can use the extension classpath mechanism.properties The <id> is the subsystem instance identifier. You can also control the properties of subsystems that may have multiple instances.

SPNEGO Yes No Note: If you configure a single authentication subsystem of a type that does not support CIFS authentication (for example. authentication Data Access Object (DAO) Decides what user management functions are allowed.Installing and Configuring Alfresco Community Edition 3. There is no need to specify the same parameters to different components in multiple configuration files. then the CIFS server will be automatically disabled. • Authentication subsystems are easily chained. • You can swap from one type of authentication to another by activating a different authentication subsystem. • There is no danger of compatibility issues between sub-components.war file is a portable unit of deployment. The alfresco. • Common parameters are shared and specified in a single place.xml file uses generic filters that call into the authentication subsystem. If you want CIFS and LDAP. as we shall see later. The web. For example. • Your authentication configuration will remain standard and. user registry export service (optional) 78 . authentication service Wraps the authentication component and DAO with higher-level functions. the ability to create a user. For example.Installing and Configuring Alfresco Community Edition 3.2 • Subsystems for all supported authentication types are pre-wired and there is no need to edit template configuration. therefore. Authentication subsystem components The main components of an authentication subsystem are: authentication component Handles the specifics of talking to the back-end authentication system. Authentication subsystem types The following table shows the authentication subsystem types supplied with Alfresco and the optional features they support. Active Directory) Windows domain server authentication Kerberos Realm authentication Single sign-on (SSO) support Yes NTLM No CIFS authentication Yes No User registry entry No Yes passthru Yes. your CIFS authenticator and authentication filter are guaranteed to be compatible with your authentication component. NTLM Yes No kerberos Yes. then you must set up an authentication chain. LDAP).xml file. Type alfrescoNtlm ldap Description Native Alfresco authentication LDAP protocol authentication (OpenLDAP. if any. more manageable to support. • There is no need to edit the web. as these have all been preselected.2 .

79 . Authentication chain functions The functions of the chain are composed in two different ways: chained functions and pass-through functions. For this reason.2 . when a user logs in. Pass-through functions These functions cannot be chained and instead pass through to a single member of the chain. organization.2 Allows Alfresco to obtain user attributes. and groups automatically. authentication filters Provide form or SSO-based login functions for the following: • web client • WebDAV • Web Scripts • SharePoint Protocol file server authenticators Provide authentication functions for the following: • CIFS protocol (optional) • FTP protocol Authentication chain At least one of the authentication subsystem types will allow you to integrate Alfresco with the authentication servers in your environment. which handles them directly. those of type LDAP) and imported into Alfresco. users and groups are exported from each member of the chain supporting user registry export (that is. you may want to combine multiple authentication protocols against a collection of servers. • If a chain member accepts the credentials. Alfresco has a built-in authentication chain. During a synchronize operation. Alfresco tries the user's credentials against each of the subsystems in the chain in order. Ordering in the chain is used to resolve conflicts between users and groups existing in the same directory.based Single Sign-On (SSO) • CIFS Authentication Such pass-through functions are handled by the first member of the chain that supports that function and has it enabled. Installing and Configuring Alfresco Community Edition 3. Alfresco composes together the functions of the subsystems in this list into a more powerful conglomerate. The authentication chain is a priority-ordered list of authentication subsystem instances. Chained functions Chained functions combine together functions of more than one subsystem. Examples of pass-through functions are: • NTLM / SPNEGO . For example. if integrating Alfresco with only one of these systems is not sufficient. the login succeeds • If no chain member accepts. the login fails User registry export is also chained. However. such as email address.Installing and Configuring Alfresco Community Edition 3.

id1=manager MBean in global property overrides. configure the following authentication chain: alfrescoNtlm1:alfrescoNtlm. ntlm..sso.sso. The chain is controlled by the special authentication. To switch from password-based login to NTLM-based SSO.enabled=false 80 . set the following property in the alfrescoglobal. which means your user ID and password must be the same in both Alfresco and your Windows domain.chain=alfrescoNtlm1:alfrescoNtlm You can configure the properties of alfrescoNtlm1 using the global properties file. without the need to synchronize accounts in Alfresco and the domain. For direct authentication with a Windows domain server. set the property to the following value: alfrescoNtlm1:alfrescoNtlm.chain global property.properties file as: authentication.Installing and Configuring Alfresco Community Edition 3.authentication. Configuring the authentication chain It s possible to add to or completely replace the default authentication chain. by default.Installing and Configuring Alfresco Community Edition 3. This is expressed in the built-in defaults in the repository.passthru1:passthru.Category=Authentication. use the pass-through (passthru) subsystem type.properties file...ldap1:ldap Next. This is an instance of the alfrescoNtlm subsystem type with and ID of alfrescoNtlm1. Default authentication chain The default product configuration has a simple chain with one member. Save the file. This is a comma separated list of the form: instance_name1:type1.instance_namen:typen 3.chain global property.2 . Note: This subsystem instance does not have SSO enabled.enabled=true This basic use of NTLM requires Alfresco to store its own copies of your MD4 password hash. with Alfresco taking precedence • The Windows domain server should handle CIFS authentication directly • LDAP should be used to synchronize user and group details To achieve these requirements. 4. For example. 2. then a new authentication subsystem instance called ldap1 will be brought into existence and added to the end of the authentication chain.properties file. deactivate SSO in order to activate chained password-based login. Set the property to the required values. 1.authentication.2 Note: This means that only a subset of your user base may be able to use SSO and CIFS. The following example integrates Alfresco with Active Directory has the requirements: • Built-in Alfresco users and Windows users should be able to log in.ldap1:ldap When you navigate to the Alfresco:Type=Configuration. Open the alfresco-global. target CIFS at passthru1 and target synchronization (but not authentication) at ldap1 by setting the properties as follows: alfrescoNtlm1 ntlm.. Locate the authentication.

authentication. NTLMv2 will automatically downgrade to NTLMv1 if the client does not support it.authentication.mapUnknownUserToGuest Should unknown users automatically be logged on as the Alfresco guest user during Single Sign-On (SSO)? alfresco.enabled A Boolean that when true enables NTLM based Single Sign On (SSO) functionality in the Web clients.authentication.authentication.authentication.allowGuestLogin Installing and Configuring Alfresco Community Edition 3. NTLM The alfrescoNtlm subsystem supports optional NTLM Single Sign-On (SSO) functions for WebDAV and the Alfresco Explorer client. The Opera web browser does not currently support NTLM authentication. It is capable of supporting both form-based login and NTLM-based Single Sign-On (SSO) as well as providing authentication for the CIFS server.2 . Firefox and Mozilla also support the use of NTLM but you need to add the URI to the Alfresco site that you want to access to network. ntlm. which means there are no assumptions about the availability of a Windows domain.authentication. Note: The NTLM SSO functions are disabled by default. ntlm. the CIFS server will be disabled.Installing and Configuring Alfresco Community Edition 3.active=false ldap.enabled=false passthru. In this configuration.2 alfresco.authenticateCIFS=false passthru1 ntlm. Internet Explorer will use your Windows logon credentials when requested by the web server when SSO is enabled. Note: NTLM v2 is supported. consider using the Pass-through subsystem. without any changes to the web. password-based login will be used.sso.authentication. alfrescoNtlm configuration properties The alfrescoNtlm subsystem supports the following properties. alfresco. In order to remove this need and authenticate directly with a Windows domain controller.synchronization. which is more secure that the NTLM v1. You can activate SSO with a single property.authenticateCIFS=true ldap1 ldap.trusted-uris option (available through writing about:config in the URL field) to allow the browser to use your current credentials for login purposes.sso.authenticateCIFS A Boolean that when true enables Alfresco-internal authentication for the CIFS server. It performs authentication based on user and password information stored in the Alfresco repository. By using NTLM authentication to access Alfresco Explorer and Alfresco WebDAV sites the web browser can automatically log in. When false and no other members of the authentication chain support CIFS authentication. the browser is detected and will be sent to the usual Alfresco logon page.xml file or further file server configuration.authentication.active=true Configuring alfrescoNtlm alfrescoNtlm is the subsystem configured by default in the Alfresco authentication chain.81 . When false and no other members of the authentication chain support SSO.automatic-ntlm-auth. Alfresco must still store its own copy of your MD4 password hash.

2 Should we allow guest access to Alfresco? Alfresco Share SSO using NTLM The Alfresco Share application exists as an entirely separate web application to the main Alfresco Repository/Explorer WAR file. or it can run on a completely separate application server instance on a completely different machine altogether.alfresco.xml file in a commented out section.xml --> <!-.NOTE: if utilising a load balancer between web-tier and repository cluster. Enable the following servlet filter: <filter> <filter-name>Authentication Filter</filter-name> <filter-class>org.web.Overriding endpoints to reference an Alfresco server with NTLM filter enabled --> <!-. Enable SSO for the alfrescoNtlm or passthru subsystem 2.2 . to use NTLM with Share: 1. Edit the Share application web.NOTE: the NTLM Authentication Filter must be enabled for both repository and web-tier web.xml.Installing and Configuring Alfresco Community Edition 3. It can run in the same application server instance on the same machine to the main Alfresco web application.NTLMAuthenticationFilter</filterclass> <init-param> <param-name>endpoint</param-name> <param-value>alfresco</param-value> </init-param> </filter> 4.servlet. Change the servlet filter that is used.site.xml file in the WEB-INF folder 3. the "sticky --> <!-sessions" feature of your load balancer must be used when NTLM filter is active --> <config evaluator="string-compare" condition="Remote"> <remote> 82 . Then add the following filter mappings: <filter-mapping> <filter-name>Authentication Filter</filter-name> <url-pattern>/page/*</url-pattern> </filter-mapping> <filter-mapping> <filter-name>Authentication Filter</filter-name> <url-pattern>/p/*</url-pattern> </filter-mapping> <filter-mapping> <filter-name>Authentication Filter</filter-name> <url-pattern>/s/*</url-pattern> </filter-mapping> Note: The NTLM settings should already be in the web. Change the configuration of the Share application.sample configuration override file: <web-extension>\webscript-framework-config-custom. Edit the file and uncomment the following section: <!-. 5.sample Copy and rename the file to: <web-extension>\webscript-framework-config-custom. locate the following . Therefore. The Share application uses HTTP(S) to communicate with the configured Alfresco repository.xml 6. To use NTLM with Share.Installing and Configuring Alfresco Community Edition 3.

exposing information about users and groups to the synchronization subsystem Either of these functions can be used in isolation or in combination. pass-through against ActiveDirectory. in which case this flag should be set to false and you would have to chain an additional subsystem such as passthru or kerberos to provide authentication functions. LDAP configuration properties Both the ldap and ldap-ad subsystem types support the following configurable properties. When LDAP authentication is used without user registry export. If you have configured alfrescoNtlm or passthru in your Alfresco authentication chain and enabled SSO. Sun's LDAP provider supports the SASL mechanisms documented here. ldap. Note the additional <external-auth>true</external-auth> parameter. 8. For further information. and possibly Samba on top of OpenLDAP.user access</name> <description>Access to Alfresco Repository WebScripts that require user authentication</description> <connector-id>alfresco</connector-id> <endpoint-url>http://yourserver:8080/alfresco/wcs</endpoint-url> <identity>user</identity> <external-auth>true</external-auth> </endpoint> </remote> </config> 7. they will not be populated with attributes without user registry export enabled. Configuring LDAP An LDAP subsystem supports two main functions: • user authentication . Restart the Share application. see OpenLDAP tips and Active Directory tips. default Alfresco person objects are created automatically for all those users who successfully log in. which defines the distinguished names of other groups. Change the endpoint-url value to point to your Alfresco server location.checking a user's ID and password using an LDAP bind operation • user registry export .2 <endpoint> <id>alfresco</id> <name>Alfresco . This is supported in the standard LDAP schema using the groupOfNames type. Should be one of the standard values documented here or one of the values supported by the LDAP provider. Recommended values are: simple Installing and Configuring Alfresco Community Edition 3.authentication The mechanism to use to authenticate with the LDAP server.active This Boolean flag. It may be that this subsytem should only be used for user registry export. The user registry export function assumes that groups are stored in LDAP as an object that has a repeating attribute.naming. ldap.authentication. when true enables use of this LDAP subsystem for authentication.authentication. Note: Defaults for ldap are typical for Open LDAP and defaults for ldap-ad are typical for Active Directory. See the example LDIF file. LDAP user registry export is most likely to be used without LDAP authentication when chained with other authentication subsystems. NTLM will now be the active authentication mechanism.java.Installing and Configuring Alfresco Community Edition 3. Kerberos against Active Directory.security.2 . However. For example.83 . or users.

authentication.initial The LDAP context factory to use.domain.escapeCommasInBind Escape commas in the entered user ID when authenticating with the LDAP server? Useful when using simple authentication and the CN is part of the DN and contains commas.userNameFormat How to map the user id entered by the user to that passed through to LDAP.provider. ldap. simple This must be a DN and would be something like the following: uid=%s. Active Directory There are two alternatives: User Principal Name (UPN) These are generally in the format of <sAMAccountName>@<UPN Suffix>. and the escaped \.authentication. to browse to a user account and find its userPrincipalName attribute. For example: cn=%s.allowGuestLogin Should we allow unauthenticated users to log in to Alfresco as 'guest'? ldap. not the default setting.java. containing its name and port.Installing and Configuring Alfresco Community Edition 3. use an LDAP browser.authentication. There is no need to change this unless you do not want to use the default Sun LDAP context factory. For example: %s@domain DN This requires the user to authenticate with part of their DN.authentication.java. 84 .authentication.com:389 ldap.Installing and Configuring Alfresco Community Edition 3.authentication. is pulled in as part of a [[The Synchronization Subsystem|synchronize] operation. For example: ldap://openldap. DIGEST-MD5 More secure RFC 2831 Digest Authentication. this requires your user accounts to be set up with reversible encryption.dc=com DIGEST-MD5 Use this value to pass through the entered value as-is: %s ldap. The substring %s in this value will be replaced with the entered user ID to produce the ID passed to LDAP. If this option is set to true it will break the default home folder provider as space names cannot contain \. It also may not work with structured directory layouts containing multipe organization units (OUs).dc=domain OpenLDAP The format used depends on the value chosen for ldap. The recommended value of this setting depends on your LDAP server. Official documentation can be found here. If you are unsure of the correct suffix to use.factory.2 the basic LDAP authentication mechanism requiring the username and password to be passed over the wire unencrypted.authentication. otherwise this should only be used for testing. You may be able to add SSL for secure access.authentication.security.escapeCommasInUid Escape commas in the entered user ID when deriving an Alfresco internal user ID? Useful when using simple authentication and the CN is part of the DN and contains commas.naming. so may require use of their common name (CN) rather than their login ID.java.url The URL to connect to the LDAP server. ldap.naming. such as Softerra. ldap. The standard ports for LDAP are 389 (and 636 for SSL).naming. Note that with Active Directory.dc=company.ou=xyz.ou=People.2 .

ldap. which by default is triggered whenever a user is successfully authenticated that does not yet exist in Alfresco.defaultAdministratorUserNames A comma separated list of user names who should be considered administrators by default ldap.java.synchronization. ldap. It may be that this subsystem should only be used for authentication. This query is used in 'full sync mode'. Refer to the synchronization subsystem.userSearchBase The DN below which to run the user queries.naming.authentication. which by default is triggered whenever a user is successfully authenticated that does not yet exist in Alfresco.synchronization.modifyTimestampAttributeName the last time users were queried. Should use the placeholder {0} in place of a timestamp in the format specified by ldap.synchronization. Refer to the synchronization subsystem.2 ldap.personQuery The query to select all objects that represent the users to export. Installing and Configuring Alfresco Community Edition 3.modifyTimestampAttributeName the last time groups were queried.userNameFormat but with a real user ID instead of %s. Refer to the synchronization subsystem. paged results will not be used.Installing and Configuring Alfresco Community Edition 3. If set to zero or less. which by default is scheduled every 24 hours.synchronization. The timestamp substituted will be the maximum value of the attribute named by ldap. this property indicates that RFC 2696 paged results should be used to split query results into batches of the specified size. ldap. This query is used in 'full sync mode'. The timestamp substituted will be the maximum value of the attribute named by ldap. ldap. which by default is scheduled every 24 hours.modifyTimestampAttributeName The name of the operational attribute recording the last update time for a group or user.synchronization. ldap.synchronization. The default value of 1000 matches the default result limitation imposed by Active Directory.synchronization. Tthis varies between directory servers. This query is used in 'differential sync mode'. in which case this flag should be set to false. ldap.85 .2 .0Z' OpenLDAP yyyyMMddHHmmss'Z' ldap. ldap. ldap. ldap.timestampFormat The timestamp format.synchronization.security.groupSearchBase The DN below which to run the group queries.synchronization.groupQuery The query to select all objects that represent the groups to export.timestampFormat.authentication. This query is used in 'differential sync mode'.credentials The password for this user.active This flag enables use of the LDAP subsystem for user registry export functions and decides whether the subsystem will contribute data to the Synchronization Subsystem. if required.synchronization.groupDifferentialQuery The query to select objects that represent the groups to export that have changed since a certain time.synchronization.principal The LDAP user to connect as to do the export operation.synchronization. ldap.synchronization. Should be in the same format as ldap. Should use the placeholder {0} in place of a timestamp in the format specified by ldap.personDifferentialQuery The query to select objects that represent the users to export that have changed since a certain time.userIdAttributeName The attribute name on people objects found in LDAP to use as the uid in Alfresco.java.synchronization.naming.synchronization. Active Directory yyyyMMddHHmmss'.queryBatchSize If set to a positive integer.security. This overcomes any size limits imposed by the LDAP server.synchronization.timestampFormat. ldap.synchronization.

The three properties are mutually exclusive.defaultHomeFolderProvider The default home folder provider to use for people created via LDAP import.synchronization.synchronization.groupMemberAttributeName The attribute in LDAP on group objects that defines the DN for its members. you can also query using ldapsearch. ldap. or list of servers.userLastNameAttributeName The attribute on person objects in LDAP to map to the last name property in Alfresco. Note: Only NTLM v1 is supported in this configuration.Installing and Configuring Alfresco Community Edition 3. ldap. As NTLMv2 has been designed to avoid "man-inthe-middle" attacks. This saves having to create user accounts within Alfresco. For example: ldapsearch -h localhost -p 389 -x -b "" -s base -LLL supportedSASLMechanisms dn: supportedSASLMechanisms: DIGEST-MD5 supportedSASLMechanisms: NTLM supportedSASLMechanisms: CRAM-MD5 Configuring pass-through The pass-through (passthru) subsystem can be used to replace the standard Alfresco user database with a Windows server/domain controller.synchronization. it would be impossible to use in this 'pass through' style. The subsystem also supports optional NTLM Single Sign-On (SSO) functions for WebDav amd the Alfresco Explorer and Share clients and direct CIFS authentication for the CIFS server.servers 86 . Checking the supported SASL authentication mechanisms 1.authentication.userEmailAttributeName The attribute on person objects in LDAP to map to the email property in Alfresco.synchronization. Note: The simple authentication method will not be reported because it is not a SASL mechanism. This method of authentication is much more secure than simple LDAP-based authentication or form-based authentication.userOrganizationalIdAttributeName The attribute on person objects in LDAP to map to the email property in Alfresco.synchronization. check the values of the supportedSASLMechanisms attributes on the root node of your LDAP server. to set the passthru. 2. ldap. to authenticate users accessing Alfresco.synchronization.2 ldap. If you use OpenLDAP. such as the one from Softerra. Pass-through configuration properties The passthru subsystem supports domain level properties. ldap. For example. See Security_and_Authentication#Creating_home_spaces_-_from_1.synchronization.2 . Using an LDAP browser.synchronization. ldap. ldap.groupType The group type in LDAP.synchronization. Also relevant are the configuration steps described in Alfresco Share SSO using NTLM if you want to enable NTLM-based Single Sign-On (SSO) for the Alfresco Share client.personType The person type in LDAP ldap.groupIdAttributeName The attribute on LDAP group objects to map to the group name in Alfresco.Installing and Configuring Alfresco Community Edition 3. Domain level properties The following properties control the set of domain controllers used for authentication.4_onwards.userFirstNameAttributeName The attribute on person objects in LDAP to map to the first name property in Alfresco. ldap.

enabled A Boolean that when true enables NTLM based Single Sign On (SSO) functionality in the Web clients. The passthru authenticator will load balance amongst the available servers.authentication.2 . When false and no other members of the authentication chain support FTP authentication. Domain mappings may also be specified to route authentication requests to the appropriate server (see below).87 .com • If the client specifies a domain name in its logon request then the appropriate server will be used for the authentication.authentication.authentication.servers A comma delimited list of server names or addresses that are used for authentication.useLocalServer to be false. When false and no other members of the authentication chain support SSO. ntlm.com.connectTimeout Installing and Configuring Alfresco Community Edition 3. password-based login will be used.useLocalServer A Boolean that when true inidicates that the local server should be used for passthru authentication by using loopback connections into the server.authentication.authentication. Make sure that you use the Windows NetBIOS domain name.authentication.guestAccess Should we allow guest access to Alfresco if the authenticating server indicates the logon was allowed guest access? passthru. passthru. • If a server handles authentication for multiple domains then multiple entries can be added in the server list prefixed with each domain name. remember that the backslash character must be escaped. This will attempt to find the domain controllers using a network broadcast. The network broadcast does not work in all network configurations.authenticateFTP A Boolean that when true enables pass-through authentication for the FTP server. the CIFS server will be disabled. When false and no other members of the authentication chain support CIFS authentication. standard chained authentication will be used.authentication. It's often useful to add the administrator user to this list.host1. passthru.authentication.authentication.sso.authentication. passthru.domain Sets the domain to use for passthru authentication.authentication.authentication. If specifying this in alfresco-global.2 property. For example passthru. Other pass-through properties ntlm. this is the catch all entry that will be used if the client domain cannot be determined from the NTLM request or via domain mapping. set passthru. In this case use the passthru. passthru. • There should be at least one entry in the server list that does not have a domain prefix.Installing and Configuring Alfresco Community Edition 3. passthru. and can monitor server online/offline status.servers property to specify the domain controller list by name or address.servers=DOMAIN1\\host1.authenticateCIFS A Boolean that when true enables pass-through authentication for the CIFS server.mapUnknownUserToGuest Should unknown users automatically be logged on as the Alfresco guest user during Single Sign-On (SSO)? passthru.domain to be empty and passthru.properties. The provided password is hashed and checked directly against the domain server securely using NTLM. • Each server name/address may be prefixed with a domain name using the format <domain> \<server>. passthru.DOMAIN2\\host2.authentication.authentication. not the forest name.defaultAdministratorUserNames A comma separated list of user names who should be considered administrators by default.com.

You may choose to use Kerberos against an Active Directory server in preference to LDAP or NTLM as it provides strong encryption without using SSL.properties defines mappings for two domains. if that fails then try to connect using native SMB/port 445. see Setting composite properties in the global properties file filesystem.servers=ALFRESCO\\ADSERVER.authentication. the Java Authentication and Authorization Service. For more information.255 filesystem.wikipedia.ALFRESCO.domainMappings. Specify either a single protocol type or a comma delimited list with a primary and secondary protocol type. A sample NTLM authentication component server list: passthru. The available protocol types are NetBIOS for NetBIOS over TCP and TCPIP for native SMB. For more information on setting composite properties.OTHERDOM\\OTHERSRV Configuring Kerberos The Java Authentication and Authorization Service (JAAS) is used within the Kerberos subsystem to support Kerberos authentication of user names and passwords.0 filesystem. The default check interval is 5 minutes.com/products/jaas/ • http://en. The default is to use NetBIOS. Domain mappings Domain mappings are used to determine the domain a client is a member of when the client does not specify its domain in the logon request.0 filesystem.domainMappings=ALFRESCO.org/wiki/Java_Authentication_and_Authorization_Service 88 . There are two ways of defining a domain mapping.1. please see the following web sites: • http://java.Installing and Configuring Alfresco Community Edition 3. passthru. To specify the domain mapping rules that are used when the client does not supply its domain in the NTLM request you can use the filesystem.ALFRESCO.offlineCheckInterval Specifies how often passthru servers that are marked as offline are checked to see if they are now online.mask=192. either by specifiying an IP subnet and mask.1.protocolOrder Specifies the type of protocols and the order of connection for passthru authentication sessions.2 The timeout value when opening a session to an authentication server.sun. If the client uses a numeric IP address to access the web server it will not send the domain in the NTLM request as the browser assumes it is an Internet address.168.OTHERDOM filesystem. ALFRESCO and OTHERDOM.domainMappings composite property of the File Server Subsystem.value.OTHERDOM.domainMappings.subnet=192.168.Installing and Configuring Alfresco Community Edition 3.1.authentication. or by specifying a range of IP addresses.servers property along with the domain mappings to route authentication requests to the appropriate server. passthru. which should be used with SSL • AD requires special set up to use digest MD5 authentication (reversible encryption for passwords).authentication.168.value. The disadvantages of using LDAP authentication against Active Directory compared with JAAS/Kerberos are: • the simplest approach is to use the SIMPLE LDAP authentication protocol. when included in alfrescoglobal. The example below.value.value.domainMappings. which may be difficult retrospectively • LDAP can use GSSAPI + Kerberos which would be equivalent but this is more difficult to configure and has not been tested For some pointers and background information on JAAS.rangeTo=192. The default is 5000.2 .domainMappings. The check interval is specified in seconds.1.100 The passthru subsystem can use the domain prefixed server name format of the passthru.168.authentication.rangeFrom=192.OTHERDOM. It would still be possible to export user registry information via a chained LDAP subsystem. in milliseconds.

1. Use the Action > New > User menu. Right click the new user account name. g.defaultAdministratorUserNames A comma separated list of user names who should be considered administrators by default. Create a user account for the Alfresco SSO authentication filters.cifs. The default value AlfrescoCIFS is a good choice here. using the full name Alfresco HTTP and user login name as alfrescohttp. passwordbased login will be used.2 Kerberos configuration properties To enable full Kerberos support in Alfresco requires that the CIFS server and the SSO authentication filters each have a Kerberos service ticket. Enable Password never expires and disable User must change password at next logon.authentication. kerberos.authentication. kerberos.ORG. an example is that if the domain is alfresco. When false and no other members of the authentication chain support SSO.user. kerberos.configEntryName The name of the entry in the JAAS configuration file that should be used for web-based single-sign on (SSO). b.authentication.sso.cifs.89 . c.password The password for the CIFS Kerberos principal. as in step 1. kerberos. kerberos. f.realm The Kerberos realm to authenticate with.authentication. The default value Alfresco is a good choice here.configEntryName The name of the entry in the JAAS configuration file that should be used for password-based authentication. the CIFS server will be disabled. Configuring Kerberos against Active Directory The following instructions describe how to set up accounts under Active Directory for use by Alfresco.enabled A Boolean that when true enables SPNEGO/Kerberos based Single Sign On (SSO) functionality in the web client. 2. The Kerberos subsystem supports the following properties. then enter the full name as Alfresco CIFS and the user login name as alfrescocifs. Click Finish.org then the realm should be ALFRESCO. Click Next.authentication.authentication. kerberos. kerberos.authenticateCIFS A Boolean that when true enables Kerberos authentication in the CIFS server.configEntryName The name of the entry in the JAAS configuration file that should be used for CIFS authentication. When false and no other members of the authentication chain support CIFS authentication.http. select Properties. a.http. Installing and Configuring Alfresco Community Edition 3. Create a user account for the Alfresco CIFS server using the Active Directory Users and Computers application. kerberos. d. The default value AlfrescoHTTP is a good choice here.authentication.Installing and Configuring Alfresco Community Edition 3.authentication. Select the Account tab and enable the Use DES encryption types for this account and Do not require Kerberos preauthentication options in the Account Options section.authentication.2 .password The password for the HTTP Kerberos principal. e. The realm should be the domain upper cased. kerberos. Enter a password.

Installing and Configuring Alfresco Community Edition 3.2

3. Use the ktpass utility to generate key tables for the Alfresco CIFS and web server. The ktpass utility is a free download from the Microsoft site, and is also part of the Win2003 Resource Kit. The ktpass command can only be run from the Active Directory server.
ktpass -princ cifs/<cifs-server-name>.<domain>@<realm> -pass <password> -mapuser <domainnetbios>\alfrescocifs -crypto DES-CBC-MD5 -ptype KRB5_NT_PRINCIPAL -mapop set +desonly -out c:\temp \alfrescocifs.keytab ktpass -princ HTTP/<web-server-name>.<domain>@<realm> -pass <password> -mapuser <domainnetbios>\alfrescohttp -crypto DES-CBC-MD5 -ptype KRB5_NT_PRINCIPAL -mapop set +desonly -out c:\temp \alfrescohttp.keytab

a. The principal should be specified using the server name and domain in lowercase with the realm in uppercase. The service types should match cifs and HTTP. For example, cifs/ server.alfresco.org@ALFRESCO.ORG. b. The realm should be the domain upper cased; an example is if the domain is alfresco.org then the realm should be ALFRESCO.ORG. c. <web-server-name> is the host name that is running the Alfresco server. d. <cifs-server-name> is the NetBIOS name of the Alfresco CIFS server when running on an Active Directory client or the host name for a client that is not an Active Directory client, that is, not logged onto the domain. e. <domain> is the DNS domain, for example alfresco.org. f. <domainnetbios> is the netbios name, for example alfresco. Note: Some versions of the ktpass command can generate invalid keytab files. Download the latest version of the resource kit tools from the Microsoft site to avoid any problems. 4. Create the Service Principal Names (SPN) for the Alfresco CIFS and web server using the setspn utility. The setspn utility is a free download from the Microsoft site, and is also part of the Win2003 Resource Kit.
setspn -a cifs/<cifs-server-name> alfrescocifs setspn -a cifs/<cifs-server-name>.<domain> alfrescocifs setspn -a HTTP/<web-server-name> alfrescohttp setspn -a HTTP/<web-server-name>.<domain> alfrescohttp

Some versions of the ktpass command will add the SPN for the principal so you may only need to add the NetBIOS/short name versions of the SPNs. Use the setspn -l <account-name> command to check if the ktpass command set the SPN. You can list the SPNs for a server using the following:
setspn -l <account-name>

For example:
setspn -l alfrescocifs setspn -l alfrescohttp

5. Copy the key table files created in step 3 to the server where Alfresco will run. Copy the files to a protected area such as C:\etc\ or /etc. 6. Set up the Kerberos ini file. The default location is C:\WINNT\krb5.ini or /etc/krb5.conf.
[libdefaults] default_realm = ALFRESCO.ORG [realms] ALFRESCO.ORG = { kdc = adsrv.alfresco.org 90 - Installing and Configuring Alfresco Community Edition 3.2

Installing and Configuring Alfresco Community Edition 3.2 admin_server = adsrv.alfresco.org } [domain_realm] adsrv.alfresco.org = ALFRESCO.ORG .adsrv.alfresco.org = ALFRESCO.ORG

Note: The realm should be specified in uppercase. 7. Set up the Java login configuration file. This would usually be in the JRE\lib\security folder. Create a file named java.login.config with the following entries:
Alfresco { com.sun.security.auth.module.Krb5LoginModule sufficient; }; AlfrescoCIFS { com.sun.security.auth.module.Krb5LoginModule required storeKey=true useKeyTab=true keyTab="C:/etc/alfrescocifs.keytab" principal="cifs/<cifs-server-name>.<domain>"; }; AlfrescoHTTP { com.sun.security.auth.module.Krb5LoginModule required storeKey=true useKeyTab=true keyTab="C:/etc/alfrescohttp.keytab" principal="HTTP/<web-server-name>.<domain>"; }; com.sun.net.ssl.client { com.sun.security.auth.module.Krb5LoginModule sufficient; }; other { com.sun.security.auth.module.Krb5LoginModule sufficient; };

8. Enable the login configuration file in the main Java security configuration file, usually at JRE\lib \security\java.security. Add the following line:
login.config.url.1=file:${java.home}/lib/security/java.login.config

Kerberos client configuration
1. When using Firefox on Windows as your client, you will need to add your Alfresco server name to the network.negotiate-auth.trusted-uris variable You can access the variable going to the special URL: about:config. 2. When using Firefox under Linux, you will need to add your Alfresco server name to network.negotiate-auth.trusted-uris but you will need, in addition, to get a Kerberos ticket using the kinit command. Note: The ticket can correspond to a different user than your Linux user name. For example:
kinit user1

Where user1 is an Active Directory user. If the client and the server are on the same machine, you will need to go to the eternl interface. The loopback interface will not be able to authenticate. You can view your tickets using klist.

Debugging Kerberos
You can debug Kerberos issues using the log4j properties.
Installing and Configuring Alfresco Community Edition 3.2 - 91

Installing and Configuring Alfresco Community Edition 3.2

For example:
log4j.logger.org.alfresco.web.app.servlet.KerberosAuthenticationFilter=debug log4j.logger.org.alfresco.repo.webdav.auth.KerberosAuthenticationFilter=debug

The following is a sample login output:
18:46:27,915 DEBUG [app.servlet.KerberosAuthenticationFilter] New Kerberos auth request from 192.168.4.95 (192.168.4.95:38750) 18:46:28,063 DEBUG [app.servlet.KerberosAuthenticationFilter] User user1 logged on via Kerberos

Configuring synchronization
The synchronization subsystem manages the synchronization of Alfresco with all the user registries (LDAP servers) in the authentication chain. The synchronization subsystem supports two modes of synchronization: Full All users and groups are queried. In this mode, because the subsystem has complete user and group information, it is able to work out which objects have been removed, so it will delete users and groups as well as update and create them. See #Deletion Behavior. Since processing all users and groups may be fairly time consuming, synchronization in this mode is triggered only occasionally by a background job. The default scheduling of this job is every 24 hours, but this can be modified using the configuration properties. Differential Only those users and groups changed since last time are queried. In this mode, local users and groups are created and updated, but not deleted (except where a name collision with a lower priority authentication subsystem is detected - see #Collision Resolution). This 'differential' mode is much faster, and by default is triggered when a user is successfully authenticated who doesn't yet have a local person object in Alfresco. This should mean that new users and their group information are pulled over from LDAP servers as and when required.

Synchronization deletion
Users and groups that are created as a result of a synchronization operation are tagged with an originating zone ID. This records the identifier of the authentication subsystem instance from which the user or group was queried. On synchronization with a zone, only those users and groups tagged with that zone are candidates for deletion. This avoids the accidental deletion of built-in groups, such as ALFRESCO_ADMINISTRATORS.

Collision resolution
If there are overlaps between the contents of two user registries in the authentication chain (for example, where two user registries both contain a user with the same user name), then the registry that occurs earlier in the authentication chain will be given precedence. This means that exactly the same order of precedence used during authentication will be used during synchronization. For example, if user A is queried from zone Z1 but already exists in Alfresco in zone Z2: • A is moved to Z1 if it is earlier in the authentication chain • A is ignored if Z1 is later in the authentication chain

Synchronization configuration properties
The subsystem supports the following properties.
92 - Installing and Configuring Alfresco Community Edition 3.2

FTP. CIFS file server properties The following properties can be configured for the SMB/CIFS server.autoCreatePeopleOnLogin Specifies whether to create a user with default properties when a user is successfully authenticated.import. cifs. supported by Windows 2000 and later versions. and Mac OS X. specifies the domain or workgroup that the server belongs to. As with other Alfresco subsystems. synchronization. This defaults to the domain/workgroup of the server. and the NetBIOS over TCP (NBT) protocol. Configuring SMB/CIFS server The server includes Java socket-based implementations of the SMB/CIFS protocol that can be used on any platform. cifs.2 synchronization. Configuring file servers The File Server subsystem allows access to the Alfresco data stores through the SMB/CIFS.93 .syncWhenMissingPeopleLogIn Specifies whether to trigger a differential sync when a user is successfully authenticated who does not yet exist in Alfresco. who does not yet exist in Alfresco. This can be a maximum of 16 characters and must be unique on the network. The default configuration uses the JNI-based code under Windows and the Java socket based code under Linux. The special token {localname} can be used in place of the local server's host name and a unique name can be generated by prepending/appending to it. cifs.enabled Enables or disables the CIFS server. and NFS protocols. This allows the Alfresco CIFS server to run alongside the native Windows file server. synchronization. the File Server subsystem exposes all of its configuration options as properties that can be controlled through the global properties file. Regardless of this setting a differential sync may still be triggered when a user is successfully authenticated who does not yet exist in Alfresco.synchronizeChangesOnly Specifies if the scheduled sync job run in differential mode. This allows you to browse to the repository using Windows Explorer.2 . synchronization. Solaris. The default is true. There is also a Windows-specific interface that uses Win32 NetBIOS API calls using JNI code.Installing and Configuring Alfresco Community Edition 3. which means that the scheduled sync job is run in full mode. The sections that follow describe each of the configurable properties supported by the File Server subsystem.serverName Specifies the host name for the Alfresco CIFS server. You can control the set of users in this more restricted set by overriding the user query properties of the LDAP authentication subsystem.cron Specifiesa cron expression defining when the scheduled synchronization job should run. The server can listen for SMB traffic over the TCP protocol (native SMB). for example. by default at midnight every day. The default is true.domain An optional property. or to create a Network Place. if not specified. supported by all Windows versions. Installing and Configuring Alfresco Community Edition 3. and was not returned by a differential sync (if enabled with the property above). The default is false. Setting this to false allows you to restrict Alfresco to a subset of those users who could be authenticated by LDAP. only those created by synchronization are allowed to log in. When not empty. and for development/debugging purposes some advanced configuration changes that can be made through Spring bean definition overrides.

tcpipSMB.primary and cifs. cifs.2 cifs.secondary properties to be ignored. cifs.prefix An absolute URL against which all desktop actions and URL files resolve their folder URL. the server will bind to all available adapters/addresses.netBIOSSMB. The default is 137. cifs. cifs. The default port is 445. Windows native SMB The following property will only take effect on Windows servers. The default session timeout is 15 minutes.disableNativeCode 94 .ipv6. unless it is enabled on Windows using the advanced Spring bean definition overrides. cifs.urlfile. cifs.secondary Specifies a secondary WINS server with which to register the server name.primary Specifies a primary WINS server with which to register the server name.sessionTimeout Specifies the CIFS session timeout value in seconds. cifs.datagramPort Controls the NetBIOS datagram port.WINS. where the Java-based SMB implementation is used.Installing and Configuring Alfresco Community Edition 3. cifs.netBIOSSMB. cifs. usually within 15 minutes.port Controls the port used to listen for the SMB over TCP/IP protocol (or native SMB).WINS. For example: http://${localname}:8080/alfresco/ Java-based SMB properties The following properties will only take effect on non-Windows servers. When true. cifs. supported by Win2000 and above clients.WINS.broadcast Specifies the broadcast mask for the network.disableNIO Disables the new NIO-based CIFS server code and reverts to using the older socket based code. cifs.2 .sessionPort Controls the NetBIOS session port on which to listen for incoming session requests.WINS.namePort Controls the NetBIOS name server port on which to listen. where by default a JNI-based CIFS implementation is in use. the server will listen for incoming connections on IPv6 and IPv4 sockets. cifs. If no I/O occurs on the session within this time then the session will be closed by the server. If not specified. The special token {localname} can be used in place of the local server's host name. cifs.enabled Enables the use of IP v6 in addition to IP v4 for native SMB.autoDetectEnabled When true causes the cifs.bindto Specifies the network adapter to which to bind. The default is 139.hostannounce Enables announcement of the CIFS server to the local domain/workgroup so that it shows up in Network Places/Network Neighborhood. Windows clients send keep-alive requests.WINS.netBIOSSMB. The default is 138.Installing and Configuring Alfresco Community Edition 3. cifs.

A workaround is either to add a DNS entry matching the CIFS server name and/or add a static WINS mapping.fw. use the following property settings: cifs.inet. switches off the use of any JNI calls and JNI-based CIFS implementations.1138 udp from any to me dst-port 138 Replace <local-ip> with the IP address of the server that Alfresco is running on.xml file in <configRoot> \classes\alfresco\subsystems\fileServers\default\.debug=0 ipfw flush ipfw add 100 allow ip from any to any via lo0 # Forward native SMB and NetBIOS sessions to non-privileged ports ipfw add 200 fwd <local-ip>. To configure the CIFS server to use non-privileged ports.verbose=1 sysctl -w net.ip.enable=1 sysctl -w net.namePort=1137 cifs. The firewall rules should then be set up to forward requests: • TCP ports 139/445 to TCP 1139/1445 • UDP ports 137/138 to UDP 1137/1138 2.inet.ip. but be aware these commands will delete all existing firewall and NAT rules and could be a security risk: echo 1 > modprobe iptables iptables iptables iptables iptables iptables iptables iptables iptables /proc/sys/net/ipv4/ip_forward iptable_nat -F -t nat -F -P INPUT ACCEPT -P FORWARD ACCEPT -P OUTPUT ACCEPT -t nat -A PREROUTING -p tcp --dport -t nat -A PREROUTING -p tcp --dport -t nat -A PREROUTING -p udp --dport -t nat -A PREROUTING -p udp --dport 445 139 137 138 -j -j -j -j REDIRECT REDIRECT REDIRECT REDIRECT --to-ports --to-ports --to-ports --to-ports 1445 1139 1137 1138 The UDP forwarding does not work. On Mac OS X the following commands can be used: sysctl -w net.95 . Running SMB/CIFS from a normal user account On Unix-like systems such as Linux.inet.xml (note that the default\default part of the path is intentional).forwarding=1 sysctl -w net. or add an entry to the clients LMHOSTS file. Installing and Configuring Alfresco Community Edition 3.1137 udp from any to me dst-port 137 ipfw add 500 fwd <local-ip>. The CIFS server can be configured to run using non-privileged ports and then use firewall rules to forward requests from the privileged ports to the non-privileged ports.fw. which affects the NetBIOS name lookups. Mac OS X.1445 tcp from any to me dst-port 445 ipfw add 300 fwd <local-ip>.1139 tcp from any to me dst-port 139 # Forward NetBIOS datagrams to non-privileged ports (does not currently work) ipfw add 400 fwd <local-ip>. 1.datagramPort=1138 cifs.tcpipSMB.inet. the following commands can be used to get started. 3. Solaris. On Linux.port=1445 cifs.netBIOSSMB. site specific customization of these default values can be placed in a Spring bean file in <extension>\subsystems\fileServers\default\default\custom-file-serverscontext. the default Alfresco setup must be run using the root user account so that the CIFS server can bind to the privileged ports (TCP 139/445 UDP 137/138). Using the subsystem extension classpath mechanism.ip.fw.2 When true.ip. SMB/CIFS advanced Spring overrides The SMB/CIFS server beans are declared in the file-servers-context.sessionPort=1139 Other port numbers can be used but must be above 1024 to be in the non-privileged range.netBIOSSMB.Installing and Configuring Alfresco Community Edition 3.2 .netBIOSSMB.

Installing and Configuring Alfresco Community Edition 3. This has several properties that can be populated with 'child' beans that control various optional SMB implementations. To run the native SMB over TCP/IP protocol under Windows. 3. which is compatible with all Windows clients. which is compatible with Windows 2000 clients and later.2 NetBIOS layer Session state changes File system connection/disconnection Folder searches File information requests File open/close File read/write Transaction requests Echo requests Responses returning an error status IPC$ named pipe File byte range lock/unlock Received packet type DCE/RPC requests File state caching Description . The serverComment of the cifsServerConfig bean controls the comment that is displayed in various information windows. This can be done via the Network Connections control panel in the advanced TCP/IP properties for each adapter. which is only enabled for Alfresco servers running on Windows. netBIOSSMB Controls the Java-based NetBIOS over TCP/IP implementation. win32NetBIOS Controls the JNI-based NetBIOS over TCP/IP implementation. 4. To enable the Java socket based NetBIOS implementation under Windows disable NetBIOS on one or all network adapters. 1. When one of the above properties is not set. it deactivates support for the corresponding protocol implementation. you need to disable Windows from using the port by editing. The tcpipSMB and netBIOSSMB beans have a platforms property that allows their configuration to be targeted to Alfresco servers running on specific platforms. macosx. or creating. The value should be in the form of a comma-separated list of the flag names. The property is formatted as a comma-separated list of platform identifiers. Valid platform identifiers are linux. tcpipSMB Controls the Java-based SMB over TCP/IP implementation. The sessionDebugFlags property of the cifsServerConfig bean enables debug output levels for CIFS server debugging. and aix. the following registry key: [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\NetBT\Parameters] "SMBDeviceEnabled"=dword:00000000 2. Flag NetBIOS State Tree Search Info File FileIO Tran Echo Errors IPC Lock Pkttype Dcerpc Statecache 96 .Installing and Configuring Alfresco Community Edition 3.2 The main bean that drives the CIFS server configuration is called cifsServerConfig. solaris.

ftp. The following logging level must also be enabled to log debug output from the core file server code: log4j.alfresco. The value should be a comma-separated list of flag names from the following table: Flag State Search Folder searches Installing and Configuring Alfresco Community Edition 3. FTP Advanced Spring overrides The FTP server beans are declared in the file-servers-context.fileserver=debug Configuring the FTP file server This section describes how to configure the FTP file server.logger. for example: /Alfresco/myfolder/ charSet Specifies the character set to be used.alfresco.xml file in <configRoot>\classes \alfresco\subsystems\fileServers\default.protocol=debug 6. Using the subsystem extension classpath mechanism. site specific customisation of these default values can be placed in a Spring bean file in <extension>\subsystems\fileServers\default\default\custom-file-serverscontext.2 . optionally followed by one or more folder names.org. 1.logger. that is. if not specified the server will bind to all available addresses. bindTo Specifies the address the FTP server binds to.Installing and Configuring Alfresco Community Edition 3.org. rootDirectory Specifies the path of the root directory as an FTP format path.enabled Enables or disables the FTP server. FTP file server properties The following properties can be configured for the FTP server. The following properties can be overridden on the ftpServerConfig bean.smb.2 Notify Streams Socket PktPool PktStats ThreadPool Change notifications NTFS streams NetBIOS/native SMB socket connections Memory pool allocations/de-allocations Memory pool statistics dumped at server shutdown Thread pool 5. The first part of the path should be the file system name. ports below 1024 require the server to be run under a privileged account. using forward slashes.port Specifies the port that the FTP server listens for incoming connections on.xml (note that the default\default part of the path is intentional). The log4j. The character set name should be a valid Java character set.properties file must also have SMB/CIFS protocol debug output enabled using: log4j.97 Description Session state changes . The debugFlags property enables debug output levels for FTP server debugging. On some platforms. Defaults to port 21. ftp. see the Java CharSet class for more information.

mappings.user.org.user.admin. which also saves having to run the Alfresco server using the root account.uid=0 nfs. site specific customisation of these default values can be placed in a Spring bean file in <extension>\subsystems\fileServers\default\default\custom-file-serverscontext. Using the subsystem extension classpath mechanism. This would usually be enabled on Windows where there is no default portmapper service.gid=501 NFS advanced Spring overrides The NFS server beans are declared in the file-servers-context.mappings.Installing and Configuring Alfresco Community Edition 3. The following properties can be overridden on the nfsServerConfig bean.value.logger.alfresco. nfs. Configure logging levels for the FTP server in $ALF_HOME/tomcat/webapps/alfresco/WEBINF/classes/log4j.alfresco. Under Linux/Unix operating systems.logger. portMapperEnabled Enables the built-in portmapper service. NFS file server properties The following properties can be configured for the NFS server.mappings. For example. nfs.2 Info File FileIO Error Pkttype Timing Dataport Directory File information requests File open/close File read/write Errors Received packet type Time packet processing Data port Directory commands 2.ftp.user.org. the following configuration gives admin a uid and gid of 0 and auser a uid and gid of 501. the default setting is 8. packetPool 98 .admin.user.enabled Enables or disables the NFS server nfs.gid=0 nfs.value.auser nfs.value. The minimum number of threads is 4.ftp. Using a read/ write size of 32K will also help to optimize the performance.uid=501 nfs.server=debug Configuring NFS file servers It is recommended that TCP connections are used to connect to the Alfresco NFS server.user.properties using: log4j.value.auser.user.protocol=debug log4j. threadPool Sets the size of the RPc processing thread pool.mappings A composite property that configures the user ID/group ID to the Alfresco user name mappings that are used by the current RPC authentication implementation.2 .xml file in <configRoot> \classes\alfresco\subsystems\fileServers\default.mappings=admin.Installing and Configuring Alfresco Community Edition 3.xml (note that the default\default part of the path is intentional).mappings.auser. the built-in portmapper service can be used.

portMapperPort The port number to run the portmapper service on.logger. Open the alfresco-global.nfs.server=debug 3.logger.alfresco. The minimum number of packets is 10. mount and portmapper services. mountServerPort The port number to run the mountserver service on.Installing and Configuring Alfresco Community Edition 3.org. log4j. The value should be in the form of a comma-separated list of the flag names in the following table. 1. The following table provides configuration examples. the default setting is 50. The default is to allocate the default NFS port: 2049. The following logging level must also be enabled to log debug output from the core file server code: log4j.properties file. Installing and Configuring Alfresco Community Edition 3. Output server level debug information from the NFS. This will likely clash with a running native NFS server.org.alfresco.org.2 .org. Configuring the email server This section describes how to change the behavior of the email server and email service. There are also the following log4j output options for the NFS/mount/portmapper services: log4j.nfs.fileserver=debug 4.99 . The log4j. The debugFlags property enables debug output levels for NFS server debugging. nfsServerPort The port number to run main NFS server service on. 1.logger. Modify the behavior of the Alfresco email server and email service in this file as required.protocol.auth=debug Configuring the email server and email service This section describes how to enable and configure the email server and service to run in the same JVM context as the repository itself.nfs.logger. The default is to allocate an available nonprivileged port.protocol=debug 5. Flag RxData TxData DumpData Search Info File FileIO Error Directory Timing Session Description Request data details Response data details Hex dump request/response data Folder searches File information requests File open/close File read/write Errors Directory commands Time packet processing Session creation/deletion 2.alfresco.2 Sets the size of the packet pool used to receive RPC requests and send RPC replies. The default port is 111. 2. and remotely using Remote Method Invocation (RMI).properties file must also have NFS protocol debug output enabled using: log4j.alfresco.

xml. Open the configuration file remote-email-service-context.2 . If there are any values in the list. Specifies the interface used for RMI.inbound. 2. and have it interact with the Alfresco server using Remote Method Invocation (RMI). Open the file email-service-context. then all sender email addresses must match.server.* \@googlemail\. Modify the RMI configuration as required.blocked.enabled=true email.*\@hotmail\. 1. custom-email-server. so this flag is independent of the email service. for example.port=25 email. Properties of the bean with the id = “emailServerConfiguration” contain values for email server configuration.enabled=true Description Enables or disables the inbound email service. If the sender email address matches this. . The service could be used by processes other than the email server (for example.senders= Configuring the RMI email service You can run the email server remotely on a separate JVM and server. On 100 .com.com email.senders= Provides a comma-separated list of email REGEX patterns of allowed senders. alfresco. then the message will be rejected.*\@alfresco\.domain=alfresco.2 Value email.org Provides a comma-separated list of email REGEX patterns of blocked senders.allowed.server. For example: .xml. Value <domain> </domain> <port> </port> Description Specifies the domain. The following table provides examples.Installing and Configuring Alfresco Community Edition 3. 3. . This configuration file defines spring beans. 3.properties 2. Specifies the user name to authenticate as when the sender address is not recognized. For example: . specifying the related RMI configuration.Installing and Configuring Alfresco Community Edition 3. direct RMI access).com. This file contains the emailService bean.server. Specifies email server properties. Defaults to port 25.com.inbound.com email. Browse to the <configRoot>\classes\alfresco folder. Specifies the port the email server listens for incoming connections on. Browse to the folder <configRoot>\classes\alfresco. For example: Value <serviceUrl></serviceUrl> <serviceInterface></serviceInterface> Description Specifies the valid RMI URL. Modify the values in this file as required.server.mycompany.unknownUser=anonymous email. email.* \@alfresco\.server. Configuring the email service 1.

both document access and email management are available. <blockedSenders></blockedSenders> <allowedSenders></ allowedSenders> Specifies the domains of the blocked list. The IMAP integration offers the following access modes: Archive Allows emails to be written to and read from Alfresco by the IMAP client by drag and drop. Virtual Documents managed by Alfresco may be viewed as 'emails' from the IMAP client. if email subject matches a topic. Modes are used to define the type of interaction available. Documents are shown as virtual emails with the ability to view metadata and trigger actions on the document. Mixed A combination of both archive and virtual modes.2 some platforms ports below 1024 require the server to be run under a privileged account. Note: The IMAP client must be configured to use localhost as its incoming IMAP mail server. that is. Installing and Configuring Alfresco Community Edition 3. Folder(Space) Content added with emailed aspect Forum(Discussion) Content specialized to Post with emailed aspect. IMAP mount points IMAP mount points are used to control which folders are available using IMAP and the mode in which they are accessed. add to Post’s parent Topic Document(Content) If discussion exists. Specifies the domains of the allowed list. directly from the email application. and so on) to connect to and interact with Alfresco repositories. You can modify or extend the default behaviors by adding in custom handlers. otherwise create new topic based on subject Topic(Post) Content specialized to Post with emailed aspect. otherwise add discussion with email as initial topic and post IMAP Protocol support IMAP protocol support allows email applications that support IMAP (including Outlook. Handling messages by target node type These are the default behaviors for incoming email to different types of referenced nodes. and so on. Thunderbird. same as for forums. By default.2 . from the email client.Installing and Configuring Alfresco Community Edition 3.101 . copy/paste. using links included in the email body. a single mount point called IMAP Home is defined for Company Home running in Mixed mode. Apple Mail. if referenced node is a Post. Enabling the IMAP Protocol The IMAP protocol server is disabled by default. then add to topic. You need to enable the IMAP protocol server to start interaction between the email client and the Alfresco repository.

Update this value with the IP address (or corresponding DNS address) of your external IP interface.2 1. Once the Alfresco server has restarted.0 in Unix will ensure it listens on the specified port on all IP interfaces.port=143 imap.server. the new configuration will take effect. Locate the alfresco-global.Installing and Configuring Alfresco Community Edition 3.server.Installing and Configuring Alfresco Community Edition 3. 2. A value of 0. The templates can be customized to change the metadata and actions available in the email body.server.host. folder) and Start Workflow form (HTML view only). 3. action links (for download. webdav. 102 . based on the the format request by the email client. Restart your Alfresco server.server.0.2 .properties file.enabled=true imap. Virtual view email format The virtualized view uses presentation templates to generate the mail body and display document metadata. Separate templates are available to generate either a HTML or plain text body.0. Uncomment the following sample configuration entries: imap.host=localhost > Important: Do not use localhost as the imap. view. The templates are stored in the repository in Company Home > Data Dictionary > Imap Configs > Templates.

Configuring the virtualization server WCM preview allows editorial users to preview the website in-context (with the style. and workflow controls the approval and publishing of content. without publishing those changes. Refresh your IMAP view to see the new sites.2 Marking Sites as IMAP favorite To have access to Alfresco Share sites using IMAP. which isolate each user's changes. and then deployed either to a flat file system or another instance of Alfresco. and composition of the website). Preview provides a way for contributors and reviewers to view changes as if they had been published to the live site.2 . while they are in the process of making those changes. You can see the site added to the IMAP Sites folder. markup. Configuring Web Content Management This section describes how to configure Web Content Management (WCM). 1. the site(s) need to be added to your list of sites using Share IMAP Favorites. The virtualization server (which is a slightly modified Tomcat server) interprets data in the AVM repository as Installing and Configuring Alfresco Community Edition 3. The virtualization server is the default WCM preview functionality when WCM is installed. WCM is an application for managing web content.103 . Content is managed in sandboxes.Installing and Configuring Alfresco Community Edition 3. and content can be submitted to a shared (staging) sandbox. This is primarily used for two activities: • To allow content approvers to review a change they have been asked to approve in the context of the website. but using the content from any sandbox in the system. Content is collected and displayed using forms. • To allow content contributors to view their changes in the context of the website. Select IMAP Favorites in the Share My Sites dashlet on your My Dashboard page: 2.

For example: alfresco. .net (see Using ip. You can see the virtual view in the URL itself.www-sandbox.alfrescodemo. 1.Installing and Configuring Alfresco Community Edition 3.alfrescodemo. Alfresco has set up a nameserver at ip.www--sandbox. the virtualization server is configured to use the virtualization domain 127-0-0-1. Web Projects. Therefore. the virtualization server is able to determine from which sandbox and Web Project to read content and web application assets.net.alfrescodemo.CCC. allowing users to browse these websites prior to deployment. 3. To enable everybody on a LAN to use in-context preview.Installing and Configuring Alfresco Community Edition 3.2 a set of virtual websites.alfrescodemo. Locate the property alfresco.ip.html.0.net.alfrescodemo.net.net provides "wildcard dns" for all valid IPV4 address.2 .virtserver.ip. the IP address for a DNS wildcard domain must be hyphen-encoded. 2. use the appropriate subdomain of ip.virtualization-domain:port/request-path To configure virtual websites.ip. it runs as if it is in a native Tomcat server and the virtualization system ensures that assets are read from the correct sandbox for each preview request. you need to use a network-accessible IP address. 104 .ip. rather than from the file system.png) and simple Java-based sites (virtualized servlets and JSPs). Each Web Project is assumed to be a self contained J2EE web application. By default.5 is the IP address of the machine hosting the virtualization server. Open the $VIRTUAL_TOMCAT_HOME/conf/alfresco-virtserver.alfrescodemo.alfrescodemo.192-168-1-5. Alfresco uses dynamic host names (in tandem with wildcard DNS) for accessing the virtualization server. In this example. .net. .net.mysite.168. 192.ip. the IP address returned will be: 192.virtserver.168. This special IP address always refers to your local machine (hence its name: localhost).domain that uses ip. if you use the default virtualization domain 127-0-0-1. Each virtual view corresponds to a virtual website within its own virtual host.properties file.net (or any of its subdomains) as the IP address AAA.net.DDD.1.alfrescodemo. virtualization server.1.domain=127-0-0-1.alfrescodemo. For example. The virtualization server lazily "deploys" each sandbox the first time it receives a preview request. To ensure the transparent preview of any sandbox in any Web Project in the system. From this enhanced host name. ip. and setting up a wildcard domain pointing at your virtualization server's IP address (see Configuring wildcard DNS on a nameserver) Using ip.net To set up virtualization for a single machine or a LAN.domain=192-168-1-5.virtserver. and so on). the virtualization-domain and all its subdomains must resolve in DNS to the IP address of the virtualization server (also known as a “wildcard DNS” mapping). and no physical deployment occurs.BBB. There are two ways to achieve this: • Use the appropriate subdomain of ip. Edit the property to contain the hyphen-encoded IP address you want.0. if your browser asks for the virtual host name: alice. you will only be able to do in-context preview on the same machine that hosts the virtualization server. Where $VIRTUAL_TOMCAT_HOME represents the directory in which you installed the virtualization server.gif.net) • Configure a nameserver. These websites may include both static sites (or example.alfrescodemo.alfrescodemo. Therefore. This ensures that the web application itself has no knowledge of any WCM constructs (sandboxes.ip. The following URL shows the general format of an Alfresco virtual hyperlink: http://virtual-hostname.alfrescodemo.1.net.5. This returns the IP address 127. The virtualization server has been customized to read the web application directly from the Alfresco repository. > Important: When specifying alfresco.alfrescodemo.net that is able to resolve any domain name of the form AAA-BBB-CCC-DDD. and each sandbox in the Web Project is automatically "deployed" as a J2EE web application to the virtualization server.

virtserver. WCM deployment WCM Deployment provides a framework for pushing content from an Alfresco WCM Authoring environment into another environment. for example: http://<hostname>.alfrescodemo.0. 4. For example: Valid: alfresco.5. 3. In this example.168. allowing users on a LAN to use in-context preview.net Malformed: alfresco. Restart the Tomcat instance that runs Alfresco. for example: $VIRTUAL_TOMCAT_HOME.net uptime 1. and maintain a real nameserver.5. and the wildcard DNS names are within ip. The WCM Authoring environment provides the facilities to produce an approved and consistent view of a web project called a snapshot.domain=192. 5.2 Otherwise.alfrescodemo. ip. Microsoft DNS.net Alfresco can now generate URLs that address the virtualization server's network-accessible address.virtserver. Near WCM assets. run one of the following commands: • ping alice. WCM deployment takes those snapshots and pushes them out to either live or test servers. To view this in isolation.1.ip. and return 127. a wildcard DNS record resolves to an IP address such as 192.19 Configuring wildcard DNS on a nameserver This task describes how to configure a nameserver.lan Note: You cannot use the “hosts” file to create a wildcard DNS domain on Windows or Unix.virtserver.0. Deployments are pushed from an Alfresco WCM authoring environment to a WCM Deployment Engine.1.192-168-1-5.2 .alfrescodemo.mysite.168.168.www--sandbox.ip.localdomain.1 for all DNS name lookups within your malformed virtualization domain. To create a DNS wildcard that is usable when you are not connected to the Internet. 6.ip.alfrescodemo. A list of URLs displays.virtserver.lan.1.5.5 and not 127. Modify the value of the alfresco.net will assume an error.lan. configure. Open the file $VIRTUAL_TOMCAT_HOME/conf/alfresco-virtserver.168.Installing and Configuring Alfresco Community Edition 3. click the icon resembling an eyeball. djbdns.www-sandbox.properties. such as 192. you must install. The deployment process may be automated so that it happens automatically when content is approved for Installing and Configuring Alfresco Community Edition 3.domain=192-168-1-5. For example you can push out content to a flat file system to be served up by Apache or IIS.alfrescodemo.192-168-1-5. and set up a wildcard domain pointing at your virtualization server machine's IP address to: • Virtualize content on a machine or LAN with no access to the Internet (for example: a demo laptop) • Attain faster speeds on the first DNS lookup of a name than when served locally (IP address answers have a one day TTL) • Keep everything centralized if you already have BIND. 2.ip. which then delegates to the appropriate Deployment Receiver Target.105 . or other DNS solution in place • Be independent from the Alfresco alfrescodemo.domain=ip.net • ping mysite.1.0.domain property to resemble the following: alfresco.localdomain.1.www--sandbox. Set the directory where you installed the virtualization server.net These links will resolve to your virtualization server on 192. the LAN's domain name is localdomain.0.

WCM deployments are sent to a deployment engine. unless you have configured it to run over another transport.2 . Open the deployment. The Standalone Deployment Engine consists of a small server that receives updates from an Alfresco repository and publishes them to its deployment targets. you can plug in your own authenticators. Configuring the WCM standalone deployment receiver This section describes how to configure the WCM standalone deployment receiver.xml file. respectively) accessible. on Windows. It does not have the benefits of a full repository but is a small and tightly focused server. Ensure that you have installed the WCM standalone deployment receiver. 44100 and 44101.properties file located in the installation directory (for example. /opt/alfresco/deployment). 1. It is configured with a single file system deployment target.properties file and the application-contect. The destination file server receiver has to be running with its RMI registry port and service port (by default. or on Linux. transport implementations. If the Alfresco-supplied components are not suitable. For performance reasons only. and deployment targets. The deployment framework provides a flexible and highly configurable system to allow you to tailor the system to your requirements. c:/Alfresco/Deployment.Installing and Configuring Alfresco Community Edition 3. and typically served up by a web or application server. which places the contents of the deployment onto a flat file system.2 publishing. The configuration files needed for configuration are the deployment. content transformers. 106 .Installing and Configuring Alfresco Community Edition 3. differences between the old version and the new version are sent. which delegates the deployment to the registered deployment targets.

Installing and Configuring Alfresco Community Edition 3.2

The deployment.properties file contains the simple configuration for the standalone deployment receiver. 2. Edit the configurations as follows:
; filesystem receiver configuration deployment.filesystem.datadir=depdata deployment.filesystem.logdir=deplog deployment.filesystem.metadatadir=depmetadata deployment.filesystem.autofix=true deployment.filesystem.errorOnOverwrite=false ; default filesystem target configuration deployment.filesystem.default.rootdir=target deployment.filesystem.default.name=default ; Deployment Engine configuration deployment.rmi.port=44100 deployment.rmi.service.port=44101 ; Stand alone deployment server specific properties deployment.user=admin deployment.password=admin

3. After making changes to the deployment.properties file, restart the deployment engine. 4. Save your file. 5. Open the application-context.xml file. For example, the following is a sample application-context.xml file, showing how the deployment.properties, context files, and the targets are read.
<beans> <bean id="properties" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"> <property name="ignoreUnresolvablePlaceholders"> <value>true</value> </property> <property name="locations"> <list> <value>classpath:deployment.properties</value> </list> </property> </bean> <import resource="classpath*:deployment/*-context.xml" /> <import resource="classpath*:deployment/*-target.xml" /> </beans>

The standalone deployment engine uses log4j for problem determination, and logging for the deployment engine is placed in the log directory. Your spring definitions of the deployment targets are read from this directory. All files matching the pattern deployment/*-target.xml are loaded by the deployment engine. 6. Save your file. 7. Restart the deployment receiver.

Installing and Configuring Alfresco Community Edition 3.2 - 107

Installing and Configuring Alfresco Community Edition 3.2

Troubleshooting
This chapter provides information to help you solve issues that may arise when installing and configuring Alfresco. For additional help, refer to the following: • Administration Console in Alfresco Explorer to view various installation and setup information • Alfresco Installation forum (http://forums.alfresco.com/)

Debugging an Alfresco installation
When developing add-ins, fixing bugs, or changing Alfresco from the source code, it is helpful to debug an instance of Alfresco running on a standard application server. This section outlines the steps needed to configure Alfresco and Eclipse to provide a real-time view of the server and to troubleshoot issues by stepping through the code line by line. To debug a running Alfresco server, you must connect to the JVM in which Alfresco is running. The following steps configure the JVM to expose an interface for this connection, and then configure Eclipse to connect to and control that JVM.

Configuring the JVM
This task describes how to configure the JVM to expose an interface for connection to the Alfresco server. Before you start, you must: • Have a fully installed, configured, and running instance of Alfresco. These steps assume you are using Tomcat on Windows, but the steps are similar for other application servers on other systems. • Have an IDE installed. These steps describe how to configure Eclipse, which must be installed first (http://www.eclipse.org/downloads) • Download and install the Alfresco source code from http://wiki.alfresco.com/wiki/ Alfresco_SVN_Development_Environment. • Ensure the source code is the same version as the installed Alfresco server. 1. Verify the Alfresco server is not running. 2. Edit the JVM options used to start the Alfresco Tomcat instance. If you are using the default alf_start.bat to start Alfresco, perform the following: a. Edit alfresco.bat in a text editor. b. Find the line: set JAVA_OPTS=%JAVA_OPTS% -server –X… c. On the next line, add the following on one line:
set JAVA_OPTS=%JAVA_OPTS% -server -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n, address=8082

where address is a port for your system 3. Save the file and close the editor.

Configuring Eclipse
This task describes how to configure Eclipse to connect to and control the JVM. 1. From the Run menu, choose the Open Debug dialog.
108 - Installing and Configuring Alfresco Community Edition 3.2

Installing and Configuring Alfresco Community Edition 3.2

2. Right-click Remote Java Application and select New. 3. In the Name box, type Debug Local Tomcat Alfresco. 4. Next to Project, click Browse, and select Web Client. If this is not available as an option, ensure your source code matches that of your server. 5. In Connection Properties, enter the Port number you added to the alf_start.bat file. 6. Check Allow Termination of remote VM if you want to be able to stop the Alfresco server from the Eclipse console. 7. Click Apply to save the configuration. You have configured Alfresco and Eclipse. Next, you can start the Alfresco server and start the Debug configuration in Eclipse. Eclipse will connect to the Alfresco JVM. From the Java perspective in Eclipse, you can expand the “core” or “web client” packages, open the class files you are interested in, and set breakpoints for the Alfresco server to stop at. From the Debug perspective, you can then interrogate specific variables from the Alfresco server “live” , and step through the source code line by line.

Setting log levels
The log4j.properties file lets you configure logging levels to provide debugging information when troubleshooting. To set up logging policies, you must prepend log4.logger to the class name you want to log to, and set the logging level. 1. Find a class definition in the Spring config files, or uncomment an existing configuration for the component. 2. Add the class definition to the log4j.properties file.

3. Prepend log4j.logger onto the class definition in the log file. For example: log4j.logger.org.springframework.beans.factory.config.PropertyPlaceholderConfigure= This example sets the logging level to debug. Other logging levels include all, info, warn, error, and fatal. 4. Restart the server. During startup, all the properties display.

Testing and debugging links
The <configRoot>/log4j.properties file lets you set the level of logging based on the amount of information you need. • To enable debugging for the background process that continually checks the links in a web project, remove the comment from the following line: #log4j.logger.org.alfresco.linkvalidation.LinkValidationServiceImpl=debug • To enable debugging for the action to run when performing a link validation check, add the following line: log4j.logger.org.alfresco.linkvalidation.LinkValidationAction=debug • To enable debugging for the link validation report dialog, add the following line: log4j.logger.org.alfresco.web.bean.wcm.LinkValidationDialog=debug

Error messages
This section lists possible issues you may encounter when installing Alfresco and suggests possible remedies. ImageMagick Error message on the console:
Installing and Configuring Alfresco Community Edition 3.2 - 109

as there is a 50 percent chance that it will retain the native NFS details.BindException: Address already in use: JVM_Bind at java. version-number. This issue lasted this long presumably because so many Linux distributions create a new group for each new user. NFS server port number is not ephemeral If the NFSServerPort property is not given.nfs will defer to the portmapper for the port-number. it has yet to filter down to SVN.net. meaning that Unix accounts that have a user-id that differs from the group-id will not gain authentication. Running native and Alfresco NFS servers on the same host If you wish to run the native server along side the Alfresco NFS server.2 ERROR [AbstractImageMagickContentTransformer] JMagickContentTransformer not available: ERROR [AbstractImageMagickContentTransformer] ImageMagickContentTransformer not available: Failed to execute command: imconvert . User ID and Group ID An issue with the NFS server (JLAN-11) transposes the GID and UID of the NFS client user. removes any dependency upon a well known port number. and protocol of the NFS server in question. you cannot depend upon the portmapper. Afterward the following command line should succeed: 110 . Troubleshooting NFS This section provides help for diagnosing and resolving any issues that might arise when configuring NFS. RpcPacket) still reads the GID before the UID.server. if any. FTP Socket Error message on server startup: ERROR [protocol] FTP Socket error java. when properly used.authenticateRpcClient(int. mount. The user will only see ls: /mnt/alfresco: Input/output error. mount.socketBind(Native Method) Check to see if you have any services running against port 8080 for the Alfresco server or port 21 for the Alfresco FTP integration.2 . it defaults to 2049. however neither Alfresco nor any native NFS server seem to use this functionality.10 version on Linux. These issues will not cause the server to fail.AlfrescoRpcAuthenticator..nfs will fail as it cannot find the server you have described in the portmapper table. Alfresco is reporting that external document transformation engines are not available for use by the server. The Alfresco-NFS server will deny them access. This is likely to conflict with a native NFS server. Though the bug is declared closed. unless told otherwise.alfresco. Failing this.Installing and Configuring Alfresco Community Edition 3. You must therefore configure both MountServerPort and NFSServerPort to known values above 1024.PlainSocketImpl.0. When using nfs-utils-1.Installing and Configuring Alfresco Community Edition 3. You can remove the transformation references if they are not required. The portmapper daemon.. Only if all three of these are supplied on the command line will the mount command directly contact the Alfresco NFS server.auth. JAVA_HOME Make sure the JAVA_HOME variable is set correctly for your Java installation.filesys.net. and org.

This problem can be caused by the Share connecting to the Windows file server that is running on native SMB/port 445 rather than trying to connect via NetBIOS. the portmapper only searches for the NFS server on the version and protocol. Scroll down to the File and Printer Sharing rules and enable the following: • File And Printer Sharing (NB-Datagram-In). Click on the Inbound Rules item in the left hand column.111 . In order to stop native SMB being used when the Alfresco CIFS server is being run under Vista or Windows 2008. Run the Windows Firewall with Advanced Security application: • (Vista) go to Control Panels > Administrative Tools • (Windows 2008) go to Start > Administrative Tools 2. Troubleshooting CIFS This section provides help for diagnosing and resolving any issues that might arise when configuring CIFS. The SMBDeviceEnabled registry key does not seem to be recognized on Vista and Windows 2008. Password Error Sometimes. the firewall rules can be updated to block inbound connections on port 445. this blocks the native SMB/ port 445 traffic • Other File And Printer Sharing (. It is desirable to have functionality to resolve the NFS server required by the volume requested.2 mount -oport=yourNfsPort.) rules are not required and can be left as is OpenLDAP tips This section shows a sample configuration file. Native SMB collisions Native SMB can be disabled by adding the following registry key: [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\NetBT\Parameters] "SMBDeviceEnabled"=dword:00000000 Reboot the system after creating this key. If you have more than 500 users or groups this would be an issue. however. Installing and Configuring Alfresco Community Edition 3. See the OpenLDAP documentation on limits. Setting the value to one or deleting the registry key will restore native SMB support. File And Printer Sharing (NB-Name-In) and File And Printer Sharing (NB-Session-In) • The File And Printer Sharing (SMB-In) rule should be disabled.mountport=yourMountPort. 3. the login dialog appears several times until finally taking effect. when connecting to an instance of Alfresco Share.proto=tcp yourFfsServerName:/alfresco /mnt/alfresco/ The proto option may be either tcp or udp. To set up the Windows firewall on the system running the Alfresco CIFS server: 1..Installing and Configuring Alfresco Community Edition 3.2 . There are a number of things to note: • The maximum number of results returned has been increased from the default of 500 that even applies to paged results..

schema # Define global ACLs to disable default read access.pid /usr/local/var/run/slapd.. (e. # This file should NOT be world readable. See the example data.conf(5) for details on configuration options.org pidfile argsfile # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # /usr/local/var/run/slapd.Installing and Configuring Alfresco Community Edition 3.openldap. "access to * by * read") rootdn can always read and write EVERYTHING! ####################################################################### # BDB database definitions ####################################################################### database bdb suffix "dc=company.2 • Digest authentication has been configured to map from a user ID to the corresponding distinguished name.g. • Passwords are in clear text (so that any authentication mechanism can be used). # Do not enable referrals until AFTER you have a working directory # service AND an understanding of referrals. # include /usr/local/etc/openldap/schema/core.la moduleload back_shell.la moduleload back_ldbm. It is possible they can be in the correct hashed form for the MD5 digest to work.schema include /usr/local/etc/openldap/schema/cosine.Installing and Configuring Alfresco Community Edition 3.la Sample security restrictions Require integrity protection (prevent hijacking) Require 112-bit (3DES or better) encryption for updates Require 63-bit encryption for simple bind security ssf=1 update_ssf=112 simple_bind=64 Sample access control policy: Root DSE: allow anyone to read it Subschema (sub)entry DSE: allow anyone to read it Other DSEs: Allow self write access Allow authenticated users read access Allow anonymous users to authenticate Directives needed to implement policy: access to dn. #referral ldap://root.schema include /usr/local/etc/openldap/schema/inetorgperson.base="cn=Subschema" by * read access to * by self write by users read by anonymous auth if no access controls are present.la moduleload back_passwd.2 . See slapd.args Load dynamic backend modules: modulepath /usr/local/libexec/openldap moduleload back_bdb. the default policy allows anyone and everyone to read anything but restricts updates to rootdn.base="" by * read access to dn.dc=com" 112 .la moduleload back_ldap.

dc=com ou: Groups objectClass: top objectClass: organizationalUnit dn: uid=fullname.2 .]*).dc=com ou: People objectClass: top objectClass: organizationalUnit dn: ou=Groups.com o: Company Software Inc.cn=digest-md5. directory /usr/local/var/openldap-data # Indices to maintain index objectClass eq # Clear text to allow hashing password-hash {CLEARTEXT} # SASL mappings for md5 digest authentication # Extract the user id and use as the search key authz-regexp uid=([^. # This is secret . Installing and Configuring Alfresco Community Edition 3.cn=digest-md5.dc=com objectclass: inetOrgPerson sn: Name cn: Full Name userPassword: inClearText telephoneNumber: 1234567890 uid: fullname givenName: Full mail: full.2 rootdn "cn=Manager. rootpw {SSHA}u9AUUYOSVX6idlXcwyYOAG6G84oHFpvG # The database directory MUST exist prior to running slapd AND # should only be accessible by the slapd and slap tools.113 .dc=com??one?(uid=$1) # Tweaks to increase the result set size and max query time sizelimit 50000 timelimit 3600 The following is a very simple example LDIF file that defines People and Groups Organizational units and some example users and groups.cn=company. should # be avoid..dc=company... # Mode 700 recommended.dc=company. See slappasswd(8) and slapd.dc=company.dc=com??one?(uid=$1) authz-regexp uid=([^.name@company.dc=com dc: company objectClass: top objectClass: domain dn: ou=People.dc=com" # Cleartext passwords.Installing and Configuring Alfresco Community Edition 3. # Use of strong authentication encouraged.]*).cn=auth ldap:///dc=company.ou=People.dc=company.conf(5) for details. # Initial directory contents dn: dc=company. especially for the rootdn.cn=auth ldap:///dc=company.com.

" • The example URL in ldap.authentication.dc=company.rus@company. open Active Directory Users and Computers." Click "Next".security.2 .dc=com objectclass: inetOrgPerson sn: Rus cn: Wal Rus userPassword: inClearText telephoneNumber: 1234567890 uid: walrus givenName: Wal mail: wal.principal).synchronization.ou=Groups.ou=People. You'll need to switch the port from 389 (below.Installing and Configuring Alfresco Community Edition 3.840. • It is often helpful to screen out non-user accounts and disabled accounts. To do this. For example: userAccountControl:1. non-SSL) to 636 for SSL.2. then select the user that you are using for the LDAP bind and click "Next".java. right click on the domain. The default user queries in the ldap-ad subsystem type do this by checking bit fields on the userAccountControl attribute.java. • You may need to give special permissions in the Active Directory to the account that you are using to do the LDAP bind (as configured in ldap.dc=com member: uid=walrus. The permission that they will need is on the next screen "Read all inetOrgPerson information. and select "Delegate Control.4.dc=company.ou=Groups.. dn: cn=Group One.dc=com objectclass: groupOfNames cn: Group One member: uid=fullname.Installing and Configuring Alfresco Community Edition 3.url does not use SSL.1.dc=company.provider.dc=com Active Directory tips This section describes the tips for using Active Directory with the LDAP synchronization.ou=People.dc=company.ou=People.dc=company..naming.dc=com dn: cn=Group Two. SSL is recommended for production systems.dc=company.com o: Company Software Inc.naming.113556.ou=Groups.dc=com objectclass: groupOfNames cn: Group Two member: cn=Group One.803:=512 114 .2 dn: uid=walrus.

Where possible. dir. An AMP file can contain as little as a set of custom templates or a new category.115 . <configRoot> is: <TOMCAT_HOME>/webapps/alfresco/WEB-INF/ <configRootShare> The <configRootShare> directory is where the default configuration files for Share are stored. audio. Users can organize dashlets into different layouts and set keyboard short cuts for each dashlet. CSS. AMP AMP (Alfresco Module Package) is a collection of code. <configRootShare> is <TOMCAT_HOME>/ webapps/share/WEB-INF CIFS Microsoft Common Internet File System (CIFS) is a network file system for sharing files across the Internet.2 Glossary ACP ACP (Alfresco Content Package) files hold exported information produced when using the Export feature. that collectively extend the functionality or data provided by the standard Alfresco repository. Installing and Configuring Alfresco Community Edition 3. for example records management. XML. Where possible. images. It could contain a complete new set of functionality.indexes This folder contains all Lucene indexes and deltas against those indexes. for Tomcat. For example.root The dir.Installing and Configuring Alfresco Community Edition 3. alf_data Directory containing binary content and Lucene indexes. and HTML. images. For example.root property is specified in the <extension>/custom-repository. dir. For example. documents. you should not edit these files but you can edit the overrides in the <extension> directory.properties file. It points to the directory alf_data. dashboard The Alfresco dashboard is an interactive user interface that presents and organizes information to the user. XML. <configRoot> The <configRoot> directory is where the default configuration files are stored. video. AVM Alfresco Advanced Versioning Manager (AVM) is an advanced store implementation designed to support the version control requirements of large websites and web applications. for Tomcat. breadcrumb A navigation link that allows you to jump to any part of the breadcrumb path.2 . dashlet A dashlet is an application that appears in the Alfresco dashboard that presents information to the user. you should not edit these files but you can edit the Share override files in the <webextension> directory. content Files or documents made of two main elements: the content itself and information about the content (metadata). which contains the content and the Lucene indexes. It can contain a custom model and associated user interface customizations. Alfresco WAR The Alfresco Web application Archive (WAR) file is for deployment in existing application servers.

It is recommended for corporations. In WCM. Quoted from: http://www.org/java/docs/index. Images can be cropped.html repository The repository is the combination of the content.2 Enterprise Content Management (ECM) Enterprise Content Management (ECM) is a set of technologies used to capture.org/script/index. preserve and deliver content and documents and content related to organizational processes. and compose bitmap images. certified build that is supported by Alfresco Software.imagemagick.apache.sample suffix. with the primary benefit of being a stable. <extension> is:<TOMCAT_HOME>/shared/classes/alfresco/ extension/ Hibernate Hibernate is an object-relational mapping (ORM) library for the Java language. convert and write images in a large variety of formats. and delete both folders and files. Quoted from: http://en. Many of these files have a . When Alfresco is installed. In the sandbox. wherever that information exists. there are sample files in this directory. or using as a working area. Alfresco provides support for JCR level 1 and level 2 giving standardized read and write access.wikipedia. certified.Installing and Configuring Alfresco Community Edition 3. supported application with warranty and indemnity. edit. providing a framework for mapping an object-oriented domain model to a traditional relational database. It is a technology suitable for nearly any application that requires full-text search. and text. Hibernate solves Object-Relational impedance mismatch problems by replacing direct persistence-related database accesses with high-level object handling functions. store. site A site is a collaborative area for a unit of work or a project. experimenting. JVM Java Virtual Machine Lucene Apache Lucene is a high-performance. edit. a user can add. 116 . <extension> The <extension> directory is where you store files that extend and override the Alfresco default files. For example: for Tomcat. full-featured text search engine library written entirely in Java. which must be removed to activate the file. ECM tools and strategies allow the management of an organization's unstructured information. and the database.php Java Content Repository (JCR) API Java Content Repository API is a standard Java API (as defined by JSR-170) for accessing content repositories. sandbox An environment for testing. especially crossplatform. and other organizations looking for a production-ready open source ECM solution. governments. the indexes. lines. ImageMagick ImageMagick is a software suite to create. a sandbox is an area where users can make changes to web content. reliable.2 . It can read. images can be rotated and combined. polygons. various effects can be applied. with the support of Alfresco and its certified partners. It is the stress-tested. ellipses and Bézier curves can be added to images and stretched and rotated. colors can be changed.org/wiki/Enterprise_content_management Enterprise Edition The Enterprise Edition is production-ready open source.Installing and Configuring Alfresco Community Edition 3. Quoted from: http://lucene.

Installing and Configuring Alfresco Community Edition 3.sample suffix. <web-extension> The <web-extension> directory is where you store files that extend and override the Alfresco default files for Alfresco Share. Advanced workflow provides two out-ofthe-box workflows (Review and Approve. WAR The Alfresco Web application ARchive (WAR) file is for deployment in existing application servers. there are sample files in this directory. The Alfresco repository uses the Spring Framework as the core foundation of its architecture. develop. <web-extension> is:<TOMCAT_HOME>/shared/classes/alfresco/ web-extension/ workflow A workflow is a work procedure and workflow steps that represent the activities users must follow in order to achieve the desired outcome. Web Content Management (WCM) Web Content Management is an Alfresco product for the rapid deployment of web content. store A store is a logical partition within the repository.117 . and maintain content for websites. Installing and Configuring Alfresco Community Edition 3. Each store is identified by a content store reference.2 Spring Spring is an open-source application framework for Java/JEE. This reference consists of a store protocol (such as archive or workspace) and a store id (such as SpaceStore or User). When Alfresco is installed. A protocol that allows users to edit and manage files on remote web servers. For example: for Tomcat. Simple workflow defines content rules for a space. allowing users to create. AVM stores are used for Web Content Management. WebDAV Web-based Distributed Authoring and Versioning. grouped for a particular automated use. Alfresco provides two different types of workflow: simple and advanced. which must be removed to activate the file. Adhoc Task).2 . Each store contains a hierarchy of nodes with one root node. Many of the files have a . Two main stores in Alfresco are the Document Management (DM) and the Advanced Versioning Manager (AVM) stores.

Sign up to vote on this title
UsefulNot useful