Cybozu Garoon 3 Server Distributed System Installation Guide Edition 3.1 Cybozu, Inc.

(1)

Cybozu Garoon 3

Server Distributed System

Installation Guide

(2)

Preface

This guide describes the features and operations of Cybozu Garoon Version 3.1.0.

Who Should Use This Guide

The target audience of this guide is as follows: Operators:

•

They are in charge of the installation work of Cybozu Garoon.

Typographic Conventions

Conventions Meaning

Note Indicates important information. Tip Provides a helpful hint or information.

See “Section title” on page ###. Indicates a cross reference link to the detailed information.

Production Environment

This guide is produced on the following environment: OS:Windows Server 2008 Standard x64(SP2)

•

Web browser: Internet Explorer 8

•

Product version: Cybozu Garoon Version 3.1.0

•

The contents of a screen vary depending on the web browser that you are using.

Abbreviations

Abbreviation Meaning

Garoon 3 Cybozu Garoon Version 3.1.0

Copying and reproducing this document

You assume complete responsibility and risk for re-using the content of this manual.

CYBOZU SHALL NOT BE RESPONSIBLE FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL LOSS OR DAMAGE OR ANY OTHER COMMERCIAL DAMAGE AND LOSS, IN CONNECTION WITH THE USE OF THE SERVICE.

You must include the following copyright statement in works that incorporate content from this manual: This document contains content derived from the *** Guide, copyright Cybozu, Inc.

Copyrights and Trademarks

All brand names and product names appearing in this document are registered trademarks or

•

trademarks of their respective holders.

Our products may contain copyrighted products owned by other companies. Please refer to the following web site regarding trademarks and copyrights: http://cybozu.com/en/company/trademark/

•

(3)

Preface

