Installing Alfresco on Ubuntu 7.10
From AlfrescoWiki
Back to Installing_on_Linux
See also Installing Alfresco on Ubuntu 8.04 which describes a few things that you need to do differently
This document describes the installation of Alfresco on Ubuntu 7.10. This installs Alfresco 'the Linux way':
- Runs Alfresco as the alfresco user
- Stores repository files in /var/lib/alfresco
- Stores logging in /var/log/alfresco
- Keep a PID file to prevent starting Alfresco twice
- Run headless OpenOffice using the xvfb dummy X server
Contents |
[edit] sudo actions
By default, Ubuntu uses the sudo command, meaning "switch users during operation", for actions that require root access. If you are not root remember to prepend all actions that require root access with 'sudo'. Like so:
sudo apt-get install mysql-server
You may want to enable the root user for ease of intallation:
sudo su
[edit] Install required packages
The MySQL database server:
apt-get install mysql-server
The dummy X server required for openoffice.org:
apt-get install xvfb
OpenOffice for document transformations:
apt-get install openoffice.org
The iptables package required for using the CIFS, FTP, NFS or FTP while running as non-root user:
apt-get install iptables
The Sun Java Development Kit(jdk)required for Tomcat to function. The sun-java6-jre and sun-java6-bin packages will be installed automatically with the jdk:
apt-get install sun-java6-jdk
Imagemagick for image transformation:
apt-get install imagemagick
Portmapper for required for NFS server:
apt-get install portmap
NFS common package required for NFS server:
apt-get install nfs-common
[edit] Java
Add this line to /etc/profile to set JAVA_HOME:
export JAVA_HOME="/usr/lib/jvm/java-6-sun"
[edit] Create the alfresco user and group
groupadd alfresco useradd -m -g alfresco alfresco
The alfresco user needs a home directory for OpenOffice, hence the '-m'. The alfresco user never needs to log in, there should be a '!' for the password in the /etc/shadow entry. If not, put it there.
[edit] Install Alfresco Tomcat bundle
Unpack the tarball:
mkdir /opt/alfresco cd /opt/alfresco tar -xzf alfresco-enterprise-tomcat-2.1.1.tar.gz
Important!!! Make sure that /opt/alfresco/tomcat/ and below is owned by alfresco:
chown -R alfresco:alfresco /opt/alfresco/tomcat/
[edit] Create the database
Using the mysql command line client:
create database alfresco; grant all privileges on alfresco.* to alfresco@localhost identified by 'alfresco';
(Choose your own password, just make sure it matches what you configure in custom-repository.properties later on)
[edit] Create directories for variable data
Create space for the repository, the cache and make the user and group alfresco its owner:
mkdir -p /var/lib/alfresco/alf_data mkdir /var/lib/alfresco/tmp
chown -R alfresco:alfresco /var/lib/alfresco
Create a directory for the logs and make the user and group alfresco its owner:
mkdir -p /var/log/alfresco/tomcat/logs
chown -R alfresco:alfresco /var/log/alfresco
The Alfresco log will be in /var/log/alfresco/alfresco.log.
[edit] Configure the repository
Create custom-repository-context.xml in the extensions directory (/opt/alfresco/tomcat/shared/classes/alfresco/extension), if it is not already there:
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE beans PUBLIC '-//SPRING//DTD BEAN//EN' 'http://www.springframework.org/dtd/spring-beans.dtd'>
<beans>
<!-- overriding to point to custom properties -->
<bean id="repository-properties" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<property name="ignoreUnresolvablePlaceholders">
<value>true</value>
</property>
<property name="locations">
<list>
<value>classpath:alfresco/repository.properties</value>
<value>classpath:alfresco/version.properties</value>
<value>classpath:alfresco/domain/transaction.properties</value>
<!-- Override basic repository properties -->
<value>classpath:alfresco/extension/custom-repository.properties</value>
</list>
</property>
</bean>
<bean id="hibernateConfigProperties" class="org.springframework.beans.factory.config.PropertiesFactoryBean">
<property name="locations">
<list>
<value>classpath:alfresco/domain/hibernate-cfg.properties</value>
<!-- Override hibernate dialect -->
<value>classpath:alfresco/extension/custom-hibernate-dialect.properties</value>
</list>
</property>
</bean>
</beans>
Change configuration files in extension/ directory.
Change repository configuration custom-repository.properties (uncomment/comment corresponding lines and add values where missing):
dir.root=/var/lib/alfresco/alf_data db.username=alfresco db.password=alfresco db.pool.initial=10 db.pool.max=100 #db.driver=org.hsqldb.jdbcDriver #db.url=jdbc:hsqldb:file:alf_data/hsql_data/alfresco;ifexists=true;shutdown=true; db.driver=org.gjt.mm.mysql.Driver db.url=jdbc:mysql://localhost/alfresco
Change the hibernate configuration custom-hibernate-dialect.properties (uncomment/comment corresponding lines):
#hibernate.dialect=org.hibernate.dialect.HSQLDialect hibernate.dialect=org.hibernate.dialect.MySQLInnoDBDialect
To configure the CIFS server to use non-privileged ports use the following in either file-servers.xml or file-servers-custom.xml configuration file (whichever is present), in the section <config evaluator="string-compare" condition="CIFS Server">:
<tcpipSMB port="1445" platforms="linux,solaris,macosx"/>
<netBIOSSMB sessionPort="1139" namePort="1137" datagramPort="1138" platforms="linux,solaris,macosx"/>
If this section is missing (it is not in file-servers-custom.xml in my install), add it, so that you have:
<alfresco-config area="file-servers">
<config evaluator="string-compare" condition="CIFS Server">
<serverEnable enabled="true"/>
<host name="${localname}_A"/>
<comment>Alfresco CIFS Server</comment>
<broadcast>255.255.255.255</broadcast>
<tcpipSMB platforms="linux,solaris,macosx"/>
<netBIOSSMB platforms="linux,solaris,macosx"/>
<tcpipSMB port="1445" platforms="linux,solaris,macosx"/>
<netBIOSSMB sessionPort="1139" namePort="1137" datagramPort="1138" platforms="linux,solaris,macosx"/>
<hostAnnounce interval="5"/>
<sessionDebug flags="Negotiate,Socket"/>
</config>
at the start of the file-servers-custom.xml file.
[edit] Configure logging
Tomcat logging is hard to change because some of the tomcat scripts write to the log directory directly. To move the logs away from the program files we use a symbolic link. Remove the logging directory and create a symlink instead:
rm -r /opt/alfresco/tomcat/logs ln -s /var/log/alfresco/tomcat/logs /opt/alfresco/tomcat/logs
Configure Alfresco logging: In tomcat/webapps/alfresco/WEB-INF/classes/log4j.properties modify line
log4j.appender.File.File=alfresco.log
to read
log4j.appender.File.File=/var/log/alfresco/alfresco.log
(NOTE: this step needs to be done after Alfresco was started once, as tomcat/webapps/alfresco/ subtree only appears after alfresco.war in tomcat/webapps/ is deployed. So skip this step for now, start Alfresco once, verify that tomcat/webapps/alfresco/WEB-INF/classes/log4j.properties was unpacked, stop Alfresco, do the change, then start Alfresco again):
[edit] Init script
Store the following script as /etc/init.d/alfresco:
#
# Alfresco init script for Ubuntu
# 2 nov 2007 Joost Horward
#
export ALFRESCO_HOME=/opt/alfresco
export CATALINA_BASE=/opt/alfresco/tomcat
export CATALINA_HOME=/opt/alfresco/tomcat
export PIDFILE=/var/run/alfresco
export LOGFILE=/var/log/alfresco/alfresco.log
# Set any default JVM values
export JAVA_OPTS='-Xms128m -Xmx512m -server -Djava.io.tmpdir=/var/lib/alfresco/tmp'
cd "$ALFRESCO_HOME"
#
# redirect FROM TO PROTOCOL
# setup port redirect using iptables
redirect() {
echo "Redirecting port $1 to $2 ($3)"
iptables -t nat -A OUTPUT -d localhost -p $3 --dport $1 -j REDIRECT --to-ports $2
iptables -t nat -A PREROUTING -d $HOSTNAME -p $3 --dport $1 -j REDIRECT --to-ports $2
iptables -t nat -A OUTPUT -d $HOSTNAME -p $3 --dport $1 -j REDIRECT --to-ports $2
}
#
# setup_iptables
# setup iptables for redirection of CIFS and FTP
setup_iptables () {
echo "1" >/proc/sys/net/ipv4/ip_forward
# Clear NATing tables
iptables -t nat -F
# FTP NATing
redirect 21 2021 tcp
# CIFS NATing
redirect 445 1445 tcp
redirect 139 1139 tcp
redirect 137 1137 udp
redirect 138 1138 udp
}
#
# start_openoffice
#
start_openoffice(){
sudo -H -u alfresco xvfb-run /usr/lib/openoffice/program/soffice "-accept=socket,host=localhost,port=8100;urp;StarOffice.ServiceManager" -nologo -headless -nofirststartwizard &
}
case $1 in
start)
if [ -f $PIDFILE ] ; then
echo "Alfresco is already running!"
exit 1
fi
touch $PIDFILE
echo "Starting OpenOffice service ..."
start_openoffice
echo "Setting up iptables ..."
setup_iptables
echo "Starting Alfresco ..."
echo -e "\n\n\n\n\n\n\n\n\n\n`date` Starting Alfresco ..." >>$LOGFILE
sudo chown alfresco:alfresco $LOGFILE
sudo -H -u alfresco sh $CATALINA_HOME/bin/startup.sh
;;
stop)
sudo -H -u alfresco sh $CATALINA_HOME/bin/shutdown.sh
killall -w -u alfresco
echo -e "`date` Stopping Alfresco ..." >>$LOGFILE
rm $PIDFILE
;;
restart)
rm $PIDFILE
sudo -H -u alfresco sh $CATALINA_HOME/bin/shutdown.sh
killall -w -u alfresco
echo -e "\n\n\n\n\n\n\n\n\n`date` Restarting Alfresco ..." >>$LOGFILE
sudo -H -u alfresco sh $CATALINA_HOME/bin/startup.sh
touch $PIDFILE
;;
zap)
echo "Zapping $PIDFILE ..."
rm $PIDFILE
;;
*)
echo "Usage: alfresco [start|stop|restart|zap] [tail]"
exit 1
;;
esac
case $2 in
tail)
tail -f $LOGFILE
;;
esac
exit 0
Make sure that you set the script to be executable:
chmod +x /etc/init.d/alfresco
[edit] Run Alfresco
/etc/init.d/alfresco start|stop|restart|zap [tail]
(Don't forget that you need be a root, or use
sudo /etc/init.d/alfresco start|stop|restart|zap [tail]
command, e.g.
sudo /etc/init.d/alfresco start
to start Alfresco). The tail option just starts a new tail -f on the alfresco log. Alfresco will populate the repository (Database and filesystem) on first start.
After starting alfresco, point your browser at to http://localhost:8080/alfresco.
