Obsolete Pages{{Obsolete}}
The official documentation is at: http://docs.alfresco.com
This is a Work in Progress.
If you find links to other pages in this wiki that relate to the topic listed, please feel free to add them on this page. If not, we encourage you to write new related content.
Before Installing
Installation Files
SharePoint Protocol Support
Alfresco WCM
Alfresco Web Service Client
Alfresco SDK and APIs
Extensions
Microsoft Office Add-ins
Software Requirements
Installing a JDK
Verifying the JAVA_HOME environment variable location
In the file {JBOSS_HOME}\bin\run.conf, update the JAVA_HOME variable to be the folder that JDK was installed into.
Installing MySQL
thumb|alt=Alfresco Schema|Alfresco Schema Creation
thumb|alt=Create New User|Alfresco New User
thumb|alt=Updating Privileges |Alfresco Updating Privileges
When deploying Alfresco to utilize MySQL as its datastore, there are 2 required downloads to achieve this type of environment.
- MySQL Community Server - The more recent versions should suffice.
- MySQL JDBC Driver - This JAR file should be copied to {JBOSS_HOME}\server\default\lib.
Another useful tool is MySQL Administrator. Instead of using command line entries, one can use this graphical user interface to manage both local and remote instances of MySQL.
Once MySQL is installed, the user and database will need to be created.
Screenshots on the right depicts creating a new schema, user and assigning privileges.
Installing JBoss
- Download JBoss Application Server from JBoss Downloads.
- Expand the zip file to the target server. (i.e. c:\jboss). Set your environment variable, JBOSS_HOME, to be the location that the zip file was expanded to. For example, if the zip file was expanded to c:\jboss, then the environment variable should be look as such:
JbossHomeEnvironmentVariable.png
Configuration Changes
- Change the following in file {JBOSS_HOME}\server\default\deploy\ejb3.deployer\META-INF\persistence.properties:
From:hibernate.bytecode.provider=javassist
To:
hibernate.bytecode.provider=cglib
- Optional: Adding
set NOPAUSE=true
to the beginning of {JBOSS_HOME}\bin\run.bat and {JBOSS_HOME}\bin\shutdown.bat will remove the need to 'Press any key to continue . . . '
JAR Files
If MySQL is the target database, then perform the following:
- Download MySQL Driver from MySQL Downloads.
- Save the driver into the {JBOSS_HOME}/server/default/lib folder. For any other application server, save the JDBC driver in a folder that is in the application server classpath.
Installing Alfresco
Windows
Full installation
Excluding JDK
Alfresco Tomcat bundle
Redhat Linux
Alfresco Tomcat bundle
Mac
Alfresco WAR on any platform
Alfresco components
Alfresco WCM
OpenOffice
After downloading the appropriate version from OpenOffice Downloads, it needs to be installed. Where it is installed is important for a couple reasons:
- Must be accessible from Alfresco deployment application server.
- Application server must have permission to execute the binaries.
After installing OpenOffice, you will need to inform Alfresco the OpenOffice installation information. The best way to do it is to add the properties as follows in your alfresco.war\WEB-INF\classes\alfresco-global.properties file:
# Path to OpenOffice executable
ooo.exe={ABSOLUTE OPEN OFFICE INSTALLATION PATH}/program/soffice
# Path to store OpenOffice User information
ooo.user=${dir.root}/oouserImageMagick
Alfresco Community Edition 3.2, like past editions, require binaries of ImageMagick. Binaries can be downloaded from ImageMagick's Download page. Once the proper version has been downloaded, it needs to be installed where Alfresco has the accessibility and permission to execute the convert utility.
When running in a Windows environment, set the environment variable 'PATH' as such:
ImageMagickPathVariable.png
This value assumes that ImageMagick was installed at this location.
Lastly, there is a property img.root in the repository.properties file. One can override this value by use of the file alfresco.war/WEB-INF/classes/alfresco-global.properties. Adding an img.root entry with the aforementioned location (c:/ImageMagick) will allow Alfresco to execute the convert binary.
More info at ImageMagick Configuration.
Microsoft Office add-ins
Flash Player
SWF tools
SWF tools can be downloaded from the SWFTools Downloads. Once the appropriate version has been downloaded, it will need to be installed so that Alfresco has access and permission to execute the pdf2swf.exe binary. This utility is used to display PDF documents in a Flash application when viewing the document detail in Alfresco Share.
Once installed, override the swf.exe property defined in repository.properties with an entry in alfresco.war/WEB-INF/classes/alfresco-global.properties file. For example if SWFTools was installed in C:\SWFTools then the entry in alfresco-global.properties should have this entry: swf.exe=C:/SWFTools/pdf2swf
TinyMCE language packs
Alfresco Module Package (AMP)
Microsoft Office SharePoint Protocol Support
Running Alfresco
Starting and stopping the Alfresco server
Starting Alfresco Share
Starting Alfresco Explorer
Starting and stopping the Alfresco virtualization server
Starting and stopping the deployment engine
Configuring Alfresco
Configuration overview
Global properties
Upgrading configurations to Community Edition 3.2
Modifying Spring bean definition files
Modifying system configuration files
Customizing individual configuration items
Customizing Alfresco Share
Configuring databases
Out of the box, Alfresco 3.2 Community Edition has been configured as follows:
db.name=alfresco
db.username=alfresco
db.password=alfresco
These values have been defined in alfresco.war\WEB-INF\classes\alfresco\repository.properties. Additionally, out-of-box, Alfresco is also configured to deploy to MySQL. This means you will have to create a catalog, user and password using 'alfresco'. Should these values require something different, customization configuration files will be needed as part of this deployment. The user that was created for the instance of Alfresco should have all permissions assigned until needed to lock down security (for production mode).
Configuring core services
Tuning the JVM
Command line configuration
Customizing dir.root
Configuring the repository cache
Configuring extended services
Adding a MIME type
Configuring metadata extraction
Versioning
Setting up replication
Configuring the connection pool
Customizing content transformations
Configuring Alfresco subsystems
Configuring authentication
Configuring synchronization
Configuring file servers
Configuring the email server and email service
IMAP Protocol support
Configuring Web Content Management
Configuring the virtualization server
WCM deployment
Troubleshooting
Debugging an Alfresco installation
Setting log levels
Testing and debugging links
Error messages
Troubleshooting NFS
Troubleshooting CIFS
OpenLDAP tips
Active Directory tips
Installation
Community Edition
3.2