Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To download the various packages or upgrade to a new version, visit the download area of our homepage www.communote.com/homepage/download/.

1.2 Preparation

The following hardware requirements are recommended:

...

Code Block
languagesql
CREATE USER "COMMUNOTE" PROFILE "DEFAULT" IDENTIFIED BY "*******" DEFAULT TABLESPACE "COMMUNOTE" TEMPORARY TABLESPACE "TEMP" ACCOUNT UNLOCK

GRANT UNLIMITED TABLESPACE TO "COMMUNOTE"
GRANT "CONNECT" TO "COMMUNOTE"
GRANT "CTXAPP" TO "COMMUNOTE"
GRANT "RESOURCE" TO "COMMUNOTE"

 

1.3 Installation with the Installerscript for Linux

Remark: The installer script has been only tested on a Gentoo (up to date configuration as of Q3 2010) and for Ubuntu 10.04 LTS. You should only use the installer script for those distributions. Also make sure that your system has a current version (at least 4.1.3) of the shadow package installed.

...

At the end of the installation procedure Communote will be started and you can continue with the installation using the web interface (see section 1.8 ).

1.4 Installation without Installerscript

For an installation without the installer script you will have to use one of the packages without the JRE (see section 1.1.). Use the tar.gz on Linux and .zip on Windows platforms. To install Communote from these packages follow the instructions below:

...

Continue the installation with the web interface (see section 1.8).

1.5 Installation as WAR

You can install Communote without the predefined packages. However, this is only recommended for experienced users. You have to execute the following steps (Note: For the installation of the required software please use the installation guides of the corresponding software vendors):

...

  1. Create a Communote data directory for storing attachments and application data at a preferred location, for example communote-data. The Tomcat user must have read  and write access.
  2. Create a subdirectory communote in the directory conf of the Tomcat installation.
  3. Create a file startup.properties in the folder you just created (conf/communote).
  4. In this file you have to define the absolute path to the data directory of Communote you just created. This is done by adding the following line: communote.data.dir=C\:/Communote/Data Note for Windows: In front of the colon ":" a backslash "\" must be added and all backslashes in the path must be replaced by  normal slashes "/". Instead of "C:\Communote\Data" write "C\:/Communote/Data".
  5. Open the file context.xml in the conf directory of theTomcat installation and add the following lines in between the elements <context  …> and </context> . Replace the value for communote.config.dir with the absolute path to the startup.properties:

    (info) The path must be in the format of your operating system. (Slash in Linux and Backslash in Windows). Escaping characters as in step 4 is not necessary. 

    Code Block
    languagehtml/xml
    <Environment name="communote.instance.name"
                 type="java.lang.String"
                 value="communote" />
    
    <!-- 
      value="Absolute path to the directory that contains startup.properties without any escaping"
      Example Windows: value="C:\communote"
      Example Linux:   value="/opt/communote"
    -->
    <Environment name="communote.config.dir"
                 type="java.lang.String"
                 value="Absolute path to the directory that contains startup.properties without any escaping" />
    
  6. Now you can start your Tomcat and proceed with the installation using the web interface (see section 1.8).

1.6 Further configuration

For a stable Communote, the java system parameteres have to be adjusted. The JAVA_OPTS parameter must be set . The Tomcat has usually a "setenv.bat" / "setenv.sh" available to supplement the parameter

...

The parameter -server must not be set on a 32bit platform.

1.7 Update of Communote

For updating Communote it is necessary to update only a part of the installation Prior to the update:

...

Should the support of your license be expired, a message similar to the following will appear. You can do the update but should note that a valid license is required to get all the features of Communote. It is possible to install a valid license after the update.
  Figure 1 5: Message

1.8 Final Installation with Web Interface

Start your web browser for the final installation and go to the homepage of your own Communote instance. By default it is accessible on the same host at http://localhost:8080/. Now you should see the start screen of the web installer (Figure 1 6). Follow the single steps. After a successful installation the installer should forward you to the login page of your Communote instance. There, you can log in with your previously specified login data.
 

...

Figure 1 16: Communote Start Page

1.9 Congratulations to the successful installation of Communote!

In case you have questions or suggestions to the Communote installation  or Communote itself, please feel free to contact our customer service by  email support@communote.com. In case errors occur during the installation, you may try to restart  Communote. In the log files of Communote (see chapter 5 of the  Administration manual) you may find more detailed information about  errors during the installation.

2. Installation and Configuration of Openfire

2.1 Introduction