(http://www.openssl.org/)

This product includes cryptographic software written by Eric Young. ([email protected])

This product includes software written by Tim Hudson. ([email protected])

Cybozu Garoon 3 Server Distributed System Installation Guide Edition 3.1 Published by: Cybozu, Inc. August 2011

(4)

1 Server Distributed System Overview

Garoon 3 consists of the servers that provide the following functions:

Server Function

Application server Runs Garoon 3 applications and processes incoming information. Responds to a client's request and sends stored data such as HTML files and images to servers and client computers.

Database server Stores input data such as appointments, topics, and attachments.

The overall system performance may be degraded by an increase in users or any other environmental factors. In such cases, you can distribute the server functions over several server computers to ensure reliable system performance.

This guide describes how to build a server distributed system in which the application server and the database server operate on separate server computers.

Example sever configuration:

Tip

You can distribute an application server over multiple server computers.

(6)

A load balancer is required to run application servers on multiple server computers. Garoon 3 can

•

operate either in L4 or L7 mode.

1.1 System Requirements

The system requirements of Garoon 3 are as follows (as of August 2011):

Server operating systems

OS Version

Windows Windows Server 2008 Standard (SP2) Windows Server 2008 Enterprise (SP2) Windows Server 2003, Standard Edition (SP2) Windows Server 2003, Enterprise Edition (SP2) Windows Server 2003 R2, Standard Edition (SP2) Windows Server 2003 R2, Enterprise Edition (SP2) Windows 64 bit Windows Server 2008 R2 Standard x64

Windows Server 2008 R2 Enterprise x64 Windows Server 2008 R2 Standard x64 (SP1) Windows Server 2008 R2 Enterprise x64 (SP1) Windows Server 2008 Standard x64 (SP2) Windows Server 2008 Enterprise x64 (SP2)

Windows Server 2003 R2, Standard x64 Edition (SP2) Windows Server 2003 R2, Enterprise x64 Edition (SP2) Windows Server 2003, Standard x64 Edition (SP2) Windows Server 2003, Enterprise x64 Edition (SP2) Linux SUSE Linux Enterprise Server 11

Red Hat Enterprise Linux 6

Red Hat Enterprise Linux 5 Advanced Platform Red Hat Enterprise Linux 5

Red Hat Enterprise Linux AS (v. 4) Red Hat Enterprise Linux ES (v. 4) Linux 64 bit SUSE Linux Enterprise Server 11

Red Hat Enterprise Linux 6

Red Hat Enterprise Linux 5 Advanced Platform Red Hat Enterprise Linux 5

Red Hat Enterprise Linux AS (v. 4) Red Hat Enterprise Linux ES (v. 4)

Tip

The servers used in a server distributed system must be running on the same family of operating

•

systems whether it is Windows or Linux.

You can use both 32-bit OSs and 64-bit OSs to build a server distributed system only if the operating

•

systems belong to the same family.

Garoon 3 does not operate properly while SELinux is active. You must disable SELinux before

•

(7)

1.1 System Requirements

Web servers

OS Web server

Windows Apache 2.0.x, 2.2.x

Internet Information Service (IIS) 6.0, 7.0, 7.5 Linux Apache 2.0.x, 2.2.x

Web browsers

OS Web browser

Windows Internet Explorer 6, 7, 8, 9 Mozilla Firefox 3.6, 4.0

Linux Safari 4, 5

Mozilla Firefox 3.6, 4.0

iOS Safari

Android Android's default Web browser

Mail servers

You must install a mail server to use an e-mail client. This product supports the following mail servers:

Protocols: SMTP • SMTPS • POP3 • POP3S • IMAP4 •

This product currently supports only the e-mail receiving feature of IMAP4. You cannot use other features of IMAP4. Authentication methods: APOP • POP before SMTP • SMTP Authentication • Network (TCP/IP) Item Type Protocol HTTP or HTTPS Port number (*1) Web server ・HTTP : 80 ・HTTPS : 443 ・NETBIOS:137-139 (*2 ) ・NFS : Assigned automatically (*3) Database engine mysqld : 3770 (*4)

*1: The port numbers that are commonly used for communication. The port number assigned on a server may vary depending on your environment.

*2: Available only on Windows.

*3: Available only on Linux. An unused port number will be assigned automatically.

*4: The port number used for "mysqld" can be found in the database server configuration file (my.ini). If you install Garoon 3 in the default directories, "my.ini" is saved in the following directory:

On Windows : C:¥Program Files¥Cybozu¥mysql-5.0¥etc¥my.ini

•

On Linux : /usr/local/cybozu/mysql-5.0/etc/my.ini

(8)

Note

You must only open the relevant port if you use Garoon 3 through a firewall.

•

You must open the port for "mysqld" only when the request is sent from the Web server.

•

Keep the port information confidential.

•

Tip

For the latest system requirements and limitations, see the following page on our website:

•

http://products.cybozu.co.jp/garoon/product/environment/ This website is currently available only in Japanese.

For more server examples, see the following page on our website:

•

http://products.cybozu.co.jp/garoon/product/construction/ This website is currently available only in Japanese.

Garoon 3 can also operate on virtual environments. Performance degradation may occur depending

•

on your virtual environments.

The database server requires Internet access to use the following functions:

•

RSS Reader (Subscription of RSS websites)

•

Cybozu Online Service*1

•

Notices from Cybozu*1

•

*1: These services are currently available only in Japanese and search locations only within Japan.

1.2 Installing

To newly install Garoon 3, follow the installation procedures. To upgrade to Garoon 3.1.0, follow the upgrade procedures.

Tip

An upgrade program is required to upgrade from Garoon 2.1.3 or earlier to Garoon 3.1.0. The

•

upgrade program and the manual can be downloaded on our website.

For any concern with the upgrade process, contact our official partners or your vendor.

•

To install Garoon 3:

Part 1 Confirm the system requirements.

"1.1 System Requirements" on page 6.

Part 2 Prepare required programs and information.

"Preparing programs and information for installation" on page 9.

Part 3 Install the system.

“2 Operation on Windows" on page 11 “3 Operation on Linux" on page 26.

Part 4 Set up Garoon 3 before starting operation.

(9)

1.2 Installing

To upgrade to Garoon 3.1.0:

Part 1 Prepare required programs and information.

Part 2 Upgrade the system.

"2.3 Upgrading Garoon 3" on page 23. "3.3 Upgrading Garoon 3" on page 40.

Part 3 Set up Garoon 3 before restarting operation.

"5 Setting Up Garoon 3 After Upgrading" on page 49.

Preparing programs and information for installation

Before installing or upgrading, you must prepare an installer and the information required for your installation.

Installer

Item Description Usage

Install Upgrade

On Windows 32-bit OS: grn-3.1.0-windows.exe 64-bit OS: grn-3.1.0-windows-x64.exe

 

On Linux 32-bit OS: grn-3.1.0-linux.bin 64-bit OS: grn-3.1.0-linux-x64.bin

 

Tip

The Garoon 3 installer for each OS can be downloaded on our website. This website is currently

•

available only in Japanese.

http://products.cybozu.co.jp/garoon/download/

You need to configure Garoon 3 if you use SSL to connect to LDAP. For configuration steps, see the

•

following page on our website.

http://manual.cybozu.co.jp/en/tech/sslsetup.html

Information required for installing or upgrading

All servers must be provided with the same information in all of the items, except for the memory capacity for server computers.

: Required Blank: Not required

Administrator

password or superuser password

Password that is required for initialization or login to the administration screen.

(10)

Customer information - Company name

- Pronunciation of company name - Logo (*1)



Document root The directory that stores HTML files and image files to be published by the Web server



CGI directory The directory on the Web server where CGI scripts can be executed



Installation identifier The character strings that are used to distinguish multiple Garoon 3.

You can enter 1 to 10 characters. (*2) - Numeric characters from 0 to 9 are only allowed after alphabetic characters.



Database administrator password

The password that is used to manage the database engine.

You can enter 6 to 10 characters. (*2)

 

Database user passwords

The password that is used to access user data.

You can enter 6 to 10 characters. (*2)



License Garoon 3 license  

Memory capacity for server computers

The on-board memory of the server computer where the database engine is installed

 

*1 : Prepare either of the following logos if required:

• Image file

• URL for image file location *2 : Valid characters are as follows:

• Upper or lower case alphabetic characters

• Underscore "_"

(11)

2.1 Building a Server Distributed System on Installation

2 Operation on Windows

Garoon 3 can be installed, uninstalled, or upgraded by users with Administrator accounts on Windows. This chapter assumes the following configuration:

Items Example

Environment Server OS Windows Server 2008 R2 Enterprise x64

Web server IIS 7.0

CGI directory on the Web server C:¥Inetpub¥scripts Document root directory on the Web server C:¥Inetpub¥wwwroot Installation identifier cbgrn

Port number for the database engine 3770 Server

configuration

Application server - Server A: Server name "server_a"

- Server B: Server name "server_b"

Database server Server C: Server name "server_c"

Time synchronization among servers NTP

Note

To run Garoon 3 on multiple server computers, the time on all server computers must be

•

synchronized with each other. Garoon 3 may operate improperly if the time differs between the server computers.

To use SSL in a Windows environment, see the limitations of Garoon 3 on our website.

•

https://support.cybozu.com/en/article/4139

Tip

For how to set up a web server, see the following page on our website:

•

http://manual.cybozu.co.jp/en/tech/webinstall/

The "Do you want to install a web server" dialog box may appear during installation. Click Yes to

•

install Apache 2.2 (Apache 2).

2.1 Building a Server Distributed System on Installation

This section describes how to build a server distributed system by installing Garoon 3 on multiple Windows environments.

Step Task Page

STEP 1 Installing Garoon 3 12

STEP 2 Changing the Connection Host for the Database Engine 12

STEP 3 Changing the Data Storage Directory 13

STEP 4 Changing the Service Startup Type 16

STEP 5 Starting Garoon 3 16

STEP 6 Registering Information Before Starting Operation 17

(12)

Prepare information required for installation in advance. The servers must be provided with the same

•

settings in some items.

"Preparing programs and information for installation" on page 11. Exit all programs but the installer.

•

Additional configurations are required to use IIS in Garoon 3. See the following for configuration

•

details:

"Installing on Windows" in the Installation Guide.

STEP 1: Installing Garoon 3

1

Confirm that Web servers are running on all servers. Start the Web servers if they are not running.

2

Install Garoon 3 on all servers.

Execute either of the following installers according to your OS:

• grn-3.1.0-windows.exe

• grn-3.1.0-windows-x64.exe

Follow the instructions on the screen to install Garoon 3. See the following manual for installation details:

3

Initialize Garoon 3 on all servers. "4.1 Initializing Garoon 3" on page 44.

4

Optimize database engine settings on Server C.

You must change the database engine settings if the memory on the server computer exceeds 4 GB.

"4.3 Changing Database Settings" on page 46.

5

Confirm that Garoon 3 on all servers can be accessed without any problems.

Tip

If the Garoon 3 screen does not appear properly, verify the following settings:

•

The virtual directory of each Web server is set properly.

•

The document root on each Web server has proper access privileges.

•

For how to create a virtual directory on a Web server, see the following page on our website: http://manual.cybozu.co.jp/en/tech/webalias/

The installation log of Garoon 3 and CyDE2 are saved in the following location:

•

C:¥WINDOWS¥SysWow64¥_cb_installer.log

STEP 2: Changing the Connection Host for the Database Engine

6

Stop Web servers on all servers.

Stop the Web servers if they are running.

(13)

From the Windows Start menu on each server, select Control Panel > Administrative Tools > Services.

Stop Cybozu scheduling service first, and then Cybozu database engine.

• Scheduling service: Cybozu_Scheduling_Service_cbgrn (*1) *1: cbgrn may be replaced by your installation identifier.

• Database engine: Cybozu_Database_Engine_5_0

8

Check the port number used for the database engine on Server C.

The port number is defined in "port" in the [mysqld] section of the "my.ini" file. File location C:/Program Files/Cybozu/mysql-5.0/etc/my.ini

Port number description

[client] port = 3770

socket =C:/Program Files/cybozu/mysql-5.0/data/mysql.sock default-character-set = utf8

[mysqld]

port = 3770 (*1)

socket = C: /Program Files/cybozu/mysql-5.0/data/mysql.sock

9

Change the host to which the database engines on Server A and Server B connect. Open the "lwc.ini" file on each server, and change the connection host.

• File location: C:¥Inetpub¥scripts¥cbgrn¥lwc.ini

• Destination host for connection ("prop:_host" in the [dbconn] section): val: host name or IP

address: Port number

Example:

Description before the change [dbconn] class = CB_DatabaseConnection require = fw/database.csp prop:_host = val:localhost:3770 prop:_dbname = val:cb_cbgrn [dbconn] class = CB_DatabaseConnection require = fw/database.csp prop:_host = val:server_c:3770 prop:_dbname = val:cb_cbgrn a: The default value

b: The host name, IP address, and port number that you checked in the step 3

STEP 3: Changing the Data Storage Directory

Change the configuration to store all of the session data and the attachment data on the same server computer.

Proceed to the step 2 if the application server operates on a single server computer.

Note

Valid characters for the ID string in the "server_id" property are: 0-9, a-z, and A-Z.

•

To use IIS 6.0, you must enable anonymous access in the step 4.

•

a

(14)

1

Specify the character string to embed in the session ID.

Open the "common.ini" file on Server A and Server B, and add a "server_id" property in the [Session] section. The ID string that is specified in the "server_id" property must be unique.

File location C:¥Inetpub¥scripts¥cbgrn¥common.ini Example ID string - Server A : server1

- Server B : server2

Example description on Server A: [Session] check_hijack = 0 cookie_lifetime = 0 cookie_path = / file_lifetime = 1 save_path = C:/Inetpub/scripts/cbgrn/sessiondata/ server_id = server1 a: ID string

2

On all server computers, add a Windows user using the same user name and password.

3

Launch IIS Manager on Server A and Server B, and perform the following operation: Click Sites > Default Web Site > scripts > cbgrn (*1).

*1: cbgrn may be replaced by your installation identifier.

4

Change the user account for anonymous access on Server A and Server B.

Select Authentication > Anonymous Authentication > Edit to display the Edit Anonymous Authentication Credentials screen, and select Specific user.

Then, click Set to display the Set Credentials screen, enter the user name and password that you added in the step 2, and click OK.

5

Change the directory name of the storage area on Server A and Server B.

To prevent session data and attachments being automatically stored in the new directory, you must change the directory name of the storage area on Server A and Server B.

Example:

Data Directory before the change Directory after the change

Session data (*1) C:¥Inetpub¥scripts¥cbgrn¥ sessiondata

C:¥Inetpub¥scripts¥cbgrn¥ sessiondata_bak

Attachments C:¥Program Files¥Cybozu¥ mysql-5.0¥files

C:¥Program Files¥Cybozu¥ mysql-5.0¥files_bak

*1: This change is required only if the application servers operate on multiple server computers.

6

Create a storage directory under the session data area on Server C.

This step is required only if the application server operates on multiple server computers. Example: C:¥Inetpub¥scripts¥cbgrn¥sessiondata¥sessionfiles

You must create a new directory for session data storage. Files will not be stored correctly if you specify a shared folder as the session data area in the step 9.

(15)

7

Set the session data area and the attachment area on Server C to be shared over the network. Launch Windows Explorer, right-click the storage directory, and click Properties.

Example:

Data Directory name Absolute path

Session data (*1) sessiondata C:¥Inetpub¥scripts¥cbgrn¥sessiondata

Attachments files C:¥Program

Files¥Cybozu¥mysql-5.0¥files *1: This setting is required only if the application servers operate on multiple server computers.

Set the following options:

The "Sharing" tab

• Click the Sharing tab, and add the user added in the step 2.

• Select Co-owner in the drop-down list, and click Share.

To prevent security being affected by write permissions, we recommend that you remove permissions for "Everyone".

The "Security" tab

• Click the Security tab, select Edit, and add the user added in the step 2.

• Select the Modify check box. Make sure that the following check boxes are selected:

• Modify

• Read & execute

• List folder contents

• Read

8

Confirm the method of storing session data on Server A and Server B.

Open the "php.ini" file on each server, and confirm that "files" is specified as the value in the "session.save_handler" property.

File location C:¥Inetpub¥scripts¥cbgrn¥php.ini

Session data storage method

[Session]

; Handler used to store/retrieve data. ;; Framework

;; Set this to "user" to store session data into database. session.save_handler = files (*1)

*1: Change the value to "files" if any other value is specified.

9

Change the storage area on Server A and Server B.

Open the "common.ini" file on each server, and change the storage directories for session data and attachments.

• Session data

Change the directory only if the application servers operate on multiple server computers. Specify the directory that you created in the step 6.

[Session]

(16)

*1: "cbgrn" is an installation identifier.

• Attachments

Specify the directory that you configured in the step 7. [Files]

dir = "//'Server C IP address'/files/cbgrn" (*1) *1: "cbgrn" is an installation identifier.

You must specify the directory under the shared folder as the attachment area. Files will not be stored correctly if you specify the shared folder as the attachment area.

You can also use directories other than "C:¥Program Files¥Cybozu¥mysql-5.0¥files" for attachment storage.

In that case, you must edit all of the "common.ini" files to specify the same attachment area on all servers.

STEP 4: Changing the Service Startup Type

Under the server distributed system, only the database server uses the database engine and the scheduling service. You must change the settings to prevent the services from automatically starting on the application server.

1

Disable the automatic startup of Garoon 3 services on the application server.

From the Windows Start menu, select Control Panel > Administrative Tools > Services, and select Disable in the startup type.

Server computer Service to disable

Server A - Cybozu_Database_Engine_5_0 - Cybozu_Scheduling_Service_cbgrn (*1) Server B - Cybozu_Database_Engine_5_0 - Cybozu_Scheduling_Service_cbgrn (*1) Server C (None) *1: cbgrn is an installation identifier.

STEP 5: Starting Garoon 3

1

Start Garoon 3 services on Server C.

From the Windows Start menu, select Control Panel > Administrative Tools > Services, and start the services in the following order:

• Scheduling service: Cybozu_Scheduling_Service_cbgrn (*1) *1: cbgrn is an installation identifier.

2

Start Web servers on Server A and Server B.

After starting the Web servers, access Garoon 3 on Server A and Server B.

(17)

2.2 Building a Server Distributed System using Garoon 3 in Operation

If Garoon 3 is not running properly, verify whether all servers have been provided with the required information.

STEP 6: Registering Information Before Starting

1

Specify administrators and edit customer information.

"4.2 Registering Information Before Starting Operation" on page 45.

Notes for Operation

Under the server distributed system, you must regularly delete temporary files from the application server.

See the following section for how to delete temporary files: "6.1 Deleting Temporary Files" on page 59

2.2 Building a Server Distributed System using Garoon 3 in Operation

This section describes how to build a server distributed system by migrating Garoon 3 installed on a single server computer to an environment where Garoon 3 operates on multiple server computers. The current server computer will serve as a database server, whereas a new server computer will be used as an application server.

Follow the procedures to build a server distributed system:

Step 1 Installing Garoon 3 18

Step 2 Changing the Connection Host for the Database Engine 18

Step 3 Changing the Data Storage Directory 19

Step 4 Changing the Service Startup Type 22

Step 5 Starting Garoon 3 22

This section assumes the following configuration:

New servers (Application server)

Server A

•

Server B

•

Current server (Database server)

Server C

•

Note

•

You must exit all Windows programs before running the installation program.

•

Additional configurations are required to use IIS in Garoon 3. See the following manual for

•

configuration details:

(18)

STEP 1: Installing Garoon 3

1

Confirm that Web servers are running on Server A and Server B. Start the Web servers if they are not running.

2

Install Garoon 3 on Server A and Server B.

Execute either of the following installers according to your OS:

3

Initialize Garoon 3 on Server A and Server B. "4.1 Initializing Garoon 3" on page 44.

4

Confirm that Garoon 3 on Server A and Server B can be accessed without any problems.

Tip

•

For how to create a virtual directory on a web server, see the following page on our website: http://manual.cybozu.co.jp/en/tech/webalias/

•

C:¥WINDOWS¥SysWow64¥_cb_installer.log

STEP 2: Changing the Connection Host for the Database Engine

1

Stop Web servers on all servers.

Stop the Web servers if they are running.

2

Stop Garoon 3 services on all servers. Stop Garoon 3 services on each server.

From the Windows Start menu, select Control Panel > Administrative Tools > Services, and stop the services in the following order:

3

Check the port number that is used for the database engine on Server C. The port number is defined in "port" in the [mysqld] section of the "my.ini" file.

(19)

[client] port = 3770 socket = /usr/local/cybozu/mysql-5.0/data/mysql.sock default-character-set = utf8 [mysqld] port = 3770 (*1) socket = /usr/local/cybozu/mysql-5.0/data/mysql.sock *1: The port number that is used for the database engine

4

File location C:¥Inetpub¥scripts¥cbgrn¥lwc.ini Destination host for

connection

("prop:_host" in the [dbconn] section)

val:host name or IP address:port number

- Specify the host name, IP address, and port number that are used on Server C.

Example:

Description before the change [dbconn]

class = CB_DatabaseConnection require = fw/database.csp prop:_host = val:localhost:3770 prop:_dbname = val:cb_cbgrn Description after the change

[dbconn]

class = CB_DatabaseConnection require = fw/database.csp prop:_host = val:server_c:3770 prop:_dbname = val:cb_cbgrn a: The default value

STEP 3: Changing the Data Storage Directory

Note

Valid characters for the ID string in "server_id" are: 0-9, a-z, and A-Z.

•

To use IIS 6.0, you must enable anonymous access in the step 4.

•

1

File location C:¥Inetpub¥scripts¥cbgrn¥common.ini Example ID string - Server A : server1

- Server B : server2

a

(20)

Example description on Server A: [Session] check_hijack = "0" cookie_lifetime = "0" cookie_path = "/" file_lifetime = "1" save_path = "C:/Inetpub/scripts/cbgrn/sessiondata/" server_id = "server1" a: ID string

2

On all server computers, add a Windows user using the same user name and password.

3

Launch IIS Manager on Server A and Server B, and open the properties of "grn.exe". Click Sites > Default Web Site > scripts > cbgrn (*1).

*1: cbgrn may be replaced by your installation identifier.

4

Change the user account for anonymous access on Server A and Server B.

Select Authentication > Anonymous Authentication > Edit to display the Edit Anonymous Authentication Credentials screen, and select Specific user.

Then, click Set to display the Set Credentials screen, enter the user name and password that you added in the step 2, and click OK.

5

To prevent session data and attachments being automatically stored in the new directory, you must change the directory name of the storage area on Server A and Server B.

Example:

Data Directory before the change Directory after the change

Session data (*1) C:¥Inetpub¥scripts¥cbgrn¥ sessiondata C:¥Inetpub¥scripts¥cbgrn¥ sessiondata_bak Attachments C:¥ProgramFiles¥Cybozu¥ mysql-5.0¥files C:¥ProgramFiles¥Cybozu¥ mysql-5.0¥files_bak

*1: This change is required only if the application servers operate on multiple server computers.

6

Create a storage directory under the session data area on Server C.

This step is required only if the application server operates on multiple server computers. Example: C:¥Inetpub¥scripts¥cbgrn¥sessiondata¥sessionfiles

You must create a new directory for session data storage. Files will not be stored correctly if you specify a shared folder as the session data area in the step 9.

7

Set the session data area and the attachment area on Server C to be shared over the network. Launch Windows Explorer, right-click the storage directory, and click Properties.

Set the following options:

• "Sharing"

Select "Share this folder".

Click Permissions, and allow the user added in the step 2 to change and read the folder.

(21)

• "Security"

Allow the user added in the step 2 to modify and read the folder.

For higher security, we recommend that you remove permissions for "Everyone". Example:

Data Directory name Absolute path

Session data (*1) sessiondata C:¥Inetpub¥scripts¥cbgrn¥sessiondata

Attachments files C:¥Program

Files¥Cybozu¥mysql-5.0¥files *1: This setting is required only if the application servers operate on multiple server computers.

8

File location C:¥Inetpub¥scripts¥cbgrn¥php.ini

[Session]

9

Change the storage area on Server A and Server B.

Open the "common.ini" file on each server, and change the storage directories for session data and attachments.

• Session data

Change the directory only if the application servers operate on multiple server computers. Specify the directory that you created in the step 6.

[Session]

save_path = "save_path = "//'Server C IP address'/sessiondata/sessionfiles"" (*1) *1: "cbgrn" is an installation identifier.

• Attachments

Specify the directory that you configured in the step 7. [Files]

dir = "//'Server C IP address'/files/cbgrn" (*1) *1: "cbgrn" is an installation identifier.

(22)

You can also use directories other than "C:¥Program Files¥Cybozu¥mysql-5.0¥files" for attachment storage.

In that case, you must edit all of the "common.ini" files to specify the same attachment area on all servers.

STEP 4: Changing the Service Startup Type

1

Disable the automatic startup of Garoon 3 services.

Server A - Cybozu_Database_Engine_5_0 - Cybozu_Scheduling_Service_cbgrn (*1) Server B - Cybozu_Database_Engine_5_0 - Cybozu_Scheduling_Service_cbgrn (*1) Server C (None) *1: cbgrn is an installation identifier.

STEP 5: Starting Garoon 3

1

From the Windows Start menu, select Control Panel > Administrative Tools > Services, and start the services in the following order:

2

After starting the Web servers, access Garoon 3 on Server A and Server B.

Confirm that the administrative functions and the applications work properly in Garoon 3.

Notes for Operation

Under the server distributed system, you must regularly delete temporary files from the application server.

(23)

2.3 Upgrading Garoon 3

2.3 Upgrading Garoon 3

This section describes how to upgrade your system from Garoon 3.0.x to Garoon 3.1.0. Upgrade can be performed by users with "Administrator" accounts on Windows.

See the following section for the information required for upgrading: "Preparing programs and information for installation" on page 9.

Note

Depending on the version of Garoon before upgrading, some additional configurations may be

•

required.

Do not stop the upgrade program until it completes.

•

Stop the Web server and the scheduling service first and then start upgrading.

•

Stop all of the scheduling services that are running on the server.

•

If the scheduling service is set to start automatically, you must change the startup type to Disable.

•

Tip

For any concern with the upgrade process, contact our official partners or your vendor.

•

1

Back up the data of Garoon 3 that is running on Server C. See the following for details on backing up:

"Maintenance" in the Administrator Guide.

After backing up, confirm that the database engine is running on Server C.

2

Stop Web servers on Server A and Server B.

3

Stop the scheduling service on Server C.

From the Windows Start menu, select Control Panel > Administrative Tools > Services, and stop the following services:

• Scheduling service: Cybozu_Scheduling_Service_cbgrn (*1) *1: "cbgrn" is an installation identifier.

Close the "Services" window once the scheduling service stops. Otherwise the upgrade may fail.

4

Upgrade Garoon on all servers to version 3.1.0.

We recommend that you upgrade in the following order:

Original version Recommended order Notes

2.0.1 or later 1st: Database server (Server C)

2nd: Application server (Server A and Server B)

An upgrade program is required to upgrade from Garoon 2.1.3 or earlier to Garoon 3.1.0. 2.0.0 1st: Application server (Server A and Server B)

2nd: Database server (Server C)

On each server, execute either of the following installers according to the OS:

(24)

"Upgrading on Windows" in the Installation Guide.

5

Upgrading Garoon will create a new directory with a default name on the application server. To prevent session data and attachments to be automatically stored in the new directory, you must change the directory name of the storage area on Server A and Server B.

Example:

Data Directory before the change Directory after the change

Session data (*1) C:¥Inetpub¥scripts¥cbgrn¥ sessiondata

C:¥Inetpub¥scripts¥cbgr n¥

sessiondata_bak2 Attachments C:¥ProgramFiles¥Cybozu¥mysql-5.0¥files C:¥ProgramFiles¥Cyboz

u¥mysql-5.0¥files_bak2 *1: This change is required only if the application servers operate on multiple server computers.

6

Confirm that the scheduling service is running on Server C.

From the Windows Start menu, select Control Panel > Administrative Tools > Services. Confirm that the scheduling service is in Started status.

7

Stop the database engines on Server A and Server B.

From the Windows Start menu, select Control Panel > Administrative Tools > Services, and stop the following services:

8

Server A - Cybozu_Database_Engine_5_0 - Cybozu_Scheduling_Service_cbgrn (*1) Server B - Cybozu_Database_Engine_5_0 - Cybozu_Scheduling_Service_cbgrn (*1) Server C (None) *1: "cbgrn" is an installation identifier.

9

10

Enable the automatic startup of the scheduling service on Server C.

This step is required if you have disabled the automatic startup of the scheduling service on Server C before the upgrade.

(25)

2.4 Uninstalling Garoon 3

11

Set up Garoon 3 before restarting operation. "5 Setting Up Garoon 3 After Upgrading" on page 49.

Tip

The upgrade log is saved in the following location:

•

Installation log of Garoon 3 and CyDE : C:¥WINDOWS¥SysWow64¥_cb_installer.log

•

Upgrade log : C:¥WINDOWS¥SysWow64¥_cb_versionup.log

•

Backup log of MySQL : C:¥WINDOWS¥SysWow64¥_cb_versionup_mark.log

•

"_cb_versionup_mark.log" is output if the system is upgraded from Garoon 2.5.x to Garoon 3.1.0.

•

2.4 Uninstalling Garoon 3

Uninstall can be performed by users with "Administrator" accounts on Windows. This section assumes that cbgrn is used as the installation identifier.

Note

Follow the procedures in every detail to completely uninstall Garoon 3. Otherwise, some files may

•

remain on your server computer.

Tip

See the following for uninstallation details:

•

"Uninstalling on Windows" in the Installation Guide.

1

From the Windows Start menu, click Control Panel > Programs and Features.

2

On the Uninstall or change a program screen, select Cybozu(R) Garoon 3.1.0 (cbgrn), and click Uninstall.

3

Uninstall Garoon 3 CGI programs completely.

Select Complete Uninstallation from the uninstallation options, and click Next > Finish. To keep the configuration file and the template files, select Partial Uninstallation.

4

On the Programs and Features screen, select Cybozu(R) Database Engine 5.0, and click Uninstall.

5

Uninstall the database engine completely.

(26)

3 Operation on Linux

Garoon 3 can be installed, uninstalled, or upgraded by root users on Linux. This chapter assumes the following configuration:

Item Example

Environment Web server Apache 2.2

CGI directory on the Web server /var/www/cgi-bin Document root directory on the

Web server

/var/www/html

Installation identifier cbgrn Port number for the database

engine

3770

Server configuration Application server - Server A: Host name "server_a" - Server B: Host name "server_b" Database server Server C: Host name "server_c" Time synchronization among servers NTP

Note

To run Garoon 3 on multiple server computers, the time on all server computers must be

•

synchronized with each other. Garoon 3 may operate improperly if the time differs between the server computers.

3.1 Building a Server Distributed System on Installation

This section describes how to build a server distributed system by installing Garoon 3 on multiple Linux environments.

Step 1 Installing Garoon 3 26

Step 2 Changing the Connection Host for the Database Engine 27

Step 6 Registering Information Before Starting Operation 32

Note

•

STEP 1: Installing Garoon 3

1

Confirm that Web servers (httpd) are running on all servers.

(27)

If the Web servers are not running, execute the following command to start the Web servers: # /etc/init.d/httpd start

2

Install Garoon 3 on all servers.

On each server, execute an installer according to the OS.

Execute either of the following commands in the installer directory:

• # sh grn-3.1.0-linux.bin

• # sh grn-3.1.0-linux-x64.bin

Follow the instructions on the screen to install Garoon 3. See the following for installation details:

"Installing on Linux" in the Installation Guide.

3

Initialize Garoon 3 on all servers.

Initialize Garoon 3 on each of the servers. "4.1 Initializing Garoon 3" on page 44.

4

Optimize database engine settings on Server C.

You must change the database engine settings if the memory on the server computer exceeds 4 GB.

"4.3 Changing Database Settings" on page 46.

5

Confirm that Garoon 3 on all servers can be accessed without any problems.

Tip

•

Installation log of Garoon 3 : Drectory where the installer is located/install.log

•

Installation log of CyDE2 : Directory where the installer is located/install_cyde.log

•

STEP 2: Changing the Connection Host for the Database Engine

1

Stop Web servers (httpd) on all servers.

Execute the following command on each server: # /etc/init.d/httpd stop

2

Stop Garoon 3 services on all servers.

Execute the commands in the following order to stop the services:

• Scheduling service: /etc/rc.d/init.d/cyss_cbgrn stop (*1)

(28)

3

Check the port number used for the database engine on Server C.

The port number is defined in "port" in the [mysqld] section of the "my.ini" file. File location /usr/local/cybozu/mysql-5.0/etc/my.ini

[client] port = 3770 socket = /usr/local/cybozu/mysql-5.0/data/mysql.sock default-character-set = utf8 [mysqld] port = 3770 (*1) socket = /usr/local/cybozu/mysql-5.0/data/mysql.sock *1: The port number that is used for the database engine.

4

• File location: C:/var/www/cgi-bin/cbgrn/lwc.ini

• Destination host for connection ("prop:_host" in the [dbconn] section): val:"host name or IP

address : Port number - Specify the host name, IP address, and port number that are used on

Server C.

Example:

class = CB_DatabaseConnection require = fw/database.csp prop:_host = val:localhost:3770 prop:_dbname = val:cb_cbgrn Description after the change

[dbconn]

STEP 3: Changing the Data Storage Directory

Note

•

1

File location /var/www/cgi-bin/cbgrn/common.ini

a

(29)

Example ID string - Server A : server1 - Server B : server2

Example description on Server A: [Session] check_hijack = "0" cookie_lifetime = "0" cookie_path = "/" file_lifetime = "1" save_path = "/var/www/cgi-bin/cbgrn/sessiondata/" server_id = "server1 a: ID string

2

File location /var/www/cgi-bin/cbgrn/php.ini

[Session]

3

Check the storage area on all servers.

Open the "common.ini" file on each server, and check the property. File location /var/www/cgi-bin/cbgrn/common.ini

Session data area

[Session]

check_hijack = "0" cookie_lifetime = "0" cookie_path = "/" file_lifetime = "1"

save_path = "'session data area'" Attachment area [Files]

dir = "'attachment area'/cbgrn"

4

Open the "exports" file on Server C, and add the storage area and the application servers to the file. Specify the following information: The storage area on Server C that you checked in the step 3; IP addresses of Server A and Server B.

File location /etc/exports

Session data area /var/www/cgi-bin/cbgrn/sessiondata "Server A IP address"(rw) "Server B IP address"(rw) (*1)

Attachment area /usr/local/cybozu/mysql-5.0/files "Server A IP address"(rw) "Server B IP address"(rw)

*1: This description is required only if the application servers operate on multiple server computers.

5

Confirm the status of "portmap", "nfs", and "nfslock" on Server C.

Execute the following commands to confirm that the services are running:

(30)

• portmap : # /etc/rc.d/init.d/portmap status

• nfslock : # /etc/rc.d/init.d/nfslock status

• nfs : # /etc/rc.d/init.d/nfs status

Example:

# /etc/rc.d/init.d/portmap status portmap is stopped

# /etc/rc.d/init.d/nfslock status rpc.statd (pid 1654) is running... # /etc/rc.d/init.d/nfs status

rpc.mountd (pid 8551 2079) is running...

nfsd (pid 2076 2073 2072 2071 2070 2069 2068 2067) is running... rpc.rquotad (pid 8546 2050) is running...

a: The service is not running. b: The service is running.

6

Start the services.

If any service is not running in the step 5, you must start it.

Execute the commands in the following order to start the services:

Order (*1) Service Command

1 portmap /etc/rc.d/init.d/portmap start 2 nfslock /etc/rc.d/init.d/nfslock start 3 nfs /etc/rc.d/init.d/nfs start *1: Indicates the order of priority for starting multiple services.

If "nfs" is already running, you must manually apply the changes in "exports" to "nfs". Execute the following command:

# /usr/sbin/exportfs -ar

7

Remove write permissions for the storage area on Server A and Server B. Execute the following command on each server:

• Session data area:

# chmod -R 000 /var/www/cgi-bin/cbgrn/sessiondata

• Attachment area:

# chmod -R 000 /usr/local/cybozu/mysql-5.0/files

You need to remove the permission to write in the session data directory only if the application servers operate on multiple server computers.

If you keep the permission unchanged, the session data will be stored in the session data area on the application server when the application server fails to mount via NFS.

8

Confirm the status of "portmap" and "nfslock" on Server A and Server B.

Execute the following commands on each server to confirm that the services are running:

• portmap : # /etc/rc.d/init.d/portmap status

• nfslock : # /etc/rc.d/init.d/nfslock status

(31)

Example:

# /etc/rc.d/init.d/portmap status portmap is stopped

# /etc/rc.d/init.d/nfslock status rpc.statd (pid 1654) is running... a: The service is not running. b: The service is running.

9

Start the services.

If any service is not running in the step 8, you must start it. Execute the commands in the following order to start the services:

Order (*1) Service Command

1 portmap # /etc/rc.d/init.d/portmap start 2 nfslock # /etc/rc.d/init.d/nfslock start *1: Indicates the order of priority for starting multiple services.

10

Mount the data area of Server C on Server A and Server B. Execute the following command on each server:

• Session data area (*1):

# mount -o intr,noac "Server C IP address or host name":/var/www/cgi-bin/cbgrn/sessiondata /var/www/cgi-bin/cbgrn/sessiondata

• Attachment area:

# mount -o intr "Server C IP address or host name":/usr/local/cybozu/mysql-5.0/files /usr/local/cybozu/mysql-5.0/files

*1: This command is required only if the application servers operate on multiple server computers.

11

Confirm that the data area on Server C is mounted on Serve A and Server B.

Execute the following commands to confirm that the data area mounted in the step 10 is returned: # mount

Command results:

172.29.10.169:/var/www/cgi-bin/cbgrn/sessiondata/ on /var/www/cgi-bin/ cbgrn/sessiondata type nfs (rw,intr,noac,addr=10.10.203.75)

172.29.10.169:/usr/local/cybozu/mysql-5.0/files on /usr/local/cybozu/ mysql-5.0/files type nfs (rw,intr,addr=10.10.203.75)

a: Session data area on Server C

This line appears only if the application servers operate on multiple server computers. b: Attachment area on Server C

STEP 4: Changing the Service Startup Type

1

Execute the following commands to disable the automatic startup of the database engine or the scheduling service:

Server computer Command

a) b)

