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

Transcription

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

2 Preface Preface This guide describes the features and operations of Cybozu Garoon Version 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 Note Tip See Section title on page ###. Meaning Indicates important information. Provides a helpful hint or information. 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 The contents of a screen vary depending on the web browser that you are using. Abbreviations Abbreviation Meaning Garoon 3 Cybozu Garoon Version 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: In this guide, the trademark symbol (TM) and registered symbol (R) are omitted. OpenSSL (Copyright (c) The OpenSSL Project. All rights reserved.) This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. 2 Cybozu Garoon 3 Server Distributed System Installation Guide

3 Preface ( This product includes cryptographic software written by Eric Young. This product includes software written by Tim Hudson. Cybozu Garoon 3 Server Distributed System Installation Guide Edition 3.1 Published by: Cybozu, Inc. August 2011 Copyright (C) 2011 Cybozu Cybozu Garoon 3 Server Distributed System Installation Guide 3

4 Contents Contents Preface... 2 Contents Server Distributed System Overview System Requirements Installing Operation on Windows Building a Server Distributed System on Installation Building a Server Distributed System using Garoon 3 in Operation Upgrading Garoon Uninstalling Garoon Operation on Linux Building a Server Distributed System on Installation Building a Server Distributed System using Garoon 3 in Operation Upgrading Garoon Uninstalling Garoon Setting Up Garoon 3 After Installation Initializing Garoon Registering Information Before Starting Operation Changing Database Settings Setting Up Garoon 3 After Upgrading Executing an Update Program Changing the Table Cache Size Resetting an Authentication Password Registering a License Executing Delete Privilege Program Maintaining Garoon 3 in Operation Deleting Temporary Files...59 Index Cybozu Garoon 3 Server Distributed System Installation Guide

5 1.1 System Requirements 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: Load balancer Server A Server B Application server Web server Application server Web server Database server Database engine (Not in operation) Database server Database engine (Not in operation) Server C Application server Web server (Not in operation) Database server Database engine Tip You can distribute an application server over multiple server computers. Cybozu Garoon 3 Server Distributed System Installation Guide 5

6 1 Server Distributed System Overview 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 installing Garoon 3. 6 Cybozu Garoon 3 Server Distributed System Installation Guide

7 1.1 System Requirements Web servers Windows Linux OS Web server Apache 2.0.x, 2.2.x Internet Information Service (IIS) 6.0, 7.0, 7.5 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 client. This product supports the following mail servers: Protocols: SMTP SMTPS POP3 POP3S IMAP4 This product currently supports only the receiving feature of IMAP4. You cannot use other features of IMAP4. Authentication methods: APOP POP before SMTP SMTP Authentication Network (TCP/IP) Protocol Port number (* 1 ) Item Type HTTP or HTTPS Web server HTTP : 80 HTTPS : 443 NETBIOS: (* 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 Cybozu Garoon 3 Server Distributed System Installation Guide 7

8 1 Server Distributed System Overview 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: This website is currently available only in Japanese. For more server examples, see the following page on our website: 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 or earlier to Garoon 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. "4 Setting Up Garoon 3 After Installation" on page Cybozu Garoon 3 Server Distributed System Installation Guide

9 1.2 Installing To upgrade to Garoon 3.1.0: Part 1 Prepare required programs and information. "Preparing programs and information for installation" on page 9. 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 On Windows On Linux Description 32-bit OS: grn windows.exe 64-bit OS: grn windows-x64.exe 32-bit OS: grn linux.bin 64-bit OS: grn linux-x64.bin Install Usage Upgrade Tip The Garoon 3 installer for each OS can be downloaded on our website. This website is currently available only in Japanese. You need to configure Garoon 3 if you use SSL to connect to LDAP. For configuration steps, see the following page on our website. 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 Item Administrator password or superuser password Garoon 3 administrator information Description Password that is required for initialization or login to the administration screen. - User name - Login name - Password Install Usage Upgrade Cybozu Garoon 3 Server Distributed System Installation Guide 9

10 1 Server Distributed System Overview Item Customer information Document root CGI directory Installation identifier Database administrator password Database user passwords Description - Company name - Pronunciation of company name - Logo (* 1 ) The directory that stores HTML files and image files to be published by the Web server The directory on the Web server where CGI scripts can be executed 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. The password that is used to manage the database engine. You can enter 6 to 10 characters. (* 2 ) The password that is used to access user data. You can enter 6 to 10 characters. (* 2 ) Install Usage Upgrade License Garoon 3 license Memory capacity for The on-board memory of the server server computers 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 "_" Numeric characters from 0 to 9 10 Cybozu Garoon 3 Server Distributed System Installation Guide

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. Tip For how to set up a web server, see the following page on our website: 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 Note Cybozu Garoon 3 Server Distributed System Installation Guide 11

12 2 Operation on Windows 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 windows.exe grn windows-x64.exe Follow the instructions on the screen to install Garoon 3. See the following manual for installation details: "Installing on Windows" in the Installation Guide. 3 Initialize Garoon 3 on all servers. "4.1 Initializing Garoon 3" on page 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 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: 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. 7 Stop Garoon 3 services on all servers. 12 Cybozu Garoon 3 Server Distributed System Installation Guide

13 2.1 Building a Server Distributed System on Installation 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 Port number description C:/Program Files/Cybozu/mysql-5.0/etc/my.ini [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 a prop:_dbname = val:cb_cbgrn [dbconn] class = CB_DatabaseConnection require = fw/database.csp prop:_host = val:server_c:3770 b 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. Cybozu Garoon 3 Server Distributed System Installation Guide 13

14 2 Operation on Windows 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 Example ID string C: Inetpub scripts cbgrn common.ini - 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 a 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 Cybozu Garoon 3 Server Distributed System Installation Guide

15 2.1 Building a Server Distributed System on Installation 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] ; Handler used to store/retrieve data. Session data storage ;; Framework method ;; 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] save_path = "save_path = "//'Server C IP address'/sessiondata/sessionfiles"" (* 1 ) Cybozu Garoon 3 Server Distributed System Installation Guide 15

16 2 Operation on Windows * 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 Server A Server B Server C * 1 : cbgrn is an installation identifier. Service to disable - Cybozu_Database_Engine_5_0 - Cybozu_Scheduling_Service_cbgrn (* 1 ) - Cybozu_Database_Engine_5_0 - Cybozu_Scheduling_Service_cbgrn (* 1 ) (None) 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: Database engine: Cybozu_Database_Engine_5_0 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. Confirm that the administrative functions and the applications work properly in Garoon Cybozu Garoon 3 Server Distributed System Installation Guide

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. "Preparing programs and information for installation" on page 9. 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 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 Task Page 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 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 9. 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: See "Installing on Windows" in the Installation Guide. Cybozu Garoon 3 Server Distributed System Installation Guide 17

18 2 Operation on Windows 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: grn windows.exe grn windows-x64.exe Follow the instructions on the screen to install Garoon 3. See the following manual for installation details: "Installing on Windows" in the Installation Guide. 3 Initialize Garoon 3 on Server A and Server B. "4.1 Initializing Garoon 3" on page Confirm that Garoon 3 on Server A and Server B 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: 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 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: Scheduling service: Cybozu_Scheduling_Service_cbgrn (* 1 ) * 1 : cbgrn is an installation identifier. Database engine: Cybozu_Database_Engine_5_0 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 C: Program Files Cybozu mysql-5.0 etc my.ini 18 Cybozu Garoon 3 Server Distributed System Installation Guide

19 2.2 Building a Server Distributed System using Garoon 3 in Operation [client] port = 3770 socket = /usr/local/cybozu/mysql-5.0/data/mysql.sock Port number description 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 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 Destination host for connection ("prop:_host" in the [dbconn] section) 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 C: Inetpub scripts cbgrn lwc.ini val:host name or IP address:port number - Specify the host name, IP address, and port number that are used on Server C. [dbconn] class = CB_DatabaseConnection require = fw/database.csp prop:_host = val:server_c:3770 b 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 a 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 "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 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 Example ID string C: Inetpub scripts cbgrn common.ini - Server A : server1 - Server B : server2 Cybozu Garoon 3 Server Distributed System Installation Guide 19

20 2 Operation on Windows 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 a 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 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: 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. 20 Cybozu Garoon 3 Server Distributed System Installation Guide

21 2.2 Building a Server Distributed System using Garoon 3 in Operation "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. Proceed to the step 9 if the application server operates on a single server computer. 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] ; Handler used to store/retrieve data. Session data storage ;; Framework method ;; 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] 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. 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. Cybozu Garoon 3 Server Distributed System Installation Guide 21

22 2 Operation on Windows 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. 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: Database engine: Cybozu_Database_Engine_5_0 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. Confirm that the administrative functions and the applications work properly in Garoon 3. If Garoon 3 is not running properly, verify whether all servers have been provided with the required information. "Preparing programs and information for installation" on page 9. 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 Cybozu Garoon 3 Server Distributed System Installation Guide

23 2.3 Upgrading Garoon Upgrading Garoon 3 This section describes how to upgrade your system from Garoon 3.0.x to Garoon 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 We recommend that you upgrade in the following order: Original version Recommended order Notes or later st: Database server (Server C) 2nd: Application server (Server A and Server B) 1st: Application server (Server A and Server B) 2nd: Database server (Server C) An upgrade program is required to upgrade from Garoon or earlier to Garoon On each server, execute either of the following installers according to the OS: grn windows.exe grn windows-x64.exe Follow the instructions on the screen to upgrade your Garoon. See the following manual for details on upgrading: Cybozu Garoon 3 Server Distributed System Installation Guide 23

24 2 Operation on Windows "Upgrading on Windows" in the Installation Guide. 5 Change the directory name of the storage area on Server A and Server B. 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: Database engine: Cybozu_Database_Engine_5_0 8 Disable the automatic startup of Garoon 3 services. 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. 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. 9 Start Web servers on Server A and Server B. 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. From the Windows Start menu, select Control Panel > Administrative Tools > Services, and select Automatic in the startup type. 24 Cybozu Garoon 3 Server Distributed System Installation Guide

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 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 (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. Select Complete Uninstallation from the uninstallation options, and then click Next. To keep the configuration file and the database data, select Partial Uninstallation. Cybozu Garoon 3 Server Distributed System Installation Guide 25

26 3 Operation on Linux 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 /var/www/html Web server Installation identifier cbgrn Port number for the database 3770 engine 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 Task Page Step 1 Installing Garoon 3 26 Step 2 Changing the Connection Host for the Database Engine 27 Step 3 Changing the Data Storage Directory 28 Step 4 Changing the Service Startup Type 31 Step 5 Starting Garoon 3 32 Step 6 Registering Information Before Starting Operation 32 Note 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 9. 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 26 Cybozu Garoon 3 Server Distributed System Installation Guide

27 3.1 Building a Server Distributed System on Installation 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 linux.bin # sh grn 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 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 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: The installation log of Garoon 3 and CyDE2 are saved in the following location: Installation log of Garoon 3 Installation log of CyDE2 : Drectory where the installer is located/install.log : 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 ) Database engine: /etc/rc.d/init.d/cyde_5_0 stop * 1 : cbgrn is an installation identifier. Cybozu Garoon 3 Server Distributed System Installation Guide 27

28 3 Operation on Linux 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 Port number description 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 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:/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: 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 b 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 a 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 3 if the application server operates on a single server computer. Note Valid characters for the ID string in "server_id" are: 0-9, a-z, and A-Z. 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 /var/www/cgi-bin/cbgrn/common.ini 28 Cybozu Garoon 3 Server Distributed System Installation Guide

29 3.1 Building a Server Distributed System on Installation 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 a 2 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 /var/www/cgi-bin/cbgrn/php.ini [Session] ; Handler used to store/retrieve data. Session data storage ;; Framework method ;; 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. 3 Check the storage area on all servers. Open the "common.ini" file on each server, and check the property. File location Session data area Attachment area /var/www/cgi-bin/cbgrn/common.ini [Session] check_hijack = "0" cookie_lifetime = "0" cookie_path = "/" file_lifetime = "1" save_path = "'session data 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: Cybozu Garoon 3 Server Distributed System Installation Guide 29