Cacoo Enterprise

Installation Manual

Nulab, Inc.The thrid EditionJanuary 23, 2012

Update HistoryVersion Date Changes

1 March 30, 2011

First edition

2 March 31, 2011

SSL+Reverse Proxy settings, Additional notes for SMTPAuth

3 January 23, 2012

Added description about wkhtmltoimageAdded description about creating custom stencils and managing samples

Contents

System RequirementsServer - HardwareServer - SoftwareClient

Contents of packageInstalling wkhtmltopdfExample of installing wkhtmltopdfInstalling pdftopsInstalling FontExample of installing ImageMagick

ver6.6.6 or later can be installed using yumver6.6.6 or later cannot be installed using yum

Installation1. Create database2. Create table3. Place Cacoo

Check placementDetermining the settings error

4. Cacoo SettingsChange DB connection (optional)Change mail server (optional)1. Use SMTP server without authentication2. Use SMTP server without authenticationChange ImageMagick’s install pass (optional)Change wkhtmltopdf and pdftops’s install pass (optional)Change http/https, port number (optional)httpScheme=http

Initial SettingsPackage maintenanceChange passwordSet email addressManage teamDeleting an accountChanging the users’ rolesChanging the account informationManaging samplesManaging customized stencils

Other informationBackupAccess Cacoo through Apache（port 80, mod_proxy_http）

System Requirements

Server - HardwareCPU 2.5GHz or above

Memory 4GB or above

Harddisk 100GB or above

Server - SoftwareOS Linux (RHEL 5 or CentOS 5)

Database PostgreSQL 8.4

Web Server Tomcat 6.0.29

Java Java6_u23(JDK from Sun)

SMTP Server SMTP server that can send emails without SMTP authentication.Sendmail, which comes with Red Hat Enterprise Linux or CentOS by default can be used.

For Image Processing

ImageMagick ver 6.6.6 or above