a)

(32)

Server computer Command

Server A # /sbin/chkconfig cyde_5_0 off # /sbin/chkconfig cyss_cbgrn off (*1) Server B # /sbin/chkconfig cyde_5_0 off

# /sbin/chkconfig cyss_cbgrn off (*1)

Server C (None)

*1: cbgrn is an installation identifier.

Tip

To mount the session data area automatically on OS boot, you must enable automatic startup of the

•

services. See the following section for how to enable automatic startup:

STEP 5: Starting Garoon 3

1

Execute the commands in the following order to start the services:

• Database engine: /etc/rc.d/init.d/cyde_5_0 start

• Scheduling service: /etc/rc.d/init.d/cyss_cbgrn start (*1) *1: cbgrn is an installation identifier.

2

Start Web servers (httpd) on Server A and Server B. Execute the following command:

# /etc/init.d/httpd start

Confirm that the administrative functions and the applications work properly in Garoon 3.

STEP 6: Registering Information Before Starting Operation

1

Register the required information before starting operation. Specify administrators and edit customer information.

"4.2 Registering Information Before Starting Operation" on page 45

Notes for Operation

Under the server distributed system, you must regularly delete temporary files from the Web server. See the following section for how to delete temporary files:

"6.1 Deleting Temporary Files" on page 59.