If you want to use the XMPP integration with Communote you have to install Openfire. At the moment version 3.6.4 is supported.

2.2 Installation of Openfire

Install Openfire using the packet management of your operating system or download it from the Linux version from the Openfire website: http://www.igniterealtime.org/downloads/index.jsp.

Anchor
_Toc254345563
_Toc254345563
Download the Windows version from the Openfire website: http://www.igniterealtime.org/downloads/index.jsp. It is recommended to use the installer version for windows.

2.3 Starting the Openfire Installation

  1. In Linux, start Openfire as follows: Go to the directory <openfire.install.dir> and enter ./openfire start.  In Windows you can start or stop Openfire using the start menu.
  2. Openfire will be started in the background and the administration console will be available under this URL: http://localhost:9090. Go to this URL and follow the installation instructions.
  3. Choose your language.
  4. Configure the server settings: Please check the host name.
  5. Configure the database: Choose "Default database connection".
  6. Configure the database settings: It is recommended but not necessary to use the same database type as you have chosen for Communote. Before the database can be initialized you have to create it. Execute the following SQL statements on your database, replace openfire_db_name with the database name and communote_db_user_name with the database username:
    • For  MySQL use: "CREATE DATABASE openfire_db_name CHARACTER SET UTF8;".
    • For PostgreSQL use: "CREATE DATABASE openfire_db_name OWNER communote_db_user_name encoding='utf8'".
  7. Profile Settings: Please use the default settings.
  8. Administration account: Please enter the login and password for the initial administration account.
  9. Now you can login with the administration account using the following URL http://localhost:9090. By default the username is "admin" and the password is the one you specified before.

2.4 Configuration of Openfire for Communote

The Communote Installer contains two plug-in for Communote. Please copy those to the following destinations:

...

  1. The login of the administrator and the login of the user created  before must be defined in the property file. The password must  be stored as SHA-1 Hash. With Linux The SHA-1 Hash can be computed as follows:      printf 123456 | sha1sum Add the following lines to the http-auth.properties file:

    Code Block
    allowed_user[0].user=admin
    allowed_user[0].password=*SHA1-Passwort*
    allowed_user[1].user=bot.communote
    allowed_user[1].password=*SHA1-Passwort*
    
  2. Check the settings in "url=".
  3. In the Openfire administration, go to Server -> Server  Administration -> System Settings.
  4. Add a new property (or change it if it already exists):  Name: provider.auth.className  Value:  de.communardo.xmpp.openfire.auth.HTTPRequestAuthProvider.
  5. Now restart Openfire to activate these changes.

2.5 Configure Communote to use XMPP

  1. Go to the Communote administration area.
  2. Go to the menu Communication -> XMPP.
  3. Set the following values in the tab "Client Configuration" (see Figure 23):
    • Server: Enter the host name of the Openfire server. In case the server is running on the same host as Communote you may just enter "localhost".
    • Port: Enter the XMPP port Openfire will be running on.
    • Login: Enter the login of the bot which you defined during the configuration of Openfire. The default name is bot.communote.
    • Password: Enter the password of your bot.
  4. Check your connection. If this fails please check the configuration in Communote and the configuration of Openfire.
  5. In the tab "Advanced Settings" enter the following data  (see Figure 24):
    • Suffix for users (@hostname): Replace "hostname" with the FQDN hostname of the Openfire server, for example: "@server.company.com".
    • Suffix for blogs (@subdomain.hostname): Replace "subdomain" with the subdomain of the alias configuration in Openfire. Replace "hostname" with the FQDN hostname of the Openfire server, for example: "@communote.server.company.com".
    • Time to wait: The user must wait at least the given amount of time to post another message using XMPP.
  6. Activate the XMPP service in the tab "Client Configuration".     Note: An activated service does not necessarily mean that the communication will work. Therefore please check after activation:
    • Is the bot logged-in in Openfire?
    • Are you able to establish a connection to the Openfire server using a XMPP client (such as Digsby or Pidgin) with the connection data provided in your user profile?
    • Activate the XMPP notifications in your user profile and check if you receive an XMPP notification when a Communote message is posted to you.
    • Please check if you are able to post to a blog using XMPP.

...

Figure 2 4: „Advanced Settings" for the XMPP Communication

3. Maintenance

3.1 Log files