For PDF wkhtmltopdf 0.10.0 rc2 (http://code.google.com/p/wkhtmltopdf/)

For PostScript pdftops (xpdf) 3.02

Font VLGothic, IPAFont, urw-Fonts

ClientBrowser IE, FireFox, Safari (only on Mac), Chrome(only on Win)

FlashPlayer FlashPlayer 10

Contents of packagecacoo.war cacoo, the application itself (Context pass is /cacoo)

ROOT.war cacoo, the application itself (Context pass is / )

create_table.sql SQL for creating DB table

update_all.sql SQL for adding stencil data

package.sql SQL for Cacoo Enterprise

install_doc.pdf Installation manual (this document)

blazeds_patch.zip Patch for BlazeDS revision file

cacoo.war and ROOT.war are the same module except their context pass settings are differently.Please use /cacoo context pass for cacoo.war and/ for ROOT.war. It cannot changed to other context passes.

PreparationPlease install the modules listed under System Requirements: Server - Software.

● Java● Tomcat● PostgreSQL● SMTP Server● ImageMagick● wkhtmltopdf● pdftops (xpdf)● Font

Installation method varies depending on the environment. The example below shows when the modules are installed on CentOS (i386) .

Installing wkhtmltopdfmkdir -p /root/temp/wkhtmltopdfcd /root/temp/wkhtmltopdfwget http://wkhtmltopdf.googlecode.com/files/wkhtmltopdf-0.10.0_rc2-static-i386.tar.bz2tar jxfv wkhtmltopdf-0.10.0_rc2-static-i386.tar.bz2mv wkhtmltopdf-i386 /usr/local/bin/wkhtmltopdfwkhtmltopdf --verions Check installation and version/user/local/bin/wkhtmltopdf -version

Example of installing wkhtmltopdfmkdir -p /root/temp/wkhtmltoimagecd /root/temp/wkhtmltoimagewget http://wkhtmltopdf.googlecode.com/files/wkhtmltoimage-0.10.0_rc2-static-i386.tar.bz2tar jxfv wkhtmltoimage-0.10.0_rc2-static-i386.tar.bz2mv wkhtmltoimage-i386 /usr/local/bin/wkhtmltoimage Check installation and version/usr/local/bin/wkhtmltoimage --versions

Installing pdftops

yum install t1lib-devel libpaper-develyum install freetype freetype-develyum install libXft-devel libXmu-devel libXp-develyum install gcc-c++mkdir -p /root/temp/pdftopscd /root/temp/pdftopswget ftp://ftp.foolabs.com/pub/xpdf/xpdf-3.02.tar.gztar xzf xpdf-3.02.tar.gzcd xpdf-3.02./configure --with-freetype2-includes=/usr/include/freetype2 --with-Xm-includes=/usr/include/X11/Xmumakemake install Check installation and version/usr/local/bin/pdftops -v

Installing Fontyum install fonts-japanese -y yum install VLGothic-fonts.noarch VLGothic-fonts-proportional.noarch -y mkdir /usr/temp/ipafontcd /usr/temp/ipafontwget http://ossipedia.ipa.go.jp/ipafont/ipag00302.phpwget http://ossipedia.ipa.go.jp/ipafont/ipagp00302.phpunzip ipag00302.zipunzip ipagp00302.zipcp ipag00302/ipag.ttf /usr/share/fonts/japanese/cp ipagp00302/ipagp.ttf /usr/share/fonts/japanese/ yum install urw-fonts.noarch -y

Example of installing ImageMagick

ver6.6.6 or later can be installed using yumyum install ImageMagick

ver6.6.6 or later cannot be installed using yumwget http://packages.sw.be/rpmforge-release/rpmforge-release-0.5.2-2.el5.rf.i386.rpmrpm -ivh rpmforge-release-0.5.2-2.el5.rf.i386.rpmwget http://www.imagemagick.org/download/linux/SRPMS/ImageMagick-6.6.6-10.src.rpmrpm -ivh --nomd5 ImageMagick-6.6.6-10.src.rpm

wget http://centos.karan.org/el5/extras/testing/i386/RPMS/jasper-libs-1.900.1-7.el5.kb.i386.rpmwget http://centos.karan.org/el5/extras/testing/i386/RPMS/jasper-devel-1.900.1-7.el5.kb.i386.rpmyum install libjpeg-develrpm -ivh jasper-libs-1.900.1-7.el5.kb.i386.rpm jasper-devel-1.900.1-7.el5.kb.i386.rpmyum install djvulibre-develyum install giflib-devel libwmf-devel libtool-ltdl-devel librsvg2-develcd /usr/src/redhat/SPECSperl -pi'.orig' -e 's/BuildRequires: libtiff-devel, giflib-devel, zlib-devel, perl-devel.*$/BuildRequires: libtiff-devel, giflib-devel, zlib-devel/' ImageMagick.specunset MODULEBUILDRC PERL_MM_OPT PERL5LIBexport PATH=/usr/kerberos/sbin:/usr/kerberos/bin:/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/binyum install rpm-buildyum install bzip2-develyum install libtiff-develyum install ghostscript-develyum install libXt-develyum install lcms-develyum -y install gcc gcc-c++rpmbuild -ba ImageMagick.specrpm -Uvh /usr/src/redhat/RPMS/i386/ImageMagick-6.6.6-10.i386.rpm　/usr/src/redhat/RPMS/i386/ImageMagick-devel-6.6.6-10.i386.rpm /usr/src/redhat/RPMS/i386/ImageMagick-perl-6.6.6-10.i386.rpm Check installation and version/user/bin/convert -version

Installation

1. Create databaseCacoo connects to the database using the following setting for the initial setting.

Host localhost

Port 5432

Database name cacoo

Database user name postgres

Database password postgres

Abobe settings can be changed in settings file. e.g. Command for creating (Text in black is input part.)

$ psqlpostgres=# create database cacoo;CREATE DATABASE

postgres=# \l List of databases Name | Owner | Encoding-----------+----------+----------cacoo | postgres | UTF8

2. Create table[Content] Create table using create_table.sql.[Content] Create table using update_all.sql.[Content] Create table using package.sql. e.g. Command for creating (Text in black is input part.)

$ psql cacoocacoo=# \i create_table.sqlBEGINCREATE SEQUENCE

CREATE SEQUENCE…ALTER TABLECOMMIT

cacoo=# \i update_all.sqlINSERT 0 1INSERT 0 1...INSERT 0 1

cacoo=#

cacoo=# \i package.sqlINSERT 0 1INSERT 0 1...CREATE TABLEINSERT 0 1

cacoo=#

3. Place CacooThis document describes the way to place the context pass, “ /cacoo”, using cacoo.war. Please replace with the context pass, “/” if you are using Root.war. [Content] Place cacoo.war in {tomcat’s directry}/webapps.If tomcat has not been started, start tomcat. Starting takes some time so please access after 30 seconds or so.

Check placementPlease make sure you can display the login page on the URL below.http://(installed host)/cacoo/e.g.. http://localhost:8080/cacoo/ If the page cannot be displayed, please check:

● tomcat is started?● Module is on {tomcat’s directry}/webapps/cacoo?● Database is connected?● Database connection is correct?

Determining the settings error

Server doesn’t return the Please check that tomcat is working proberly.

process

Server cannot be found URL might be wrong or tomcat is not working.

HTTP status 500 error Database connection might be not correct. Please check tomcat log.

Loading stencils does not finish after starting the editor

update_all.sql might be not executed.

4. Cacoo Settings

Change DB connection (optional)Please open {tomcat’s directory}/webapps/cacoo/WEB-INF/classes/jdbc.dicon with text editor. You’ll find the following part after approximately 16th line.

<component name="xaDataSource"class="org.seasar.extension.dbcp.impl.XADataSourceImpl"><property name="driverClassName">

"org.postgresql.Driver"</property><property name="URL">

"jdbc:postgresql://localhost:5432/cacoo?protocolVersion=2"</property><property name="user">"postgres"</property><property name="password">"postgres"</property>

</component> Modify the settings depending on your environment and restart tomcat.

Change mail server (optional)

1. Use SMTP server without authentication

Please open {tomcat’s directory}/webapps/cacoo/WEB-INF/classes/cacoo.dicon with text editor. You’ll find the following part after approximately 19th line.

<component class="java.lang.String" name="smtpHost"><description>SMTP host name</description><arg>"localhost"</arg>

</component> Modify the settings depending on your environment and restart tomcat.

2. Use SMTP server without authentication

In addition to the change in 1., the following setting is required. Please open {tomcat’s directory}/webapps/cacoo/WEB-INF/classes/mail.dicon with text editor.Add username and password in 2 different places. <!-- mail send class --> <component class="com.ozacc.mail.impl.SendMailImpl"> <property name="username">"xxxxxxx"</property> <property name="password">"xxxxxxx"</property> <property name="host">cacoo.smtpHost</property> <property name="charset">"UTF-8"</property> <aspect pointcut="send"><componentclass="cacoo.interceptor.AsyncInterceptor" /></aspect> </component> <!-- mail send class(Pro) --> <component class="com.ozacc.mail.impl.SendMailProImpl" instance="prototype"> <property name="username">"xxxxxxx"</property> <property name="password">"xxxxxxx"</property> <property name="host">cacoo.smtpHost</property> <property name="charset">"UTF-8"</property> </component> Modify username and password depending on your environment and restart tomcat.

* POP3 is not used.

Change ImageMagick’s install pass (optional)Please open {tomcat’s directory}/webapps/cacoo/WEB-INF/classes/im4java.properties with text editor.

toolPath=/usr/bin Modify the settings depending on your environment and restart tomcat.

Change wkhtmltopdf and pdftops’s install pass (optional)Please open {tomcat’s directory}/webapps/cacoo/WEB-INF/classes/web.properties with text editor. You’ll find the following part after approximately 6th line.

wkhtmltopdfPath=/usr/local/bin/wkhtmltopdfwkhtmltoimagePath=/usr/local/bin/wkhtmltoimagepdftopsPath=/usr/local/bin/pdftops

Modify the settings depending on your environment and restart tomcat.

Change http/https, port number (optional)Please open {tomcat’s directory}/webapps/cacoo/WEB-INF/classes/web.properties with text editor.

httpScheme=http

httpPort=8080httpsScheme=httphttpsPort=8080

Modify the settings depending on your environment and restart tomcat.

Initial Settings

Access http://(installed host)/cacoo/.When you see the log in page, log in with Cacoo ID:admin and password：cacoo .

Package maintenanceAfter you log in, the package maintenance page will be displayed.Please enter the license code and other email addresses, sent separately.

License Code To use application, license code is required.Please enter the license code provided to register.When you see “License is activated”, you can use this application.

Sender email address for notification mails

When users are invited to the diagrams, Cacoo sends notification mails. Please specify the email address of the sender (From).

Return-to email address for notification mails

When users are invited to the diagrams, Cacoo sends notification mails. Please specify the email address to reply (Reply-to).

About license codeTo use this application, licence code is necessary.Without license code, this application cannot be used. Customers with license code will see the license information on the bottom of the site and “About Cacoo (shown when Cacoo logo is clicked)”. This setting cannot be changed.Also, for license code with time limited will not be able to use most pages after the end of the term. For issuing license code, please contact Nulab, Inc.

Change passwordPlease change password on Settings > Password tab.

Set email addressPlease change email address on Settings > Email tab.

Manage teamInvitation mail can be set from Settings > Manage team.

The status changes to “Joined the team”. Until then, the status will be shown as “Invited” in the list.New users who is not invited but registered from “Sign up” page will be automatically added to this list.

Please note that once the number of users for the license reaches to its maximum number, other people will not be able to sign up or invited.

Deleting an accountTo delete an account, press the “Remove Account” button on the Manage Team page. Please note that the diagrams that this user has created will be deleted also. To keep the diagrams, please share the diagrams to other users and let them copy

the diagrams.

Changing the users’ rolesUsers’ roles can be changed by pressing the “Change to Administrator” or “Change to User” link on the Manage Team page. Administrators will be able to change the settings.The original Admin users cannot be modified.

Changing the account informationAdministrators cannot change other users’ names nor email addresses.Please ask the users to change their settings from “Settings” tab.

Managing samplesThe default diagrams can be preset so that users will see them when they sign in.Create a diagram and set the diagram’s URL from the settings page.To delete the sample, press “Delete from samples” button. The original diagram will not be deleted.Please note that deleting the original diagram will delete it from the samples.

Managing customized stencilsManage the stencils that are available for all uses using this package.Create a diagram like creating a regular diagram or a sample. Save it as “Stencil”.Set the URL on the settings page.

Changes to the stencils will be automatically applied to the registered stencils. To delete the stencil, press “Delete from stencils” button. The original diagram will not be deleted.Please note that deleting the original diagram will delete it from the samples.The stencils will be listed as they were added and the order cannot be changed. To change the order, please delete them and add them again.

Other information

BackupRequired information are stored in Database.Please backup Dababase with PostgreSQL functionality.

Access Cacoo through Apache（port 80, mod_proxy_http）When the application is run under reverse proxy, the following setting is required.Please stop tomcat, follow the instruction below and start tomcat again.

1. Download RemoteIpValve library, place in tomcat’s lib directory.( http://code.google.com/p/xebia-france/wiki/RemoteIpValve )http://xebia-france.googlecode.com/files/xebia-tomcat-extras-1.0.0.jar 2. Add Value setting in tomcat‘s server.xml.---------------------------------------------------------------------- <Host name="localhost" appBase="webapps" unpackWARs="true" autoDeploy="true" xmlValidation="false" xmlNamespaceAware="false"> ... <!-- here --> <ValveclassName="org.apache.catalina.connector.RemoteIpValve"protocolHeader="x-forwarded-proto" /> ...---------------------------------------------------------------------- Also, the settings shown in “Change http/https, port number (optional)” in this installation manual is required.httpScheme=httphttpPort=80httpsScheme=httpshttpsPort=443