Enabling Service Automatic Startup

To automatically mount a directory on another server computer, add the destination directory to the "fstab" file, and then change the required services to automatically start on boot.

(33)

Open the "fstab" file on each server, and add the directory to be mounted. File location /etc/fstab

Mount point for session data

"Server C IP address or host name":/var/www/cgi-bin/cbgrn/ sessiondata /var/www/cgi-bin/cbgrn/sessiondata nfs intr,noac 0 0

Mount point for attachments

"Server C IP address or host name":/usr/local/cybozu/mysql-5.0/

files /usr/local/cybozu/mysql -5.0/files nfs intr 0 0

2

Execute the following commands to verify whether an automatic startup is turned on or off: - portmap: # /sbin/chkconfig --list portmap

- nfslock : # /sbin/chkconfig --list nfslock

The result will show the startup types for each runlevel.

3

Enable the automatic startup of all services on Server A and Server B.

Execute the following commands to enable the automatic startup, if it is disabled in any service in the step 2:

- portmap: # /sbin/chkconfig portmap on - nfslock: # /sbin/chkconfig nfslock on

4

Confirm the startup types of "portmap", "nfslock", and "nfs" on Server C.

Execute the following commands to verify whether an automatic startup is turned on or off. - portmap: # /sbin/chkconfig --list portmap