The location of the log files depends on the chosen installation type. In case you installed the Linux package with integration script the Communote logs will be stored in: <communote.data.dir>/log/communote.log. In case you installed the Linux or Windows package without script the Communote logs will be stored in: COMMUNOTE_INSTALL_DIR/communote/logs/communote.log. At the start of Communote a file communote-startup.log will be created. This is located in the bin folder of the executive Tomcats. The location of these log files cannot be changed. During the initialization, Communote is trying to configure logging. For this it needs a log4j.properties file, which must be located in the configuration directory of Communote (chapter "Installing as a WAR" -> communote.config.dir (Step9 )). This file should be created and configured, as otherwise it may happen that important error messages aren't logged . An example of the log4j.properties configuration is shown below. The paths of the log files are configured at the beginning. Usually there is nothing else to adjust but the paths.

Code Block
# info: lines starting with a hash character like this one are treated as comments

log4j.threshold=INFO
log4j.rootLogger=INFO

# Appender that logs all messages to a file. This definition supports log file rotation when the file reaches a given size.
log4j.appender.std_log=org.apache.log4j.RollingFileAppender
# Assign the absolute path to the file the logger should write to. The path separator has to be a
# slash (even on Windows systems). A colon must be escaped with a backslash, e.g. C:\temp\communote.log
# must be written as C\:/temp/communote.log
log4j.appender.std_log.File=ABSOLUTE_PATH_TO_LOG_FOLDER/communote.log
log4j.appender.std_log.MaxFileSize=5000KB
log4j.appender.std_log.MaxBackupIndex=5
log4j.appender.std_log.layout=org.apache.log4j.PatternLayout
log4j.appender.std_log.layout.ConversionPattern=%d{ISO8601} %p %t %c - %m%n
log4j.appender.std_log.Threshold=INFO

# Appender that logs only error messages to a file.
log4j.appender.error_log=org.apache.log4j.RollingFileAppender
# Assign the absolute path to the file the logger should write to.  See above for further details.
log4j.appender.error_log.File=ABSOLUTE_PATH_TO_LOG_FOLDER/communote-error.log
log4j.appender.error_log.MaxFileSize=5000KB
log4j.appender.error_log.MaxBackupIndex=5
log4j.appender.error_log.layout=org.apache.log4j.PatternLayout
log4j.appender.error_log.layout.ConversionPattern=%d{ISO8601} %p %t %c - %m%n
log4j.appender.error_log.Threshold=ERROR
#Rolling appender for missing message keys
log4j.appender.missingLocalization=org.apache.log4j.RollingFileAppender
# Assign the absolute path to the file the logger should write to.  See above for further details.
log4j.appender.missingLocalization.File=ABSOLUTE_PATH_TO_LOG_FOLDER/communote-missing-localization.log
log4j.appender.missingLocalization.MaxFileSize=5000KB
log4j.appender.missingLocalization.layout=org.apache.log4j.PatternLayout
log4j.appender.missingLocalization.layout.ConversionPattern=%d{ISO8601} - %m%n
log4j.appender.missingLocalization.Threshold=WARN
log4j.logger.missingLocalization.de.communardo.kenmei.core.api.common.messages=WARN, missingLocalization 

log4j.logger.com.communote=INFO
log4j.logger.com.communote.server.web.commons.filter=ERROR
log4j.logger.de.communardo=INFO, std_log, error_log
log4j.logger.org=WARN, std_log, error_log
log4j.logger.com=WARN, std_log, error_log
log4j.logger.net=WARN, std_log, error_log 

3.2 Starting Communote

For WAR file based installations just start and stop the Tomcat as usual. On Linux systems you should be careful to run the commands with the correct user account. For the other installation types do it as follows. With Linux you may start or stop Communote with the following command line statements:

...

  • COMMUNOTE_INSTALL_DIR/communote/bin/startup.bat
  • COMMUNOTE_INSTALL_DIR/communote/bin/shutdown.bat

4. Communote Extensions

Communote can be extended with plugins. There is for example a plugin to support integrated Windows authentication based on NTLM when installing and using Communote on Windows (see Single Sign On Plug-in). The installation and deinstallation of such additional plugins is described in this section.

4.1 Installation of a Communote plugin

A Communote plugin is a JAR file which has to be copied to the Communote plugin-directory to get installed. The Communote plugin-directory is usually the subdirectory "plugins" of the Communote data-directory defined during the installation.

...

After the installation the plugin will be listed in the Communote administration area under "Extensions > Overview".

4.2 Deinstallation of a Communote plugin

To deinstall a plugin the JAR file has just to be removed from the plugin-directory. A restart is usually not necessary.

4.3 Update of a Communote plugin

To update an installed Communote plugin you just have to deinstall it first and install the new JAR file afterwards.