Cybozu Garoon 3 Server Distributed System Installation Guide Edition 3.1 Cybozu, Inc.
Preface 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 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 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/ In this guide, the trademark symbol (TM) and registered symbol (R) are omitted. OpenSSL (Copyright (c) 1998-2001 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
Preface (http://www.openssl.org/) This product includes cryptographic software written by Eric Young. (eay@cryptsoft.com) This product includes software written by Tim Hudson. (tjh@cryptsoft.com) Cybozu Garoon 3 Server Distributed System Installation Guide Edition 3.1 Published by: Cybozu, Inc. August 2011 Copyright (C) 2011 Cybozu http://cybozu.com/en/ Cybozu Garoon 3 Server Distributed System Installation Guide 3
Contents Contents Preface... 2 Contents... 4 1 Server Distributed System Overview... 5 1.1 System Requirements... 6 1.2 Installing... 8 2 Operation on Windows... 11 2.1 Building a Server Distributed System on Installation... 11 2.2 Building a Server Distributed System using Garoon 3 in Operation...17 2.3 Upgrading Garoon 3...23 2.4 Uninstalling Garoon 3...25 3 Operation on Linux... 26 3.1 Building a Server Distributed System on Installation...26 3.2 Building a Server Distributed System using Garoon 3 in Operation...33 3.3 Upgrading Garoon 3...40 3.4 Uninstalling Garoon 3...42 4 Setting Up Garoon 3 After Installation... 44 4.1 Initializing Garoon 3...44 4.2 Registering Information Before Starting Operation...45 4.3 Changing Database Settings...46 5 Setting Up Garoon 3 After Upgrading... 49 5.1 Executing an Update Program...49 5.2 Changing the Table Cache Size...55 5.3 Resetting an Authentication Password...56 5.4 Registering a License...56 5.5 Executing Delete Privilege Program...57 6 Maintaining Garoon 3 in Operation... 59 6.1 Deleting Temporary Files...59 Index... 61 4 Cybozu Garoon 3 Server Distributed System Installation Guide
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
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
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 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) Protocol Port number (* 1 ) Item Type HTTP or HTTPS 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 Cybozu Garoon 3 Server Distributed System Installation Guide 7
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: 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. "4 Setting Up Garoon 3 After Installation" on page 44. 8 Cybozu Garoon 3 Server Distributed System Installation Guide
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-3.1.0-windows.exe 64-bit OS: grn-3.1.0-windows-x64.exe 32-bit OS: grn-3.1.0-linux.bin 64-bit OS: grn-3.1.0-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. 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 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
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
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 Note Cybozu Garoon 3 Server Distributed System Installation Guide 11
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-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: "Installing on Windows" in the Installation Guide. 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. 7 Stop Garoon 3 services on all servers. 12 Cybozu Garoon 3 Server Distributed System Installation Guide
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
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 9. 14 Cybozu Garoon 3 Server Distributed System Installation Guide
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
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 3. 16 Cybozu Garoon 3 Server Distributed System Installation Guide
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 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 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
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-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: "Installing on Windows" 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 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 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
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
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
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
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 59. 22 Cybozu Garoon 3 Server Distributed System Installation Guide
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 2.0.0 1st: 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 2.1.3 or earlier to Garoon 3.1.0. On each server, execute either of the following installers according to the OS: grn-3.1.0-windows.exe grn-3.1.0-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
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
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. 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
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
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-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 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: 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
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
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
3 Operation on Linux portmap nfslock nfs : # /etc/rc.d/init.d/portmap status : # /etc/rc.d/init.d/nfslock status : # /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. a) b) 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 nfslock : # /etc/rc.d/init.d/portmap status : # /etc/rc.d/init.d/nfslock status 30 Cybozu Garoon 3 Server Distributed System Installation Guide
3.1 Building a Server Distributed System on Installation 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. a) b) 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/ a) 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) b) 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 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. Execute the following commands to disable the automatic startup of the database engine or the scheduling service: Server computer Command Cybozu Garoon 3 Server Distributed System Installation Guide 31
3 Operation on Linux 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 Start Garoon 3 services on Server C. 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. 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 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. 1 Edit the "fstab" file on Server A and Server B. 32 Cybozu Garoon 3 Server Distributed System Installation Guide
3.2 Building a Server Distributed System using Garoon 3 in Operation Open the "fstab" file on each server, and add the directory to be mounted. File location Mount point for session data Mount point for attachments /etc/fstab "Server C IP address or host name":/var/www/cgi-bin/cbgrn/ sessiondata /var/www/cgi-bin/cbgrn/sessiondata nfs intr,noac 0 0 "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 Install Garoon 3 on Server A and Server B. 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: Step Task Page Step 1 Installing Garoon 3 34 Cybozu Garoon 3 Server Distributed System Installation Guide 33
3 Operation on Linux Step Task Page Step 2 Changing the Connection Host for the Database 35 Engine Step 3 Changing the Data Storage Directory 36 Step 4 Changing the Service Startup Type 39 Step 5 Starting Garoon 3 39 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. 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 Install Garoon 3 on Server A and Server B. 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 manual for installation details: "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 If the Garoon 3 screen does not appear properly, verify the following settings: The virtual directory of each Web server is set properly. 34 Cybozu Garoon 3 Server Distributed System Installation Guide
3.2 Building a Server Distributed System using Garoon 3 in Operation 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: Installation log of Garoon 3: Installation log of CyDE2: Directory 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. 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 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 a Cybozu Garoon 3 Server Distributed System Installation Guide 35
3 Operation on Linux [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 "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 enter a unique ID string in the "server_id" property in the [Session] section. File location Example ID string /var/www/cgi-bin/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 = /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 method ;; 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. 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 36 Cybozu Garoon 3 Server Distributed System Installation Guide
3.2 Building a Server Distributed System using Garoon 3 in Operation Session data area Attachment area [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. Example: /var/www/cgi-bin/cbgrn/sessiondata 10.10.203.55(rw) 10.10.203.65(rw) /usr/local/cybozu/mysql-5.0/files 10.10.203.55(rw) 10.10.203.65(rw) a: Session data area b: Attachment area a b 5 Confirm the status of "portmap", "nfs", and "nfslock" on Server C. Execute the following commands to confirm that the services are running: 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. a b 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 Cybozu Garoon 3 Server Distributed System Installation Guide 37
3 Operation on Linux 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 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 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. a b 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 38 Cybozu Garoon 3 Server Distributed System Installation Guide
3.2 Building a Server Distributed System using Garoon 3 in Operation 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 a /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/ b 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 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. Execute the following commands to disable the automatic startup of the database engine or the scheduling service: Server computer Command for disabling each service 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: "Enabling Service Automatic Startup " on page 32 STEP 5: Starting Garoon 3 1 Start Garoon 3 services on Server C. Execute the commands in the following order to start the services: Database engine: /etc/rc.d/init.d/cyde_5_0 start Cybozu Garoon 3 Server Distributed System Installation Guide 39
3 Operation on Linux Scheduling service: /etc/rc.d/init.d/cyss_cbgrn start * 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. 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. 3.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 "root" users. 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. Locate the installer in the directory that is accessible by Web server users such as Apache. All directories above the installer directory must be executable and writable by the Web server users. If you are using NFS, keep the mounted directories on the application server when you upgrade the system. 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. "Maintenance" in the Administrator Guide. After backing up, confirm that the database engine is running on Server C. 2 Stop Web servers (httpd) on Server A and Server B. Execute the following command: # /etc/init.d/httpd stop 3 Stop the scheduling service on Server C. Execute the following command: # /etc/rc.d/init.d/cyss_cbgrn stop 40 Cybozu Garoon 3 Server Distributed System Installation Guide
3.3 Upgrading Garoon 3 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.0 1st: Application server (Server A and Server B) 2nd: Database server (Server C) An upgrade program is required to upgrade from Garoon 2.1.3 or earlier to Garoon 3.1.0. 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 upgrade your Garoon. See the following for details on upgrading: "Upgrading on Linux" in the Installation Guide. 5 Confirm that the scheduling service is running on Server C. Execute the following commands to confirm that the services are running: # /etc/rc.d/init.d/cyss_cbgrn status Example: # /etc/rc.d/init.d/cyss_cbgrn status sched(25766) is running... a: The service is running. a 6 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. Execute the following commands to disable the automatic startup of the database engine or the scheduling service: Server computer Command for disabling each service 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. 7 Start Web servers (httpd) on Server A and Server B. Execute the following command: # /etc/init.d/httpd start 8 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 Cybozu Garoon 3 Server Distributed System Installation Guide 41
3 Operation on Linux C before the upgrade. Execute the following command: # /sbin/chkconfig cyss_cbgrn on "cbgrn" is an installation identifier. 9 Set up Garoon 3 before restarting operation. "5 Setting Up Garoon 3 After Upgrading" on page 49. Tip The following upgrade logs are saved in the installer directory after upgrading the system to Garoon 3.1.0: Installation log of Garoon 3 : (installer directory)/install.log Installation log of CyDE2 : (installer directory)/cbgrn/install_cyde.log A permission error may occur if you upgrade the server that is mounted on another server computer. Even if an error message appears, the following lines in the message indicates that the process has been completed successfully: Example error message: Version up script of after install is running... Verion up after process finished successfully. The following log may be output depending on the version of Garoon before upgrading, even if the process is completed successfully: Example error message: [Warning] The syntax '--log_slow_queries' is deprecated and will be removed in MySQL 7.0. Please use '--slow_query_log'/'--slow_query_log_file' instead. 3.4 Uninstalling Garoon 3 Uninstall can be performed by "root" users. To uninstall Garoon 3, use the Garoon 3 installer. 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. If the session data area and the attachment area are mounted on another server, you must unmount the directories before uninstalling the system. Tip See the following section for the installer: "Preparing programs and information for installation" on page 9. See the following for uninstallation details: "Uninstalling on Windows" in the Installation Guide. 1 Move to the directory where the installer is located. 2 Execute an installer on all servers. 42 Cybozu Garoon 3 Server Distributed System Installation Guide
On each server, execute the installer according to the OS. Execute either of the following commands in the installer directory: 3.4 Uninstalling Garoon 3 # sh grn-3.1.0-linux.bin # sh grn-3.1.0-linux-x64.bin Follow the instructions on the screen to uninstall Garoon 3 CGI programs and Cybozu database engine. Select the values as follows: Installation identifier Uninstalling Garoon 3 CGI programs Uninstalling Cybozu database engine cbgrn "3" (Complete uninstallation) To keep the configuration file and the template files, select "2" (Partial uninstallation). "3" (Complete uninstallation) Select "1" (Do not uninstall) to cancel the uninstallation. - To keep the configuration file and the database data, select "2" (Partial uninstallation). Cybozu Garoon 3 Server Distributed System Installation Guide 43
4 Setting Up Garoon 3 After Installation 4 Setting Up Garoon 3 After Installation This chapter describes how to set up Garoon 3 including initialization, registration of administrators, and so on, assuming that Garoon 3 has been installed using the default directories and the default installation identifier (cbgrn). 4.1 Initializing Garoon 3 You can initialize Garoon 3 by one of the following methods: Command line: Use command lines to initialize Garoon 3. Web browser: Use a Web browser to initialize Garoon 3. You may need to initialize Garoon 3 in the following cases: Right after installation: Initialize the database. You can install calendars and sample data if required. After starting operation: Delete sample data and other data added during the trial period. Note Make sure that you do not display any other screen during the initialization process, otherwise the initialization may fail. You need to initialize Garoon 3 to change the default locale. All added data will be deleted once Garoon 3 is initialized. Initializing Garoon 3 from a Command Line Use the following initialization commands: db_admin_password db_user_password garoon_admin_password default_timezon default_locale On Windows Enter the database administrator's password. Enter the database user password. Enter the administrator password. Enter the time zone information. Enter the locale information. Select the default language from Japanese, English, and Simplified Chinese. 1 Launch the command prompt. 2 Move to the directory where "grn_command.exe" is located. 3 Execute the following command to initialize Garoon 3. grn_command.exe -f code command grn_initialize.csp db_admin_password='cybozu' db_user_password='cybozu' garoon_admin_password='cybozu' default_timezone='asia/tokyo' default_locale='ja' On Linux 44 Cybozu Garoon 3 Server Distributed System Installation Guide
4.2 Registering Information Before Starting Operation 1 Launch the console. 2 Move to the directory where "grn_command" is located. 3 Execute the following command to initialize Garoon 3../ grn_command -f code/command/grn_initialize.csp db_admin_password='cybozu' db_user_password='cybozu' garoon_admin_password='cybozu' default_timezone='asia/tokyo' default_locale='ja' Initializing Garoon 3 from a Web Browser 1 Access the following URL: http://server IP address or host name/scripts/cbgrn/grn.exe/initialize This URL assumes that Garoon 3 has been installed on the default installation directory. 2 Set the desired options on the Initialize Garoon screen and click Initialize. "Preparing programs and information for installation" on page 9. 4.2 Registering Information Before Starting Operation Before starting operation, you must register customer information and system administrator information. Editing Customer Information 1 Access the system administration screen of Garoon 3. 2 Enter the login name and the password of an administrator or a superuser, and click Login. 3 On the system administration screen, click Basic system administration > Customer information > Verify customer information. 4 Click Edit on the Verify customer information screen. 5 Set the desired options and click Save. See the following for configuration details: "Editing Customer Information" in the Administrator Guide. Specifying System Administrators Specify users as system administrators by granting "Administrator" roles. 1 On the system administration screen, click Basic system administration > Users > Organization / user settings. Cybozu Garoon 3 Server Distributed System Installation Guide 45
4 Setting Up Garoon 3 After Installation 2 Click Add user on the Organization / user settings screen. 3 On the Add user screen, set the desired options and click Add. See the following manual for configuration details: "Adding Users" in the Administrator Guide. Specifying users as system administrators 1 On the system administration screen, click Basic system administration > Users > Role setting. 2 On the Role setting screen, click Administrators > Grant role to users. 3 On the Grant role to users screen, click Unassigned users on the tree on the left. 4 Select users to grant the Administrator role and click Add. To remove a selected user, select the user in the lower box, and click Remove. 5 Click Grant role. 4.3 Changing Database Settings To change the mysqld settings, you must edit the configuration file (my.ini) on the database server. The "my.ini" file may require different values depending on the on-board memory of the server computer where the database engine is installed. If the on-board memory does not exceed 4 GB "mysqld" is automatically configured based on the on-board memory when Garoon 3 is newly installed. If the on-board memory exceeds 4 GB To enhance your system performance, you can edit the "my.ini" file to set values suitable for each memory capacity.the following table illustrates the recommended configuration of the "my.ini" file, including on-board memory of the server, memory usage of Garoon 3, and the respective values: 48 GB On-board memory 4 to 8 8 to 12 12 to 16 to 24 to or Memory GB GB 16 GB 24 GB 48 GB more Memory usage of Garoon 3 2 GB 5.2 GB 8.4 GB 12 GB 18 GB 36 GB my.ini Recommended value sort_buffer_size 1 M 1 M 1 M 1 M 1 M 1 M join_buffer_size 3 M 3 M 3 M 3 M 3 M 3 M read_buffer_size 1 M 1 M 1 M 1 M 1 M 1 M read_rnd_buffer_size 2 M 2 M 2 M 2 M 2 M 2 M thread_cache_size 50 50 50 50 50 50 max_connections 50 50 50 50 50 50 innodb_buffer_pool_si ze 1500 M 4500 M 7800 M 11500 M 17600 M 36100 M 46 Cybozu Garoon 3 Server Distributed System Installation Guide
Note 4.3 Changing Database Settings When you set the values, make sure that the total memory usage of the OS, Garoon 3, and other programs is under the on-board memory capacity of the server computer. We recommend that you edit the "my.ini" file according to the recommended configuration, if you are using a 32-bit OS whose on-board memory exceeds 4 GB. Tip For more information on how to configure "my.ini" file, contact our official partners or your vendor. Editing my.ini Edit the "my.ini" file to set values suitable for your server computer. On Windows 1 Stop Garoon 3 services. 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 2 Back up the "my.ini" file. "my.ini" is saved in the following location if Garoon 3 has been installed in the default directories: C: Program Files Cybozu mysql-5.0 etc my.ini 3 Edit the values of "my.ini". "If the on-board memory exceeds 4 GB" on page 46. 4 Start Garoon 3 services. 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. On Linux 1 Stop Garoon 3 services on all servers. Execute the commands in the following order to start the services: Scheduling service: /etc/rc.d/init.d/cyss_cbgrn stop (* 1 ) * 1 : cbgrn is an installation identifier. Database engine: /etc/rc.d/init.d/cyde_5_0 stop 2 Back up the "my.ini" file. "my.ini" is saved in the following location if Garoon 3 has been installed in the default directories: /usr/local/cybozu/mysql-5.0/etc/my.ini Cybozu Garoon 3 Server Distributed System Installation Guide 47
4 Setting Up Garoon 3 After Installation 3 Edit the values of "my.ini". "If the on-board memory exceeds 4 GB" on page 46. 4 Start Garoon 3 services on all servers. Execute the commands in the following order to start the services: Database engine: /etc/rc.d/init.d/cyde_5_0 stop Scheduling service: /etc/rc.d/init.d/cyss_cbgrn stop (* 1 ) * 1 : cbgrn is an installation identifier. 48 Cybozu Garoon 3 Server Distributed System Installation Guide
5.1 Executing an Update Program 5 Setting Up Garoon 3 After Upgrading Depending on the version of Garoon before upgrading, some additional configurations may be required. This chapter assumes the following configuration: Item Example Environment CGI directory on the Web server - On Windows : C: Inetpub scripts - On Linux : /var/www/cgi-bin/cbgrn Installation identifier cbgrn Server configuration Application server - Server A - Server B Database server Server C 5.1 Executing an Update Program You must execute the update program "versionup3.csp" on all servers, if you have upgraded from Garoon 2.5.x to Garoon 3.1.0. Execute the update program in the following order: 1. Database server 2. Application server If you access Garoon 3 without executing "versionup3.csp", you will be prompted by a message to execute the program. Tip "versionup3.csp" will be deleted when the program is executed successfully. On Windows 1 Stop Web servers on Server A and Server B. 2 Start the database engine on Server A and Server B. From the Windows Start menu, select Control Panel > Administrative Tools > Services, and start the following services: Database engine: Cybozu_Database_Engine_5_0 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 may be replaced by your installation identifier. 4 Launch the command prompt and change the current directory. Cybozu Garoon 3 Server Distributed System Installation Guide 49
5 Setting Up Garoon 3 After Upgrading Launch the command prompt on each server, and change the current directory to where "grn.exe" is located. > cd C: Inetpub scripts cbgrn 5 Execute the update program from the command line. Execute the update program in the following order: 1. Server C 2. Server A and Server B Execute the following command: > grn_command.exe -f tmp versionup_scripts versionup3.csp After executing the program on each server, you will be prompted to enter the database administrator's password (cbroot). "Preparing programs and information for installation" on page 9. 6 Start the scheduling service on Server C. From the Windows Start menu, select Control Panel > Administrative Tools > Services, and start the following services: Scheduling service: Cybozu_Scheduling_Service_cbgrn (* 1 ) * 1 : cbgrn may be replaced by your installation identifier. 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 Start Web servers on Server A and Server B. 9 Check the command results. Open the log file to check the results. Example: C: Inetpub scripts cbgrn versionup3_###.log - ### indicates a 3 digit number. "Verifying Logs" on page 52. On Linux 1 Start Web servers (httpd) on Server A and Server B. Execute the following command: # /etc/init.d/httpd stop 2 Start the database engine on Server A and Server B. Execute the following command: 50 Cybozu Garoon 3 Server Distributed System Installation Guide
5.1 Executing an Update Program # /etc/rc.d/init.d/cyde_5_0 start 3 Stop the scheduling service on Server C. Execute the following command: # /etc/rc.d/init.d/cyss_cbgrn stop (* 1 ) * 1 : "cbgrn" is an installation identifier. 4 Move the current directory. Move the current directory on each server to where "grn.cgi" is located. # cd /var/www/cgi-bin/cbgrn 5 Execute "versionup3.csp" from the command line. Execute the update program in the following order: 1. Server C 2. Server A and Server B Execute the following command: #./grn_command -f tmp/versionup_scripts/versionup3.csp After executing the program on each server, you will be prompted to enter the database administrator's password (cbroot). "Preparing programs and information for installation" on page 9. 6 Start the scheduling service on Server C. Execute the following command: # /etc/rc.d/init.d/cyss_cbgrn start (* 1 ) * 1 : "cbgrn" may be replaced by your installation identifier. 7 Stop the database engines on Server A and Server B. Execute the following command: # /etc/rc.d/init.d/cyde_5_0 stop 8 Start Web servers on Server A and Server B. Execute the following command: # /etc/init.d/httpd start 9 Check the command results. Open the log file to check the results. Example: /var/www/cgi-bin/cbgrn/versionup3_###.log "###" indicates a 3 digit number. "Verifying Logs" on page 52. Cybozu Garoon 3 Server Distributed System Installation Guide 51
5 Setting Up Garoon 3 After Upgrading Verifying Logs Open the log files to verify that the update program has been executed successfully. The log files contain the following information: Report on the MySQL update Report on the update of Garoon 3 data Report on the update program execution The logs are saved in the following files if Garoon 3 has been installed in the default directories: OS Windows Report on "versionup3.csp" execution C: Inetpub scripts cbgrn versionup3_###.log Linux /var/www/cgi-bin/cbgrn/versionup3_###.log ### indicates a 3 digit number. MySQL errors C: Program Files Cybozu mysql-5.0 data error.log /usr/local/cybozu/mysql-5.0/data/error.lo g 52 Cybozu Garoon 3 Server Distributed System Installation Guide
5.1 Executing an Update Program Output of "versionup3_###.log This example assumes that the log is exported on Windows. [Tue, 13 Jul 2010 13:01:46 +0900] DB root password corrected! [Tue, 13 Jul 2010 13:01:46 +0900] start upgrading mysqldb [Tue, 13 Jul 2010 13:03:28 +0900] execute mysql_upgrade command finished. [Tue, 13 Jul 2010 13:03:28 +0900] Looking for 'mysql.exe' as: C: Program Files Cybozu mysql-5.0 bin mysql.exe [Tue, 13 Jul 2010 13:03:28 +0900] Looking for 'mysqlcheck.exe' as: C: Program Files Cybozu mysql-5.0 bin mysqlcheck.exe [Tue, 13 Jul 2010 13:03:28 +0900] Running 'mysqlcheck' with connection arguments: "--port=3770" "--host=127.0.0.1" [Tue, 13 Jul 2010 13:03:28 +0900] Running 'mysqlcheck' with connection arguments: "--port=3770" "--host=127.0.0.1" [Tue, 13 Jul 2010 13:03:28 +0900] cb_cbgrn._table_info OK [Tue, 13 Jul 2010 13:03:28 +0900] cb_cbgrn.tab_cb_backupmode OK [...] [Tue, 13 Jul 2010 13:03:30 +0900] end upgrading mysqldb [Tue, 13 Jul 2010 13:03:33 +0900] 20100713 13:03:30 [INFO] Started updating. 20100713 13:03:30 [INFO] Started grn3.1.0_local_main. 20100713 13:03:30 [INFO] Updated the version number of system attribute. 3.1.0 20100713 13:03:30 [INFO] Successeed to delete table 'tab_grn_message_addressees' [...] 20100713 13:03:33 [INFO] Finished updating. [Tue, 13 Jul 2010 13:03:40 +0900] 20100713 13:03:34 [INFO] Started updating after installation. 20100713 13:03:34 [INFO] Deleting old time zone data. [...] 20100713 13:03:40 [INFO] Finished updating after installation. [Tue, 13 Jul 2010 13:03:40 +0900] start removing versionup scripts [Tue, 13 Jul 2010 13:03:40 +0900] end removing versionup scripts a : Report on the MySQL update b : Report on the update of Garoon 3 data c : Report on the "versionup3.csp" execution a b c Cybozu Garoon 3 Server Distributed System Installation Guide 53
5 Setting Up Garoon 3 After Upgrading Depending on your Garoon version, the update program may require the database to be fixed. The following log will be output after fixing the database even if the process is completed successfully: mysql.help_category error : Table upgrade required. Please do "REPAIR TABLE `help_category`" or dump/reload to fix it! [...] Repairing tables mysql.help_category OK mysql.help_keyword OK a mysql.help_topic OK mysql.proc OK mysql.time_zone_name OK a : Status Note If any status other than "INFO" or "OK" is output, follow the instruction in the message to troubleshoot. For information on the cause of the errors, contact our official partners or your vendor. Tip The following errors require no action if the status is "OK": Example of "mysql.general_log" (general query log table): [Tue, 13 Jul 2010 13:03:30 +0900] mysql.general_log [Tue, 13 Jul 2010 13:03:30 +0900] Error : You can't use locks with log tables. [Tue, 13 Jul 2010 13:03:30 +0900] status : OK Example of "mysql.slow_log" (slow query log table): [Tue, 13 Jul 2010 13:03:30 +0900] mysql.slow_log [Tue, 13 Jul 2010 13:03:30 +0900] Error : You can't use locks with log tables. [Tue, 13 Jul 2010 13:03:30 +0900] status : OK MySQL errors Temporary errors may occur while files and data of MySQL are gradually updated. The following error will be output in the "error.log" file even if the process is completed successfully: Example error messages on Windows: 100713 14:46:05 InnoDB: Started; log sequence number 0 40732198 100713 14:46:06 [ERROR] Column count of mysql.db is wrong. Expected 22, found 20. Created with MySQL 50046, now running 50142. Please use mysql_upgrade to fix this error. 100713 14:46:06 [ERROR] mysql.user has no `Event_priv` column at position 29 100713 14:46:06 [ERROR] Event Scheduler: An error occurred when initializing system tables. Disabling the Event Scheduler. 100512 14:46:06 [Note] C: Program Files Cybozu mysql-5.0 bin mysqld.exe: ready for connections. Version: '5.1.42-enterprise-cybozu' socket: '' port: 3770 MySQL Enterprise Server (Commercial) - Cybozu a : Error messages a Note For information on the cause of the errors, contact our official partners or your vendor. 54 Cybozu Garoon 3 Server Distributed System Installation Guide
5.2 Changing the Table Cache Size 5.2 Changing the Table Cache Size If you have upgraded from Garoon 2.5.4 or earlier, you must change the table cache size. On Windows 1 Stop Garoon 3 services on all servers. Execute the commands in the following order to stop the services: 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. Database engine: Cybozu_Database_Engine_5_0 2 Change the value of "table_cache" on all servers. Open the "my.ini" file on each server, and change the value of "table_cache". "my.ini" is saved in the following location if Garoon 3 has been installed in the default directories: C: Program Files Cybozu mysql-5.0 etc my.ini Description before the change ## table_cache = max_connections * 2 max_connections = 50 table_cache = 600 Description after the change ## table_cache = max_connections * 2 max_connections = 50 table_cache = 1300 3 Start Garoon 3 services on all servers. Execute the commands in the following order to start the services: 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. Note We recommend that you edit the database server configuration file (my.ini). Configuring suitable values in the "my.ini" file will enhance your system performance. "4.3 Changing Database Settings" on page 46. On Linux 1 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 ) * 1 : cbgrn is an installation identifier. Database engine: /etc/rc.d/init.d/cyde_5_0 stop Cybozu Garoon 3 Server Distributed System Installation Guide 55
5 Setting Up Garoon 3 After Upgrading 2 Change the value of "table_cache" on all servers. Open the "my.ini" file on each server, and change the value of "table_cache". "my.ini" is saved in the following location if Garoon 3 has been installed in the default directories: /usr/local/cybozu/mysql-5.0/etc/my.ini Description before the change ## table_cache = max_connections * 2 max_connections = 50 table_cache = 600 Description after the change ## table_cache = max_connections * 2 max_connections = 50 table_cache = 1300 3 Start Garoon 3 services on all servers. Execute the commands in the following order to start the services: Database engine: /etc/rc.d/init.d/cyde_5_0 stop Scheduling service: /etc/rc.d/init.d/cyss_cbgrn stop (* 1 ) * 1 : cbgrn is an installation identifier. Note We recommend that you edit the database server configuration file (my.ini). Configuring suitable values in the "my.ini" file will enhance your system performance. "4.3 Changing Database Settings" on page 46. 5.3 Resetting an Authentication Password This section describes how to reset the Cybozu Common Authentication password. Tip You must reset the authentication password when all the following conditions are met: The system has been upgraded from Garoon 2.5.2 or earlier to Garoon 3.1.0. Cybozu Common Authentication was active before upgrading. You intend to use either Open Integrated Authentication ver.2 or Cybozu Common Authentication after upgrading. 1 On the system administration screen, click Basic system administration > Authentication > Session authentication. 2 On the Session authentication screen, select the session authentication name for Cybozu Common Authentication that was in use before upgrading, and click Edit. 3 On the Edit session authentication method screen, enter the authentication password, and then click Save. You can use the same password as that used before upgrading. 5.4 Registering a License You must register a new user license of Garoon 3 after upgrading from Garoon 2 to Garoon 3. 56 Cybozu Garoon 3 Server Distributed System Installation Guide
5.5 Executing Delete Privilege Program 1 On the system administration screen, click Basic system administration > License > Manage licenses. 2 Click Register license on the Manage licenses screen. 3 On the License registration screen, enter the license information, and then click Register. Enter the customer number and the license key that are listed on the license certificate. 4 On the Confirm license details screen, confirm the details, and then click Register. Note Garoon 3 operates as a trial version unless you register the new license. If you do not register the license within 60 days after upgrading, the users can no longer use Garoon 3. Tip See the following manual for how to manage licenses: "License" in the Administrator Guide. 5.5 Executing Delete Privilege Program You must execute Delete Privilege Program if you have upgraded from Garoon 3.0.0 or later. This program is not required for Garoon 2.5.4 or earlier. If required, execute this program to remove the unnecessary privileges that are granted by error. Note If any maintainers have been added in Messages in Garoon 3.0.0, we recommend that you specify the before=yyyy-mm-dd parameter using the date on which you upgraded Garoon to version 3.0.0. All maintainers may be removed from Messages if you specify the before=yyyy-mm-dd parameter using a date later than the upgrade date. This section describes the command parameters and how to execute the program in each environment. Removes all unnecessary privileges. The number of exec messages that contain privileges to be deleted will be displayed if you omit this parameter. The privileges that have been set prior to the specified date before=yyyy-mm-dd (YYYY-MM-DD) will be deleted. On Windows 1 Move to the directory where "grn.exe" is located. >cd C: Inetpub scripts cbgrn 2 Execute the following command: >grn_command.exe -f code command delete_messages_maintainer.csp (parameters) On Linux 1 Move to the directory where "grn.cgi" is located. Cybozu Garoon 3 Server Distributed System Installation Guide 57
5 Setting Up Garoon 3 After Upgrading # cd /var/www/cgi-bin/cbgrn 2 Execute the following command: #./grn_command -f code/command/delete_messages_maintainer.csp (parameters) 58 Cybozu Garoon 3 Server Distributed System Installation Guide
6.1 Deleting Temporary Files 6 Maintaining Garoon 3 in Operation This chapter assumes the following configuration: Item Example Environment CGI directory on the Web server - On Windows: C: Inetpub scripts - On Linux: /var/www/cgi-bin Installation identifier cbgrn Server configuration Application server - Server A - Server B Database server Server C 6.1 Deleting Temporary Files Under the server distributed system, the scheduling service must be stopped on all application servers to prevent the service from being performed redundantly on multiple server computers. Without the scheduling service, temporary files may not be deleted automatically, which requires you to regularly delete the remaining temporary files from all application servers. Execute the commands to delete temporary files stored in the following directories: In and below (CGI directory)/(installation identifier)/tmp In and below (CGI directory)/(installation identifier)/upload_tmp Note The commands will delete all temporary files that are older than 24 hours. Temporary files cannot be deleted in backup mode. See the following for backup mode: "Backup Mode Setting" in the Administrator Guide. Tip Delete temporary files once a day or so. On Windows 1 Launch the command prompt on Server A and Server B, and move to the CGI directory. Execute the following command on each server: > cd C: Inetpub scripts cbgrn 2 Delete the temporary files on Server A and Server B. Execute the following command on each server: > grn_command.exe -f code sched dynamic cleanup.csp The remaining temporary files are deleted from the following directories: C: Inetpub scripts cbgrn tmp C: Inetpub scripts cbgrn upload_tmp Tip To delete temporary files automatically, create a scheduled task on Windows. Cybozu Garoon 3 Server Distributed System Installation Guide 59
6 Maintaining Garoon 3 in Operation We recommend that you perform the automatic deletion task during the period when users do not access Garoon 3. On Linux 1 Launch the console on Server A and Server B, and move to the CGI directory. Execute the following command on each server: # cd /var/www/cgi-bin/cbgrn 2 Delete the temporary files on Server A and Server B. Execute the following command on each server: #./grn_command -f code/sched/dynamic/cleanup.csp The remaining temporary files are deleted from the following directories: /var/www/cgi-bin/cbgrn/tmp /var/www/cgi-bin/cbgrn/upload_tmp Tip To delete temporary files automatically, use cron to automate the execution of commands. We recommend that you perform the automatic deletion task during the period when users do not access Garoon 3. 60 Cybozu Garoon 3 Server Distributed System Installation Guide
Index Index A Administrator... 11 Anonymous access... 14, 20 Attachment... 15, 19, 20, 28 B Back up... 23, 40 C Changing the Connection Host for the Database Engine... 12, 18, 27, 35 Changing the Data Storage Directory... 13, 19, 28, 36 Changing the Service Startup Type... 16, 22, 31, 39 D Database administrator... 10 Database user... 10 Directory CGI directory... 10 E Document root... 10 Enabling Service Automatic Startup... 32 H How to verify logs MySQL errors... 54 I Output of "versionup3_###.log... 53 Information required for installing or upgrading... 9 Installation identifier... 10 Installer... 9 Installing... 12, 26 M N NTP... 11, 26 O On-board memory...46 P Port number... 7, 11, 26 Preface... 2 Preparing programs and information for installation... 9 R root users...26 S Server Application server... 5 Database server... 5 Service nfs...30 nfslock...30 portmap...30 Service type Database engine...16 Scheduling service...16 Session data...15, 20, 21, 28 Session ID...14, 19, 28, 36 System requirements Mail servers... 7 V Network... 7 Server operating systems... 6 Web browsers... 7 Web servers... 7 virtual environments... 8 Mount... 31, 39 my.ini... 46 mysqld... 46 Cybozu Garoon 3 Server Distributed System Installation Guide 61