- nfslock: # /sbin/chkconfig --list nfslock - nfs : # /sbin/chkconfig --list nfs

The result will show the startup types for each runlevel.

5

Enable the automatic startup of all services.

Execute the following commands to enable the automatic startup, if it is disabled in any service in the step 4:

- portmap: # /sbin/chkconfig portmap on - nfslock: # /sbin/chkconfig nfslock on - nfs : # /sbin/chkconfig nfs on

3.2 Building a Server Distributed System using Garoon 3 in Operation

This section describes how to build a server distributed system by migrating Garoon 3 installed on a single server computer to an environment where Garoon 3 operates on multiple server computers. The current server computer will serve as a database server, whereas a new server computer will be used as an application server.

Follow the procedures to build a server distributed system:

(34)

Step 2 Changing the Connection Host for the Database Engine

35

This section assumes the following configuration:

New servers (Application server)

Server A

•

Server B

•

Current server (Database server)

Server C

•

Note

•

STEP 1: Installing Garoon 3

1

Confirm that Web servers (httpd) are running on all servers.

Execute the following command on each server to confirm that the Web servers are in operation: # /etc/init.d/httpd status

If the Web servers are not running, execute the following command to start the Web servers: # /etc/init.d/httpd start

2

Execute either of the following commands in the installer directory:

• # sh grn-3.1.0-linux.bin

• # sh grn-3.1.0-linux-x64.bin

"Installing on Linux" in the Installation Guide.

3

Initialize Garoon 3 on Server A and Server B. "4.1 Initializing Garoon 3" on page 44.

4

Confirm that Garoon 3 on Server A and Server B can be accessed without any problems.

Tip

•

(35)

•

Installation log of Garoon 3: Directory where the installer is located/install.log

•

Installation log of CyDE2: Directory where the installer is located/install_cyde.log

•

STEP 2: Changing the Connection Host for the Database Engine

1

Stop Web servers (httpd) on all servers.

Execute the following command on each server: # /etc/init.d/httpd stop

2

Stop Garoon 3 services on all servers.

To stop the services, execute the commands on Server A, Server B, and Server C in the following order :

• Scheduling service: /etc/rc.d/init.d/cyss_cbgrn stop (*1)

• Database engine: /etc/rc.d/init.d/cyde_5_0 stop *1: cbgrn is an installation identifier.

3

Check the port number that is used for the database engine on Server C. The port number is defined in "port" in the [mysqld] section of the "my.ini" file.

File location /usr/local/cybozu/mysql-5.0/etc/my.ini

[client] port = 3770 socket = /usr/local/cybozu/mysql-5.0/data/mysql.sock default-character-set = utf8 [mysqld] port = 3770 (*1) socket = /usr/local/cybozu/mysql-5.0/data/mysql.sock *1: The port number that is used for the database engine.

4

• File location: C:/var/www/cgi-bin/cbgrn/lwc.ini

• Destination host for connection ("prop:_host" in the [dbconn] section): val:"host name or IP address":"Port number" - Specify the host name, IP address, and port number that are used on Server C.

Example:

class = CB_DatabaseConnection require = "fw/database.csp" prop:_host = val:localhost:3770 prop:_dbname = val:cb_cbgrn Description after the change

(36)

[dbconn]

STEP 3: Changing the Data Storage Directory

Note

•

1

Open the "common.ini" file on Server A and Server B, and enter a unique ID string in the "server_id" property in the [Session] section.

File location /var/www/cgi-bin/cbgrn/common.ini Example ID string - Server A: server1

- Server B: server2

Example description on Server A: [Session] check_hijack = 0 cookie_lifetime = 0 cookie_path = / file_lifetime = 1 save_path = /var/www/cgi-bin/cbgrn/sessiondata/ server_id = server1 a: ID string

2

File location /var/www/cgi-bin/cbgrn/php.ini

[Session]

3

Check the session data area on all servers.

Open the "common.ini" file on each server, and check the value in the "save_path" property. File location /var/www/cgi-bin/cbgrn/common.ini

b

Cybozu Garoon 3 Server Distributed System Installation Guide Edition 3.1 Cybozu, Inc.

Cybozu Garoon 3

Server Distributed System

Installation Guide

Preface

Who Should Use This Guide

Typographic Conventions

Production Environment

Abbreviations

Copying and reproducing this document

Copyrights and Trademarks

Contents

1

Server Distributed System Overview

1.1 System Requirements

Mail servers

1.2 Installing

To install Garoon 3:

Part 1

Confirm the system requirements.

Part 2

Prepare required programs and information.

Part 3

Install the system.

Part 4

Set up Garoon 3 before starting operation.

To upgrade to Garoon 3.1.0:

Part 1

Prepare required programs and information.

Part 2

Upgrade the system.

Part 3

Set up Garoon 3 before restarting operation.

Preparing programs and information for installation

Information required for installing or upgrading

2

Operation on Windows

2.1

Building a Server Distributed System on Installation

STEP 1: Installing Garoon 3

1

2

3

4

5

STEP 2: Changing the Connection Host for the Database Engine

6

8

9

STEP 3: Changing the Data Storage Directory

1

2

3

4

5

6

7

8

9

STEP 4: Changing the Service Startup Type

1

STEP 5: Starting Garoon 3

1

2

STEP 6: Registering Information Before Starting

1

2.2

Building a Server Distributed System using Garoon 3 in Operation

STEP 1: Installing Garoon 3

1

2

3

4

STEP 2: Changing the Connection Host for the Database Engine

1

2

3

4

STEP 3: Changing the Data Storage Directory

1