Installing in the Linux Environment

This section describes how to install Garoon in the Linux Environment.
For example, the steps below are based on the following operation environment:

OS: Red Hat Enterprise Linux 9
Web server service: Apache 2.4.53
CGI directory of the Web server: /var/www/cgi-bin
Document root directory of the Web server: /var/www/html
MySQL: Using MySQL bundled in the Garoon installer

Steps:

Log into the server machine as a root user.
Check httpd.conf to ensure that KeepAlive is disabled.
For details on how to check or edit KeepAlive settings, refer to (Only for Linux) Disabling KeepAlive in Apache.
Note
- When you choose to enable KeepAlive, you should adjust the KeepAliveTimeout value for your environment.
  The greater the value of KeepAliveTimeout, the more likely Garoon is to respond slowly when Garoon handles many requests.
Check that the THP function is disabled.
```
[root@garoon admin]# cat /sys/kernel/mm/transparent_hugepage/enabled
```
If "never" is surrounded by [ ], the THP function is disabled.
Example:
```
always madvise [never]
```
If "[always] madvise never" or "always [madvise] never" is displayed, the THP function is enabled.
Disable THP, if it is enabled. For details, refer to (Only for Linux) Disabling Transparent Huge Pages (THP).
Move to the directory where the installer exists.

Execute the installer.

[root@garoon admin]# sh grn-6.0.x-linux-x64.bin

Check the displayed information, type 'Y' or 'N', and press the Enter key.
When you type 'Y', messages for step 7 and beyond will be shown in Japanese. When you type 'N', messages for step 7 and beyond will be shown in English. The following procedure assumes that you type 'Y':
```
Installing starts. このメッセージが正しく表示されている場合はYを入力します。  
Installing starts. If the above message is displayed correctly, type 'Y', otherwise type 'N'.
```
Read the Software License Agreement carefully. If you agree with it, type "yes" and press the Enter key.
To scroll the window, press the Space or Enter key.
Type an installation identifier and press the Enter key.
The initial setting is "cbgrn". If you want to change the setting, type any installation identifier and press the Enter key.
The installation identifier that you enter here will be included in the URL to access Garoon.
```
Enter the installation identifier.

Valid characters are: a-z, A-Z, 0-9, and underscore (_). An identifier cannot start with a number.
The installation identifier must be up to 10 characters.
[cbgrn]:
```

Select which MySQL installation to use. Select '1' and press the Enter key.

Select whether to install the bundled MySQL Community Server (GPL) automatically (Recommended), or to use MySQL already installed on the server.  
1: Install the bundled MySQL Community Server (GPL) automatically  
2: Use MySQL already installed on the server  
[1|2]:
  

Confirm the installation directory for Garoon programs and data, and then press the Enter key.
If you want to change the installation directory, type the absolute path of another directory, and then press the Enter key.
```
Specify a directory for program files.  
Check available free disk space. The data size may become large.  
[/usr/local/cybozu]:
```

Type the database administrator password and press the Enter key.

Enter a password for the database administrator (cbroot).
Valid characters are: a-z, A-Z, 0-9, and underscore (_).
Passwords must be 6 to 10 characters.

Enter Password:

Type the database user password and press the Enter key.

Enter a password for the database user.
Valid characters are: a-z, A-Z, 0-9, and underscore (_).
Passwords must be 6 to 10 characters.

Enter Password:

Type the Administrator password and press the Enter key.
```
Enter a password for "Administrator".  
Enter Password:
```
- Passwords must be 6 to 10 characters long.
- Passwords can contain the following characters.
  - a-z
  - A-Z
  - 0-9
  - _
- The following characters are not acceptable: less than sign (<), greater than sign (>), vertical bar (|), and ampersand (&). In some environments, other symbols are also unacceptable.
Confirm the CGI directory of the Web server and press the Enter key.
If you want to change the CGI directory, type the absolute path of another directory, and then press the Enter key.
```
Set the CGI directory.  
The installation directory is set to "(CGI directory)/cbgrn".  
Example: /var/www/cgi-bin/cbgrn  
[/var/www/cgi-bin]:
```
Confirm the document root directory of the Web server and press the Enter key.
If you want to change the document root directory, type the absolute path of another directory, and then press the Enter key.
```
Specify the document root directory.  
The installation directory is set to "(document root directory)/cbgrn".  
Example: /var/www/html/cbgrn  
[/var/www/html]:
```
Confirm the name of the Run As user of the Web server and press the Enter key.
When you want a different Run As user, type the name of the user and press the Enter key.
```
Enter the Web server Run As user name.  
[apache]:
```
When "nobody" is displayed, it indicates that the Web server service is not running. Press Ctrl + C to suspend the installation. Start the Web server service, and then execute the installer again.
Select which data sets you want to install, and press the Enter key.
You can select which data sets to install only if you typed 'Y' in step 6 and the display language is Japanese. This message does not appear if you typed 'N' in step 4.
```
Select the data that you want to install on Garoon. Select "Nothing" to install no data.
1: Standard
   Installs standard data, including Japanese holidays and request forms.
2: Nothing
[1|2]:
```
In the standard data, holidays, samples of workflow request form, and other information are registered. It is recommended that you install standard data if you plan to create users from scratch in Garoon.
You can also install standard data at a later time. For details, refer to Initializing Garoon in the Linux Environment.

Check the displayed information. If it is correct, type "yes", and then press the Enter key.

The installation will start.

Summary of install configuration
Installation directory for program files:	/usr/local/cybozu
Database administrator:	cbroot
Database administrator password:	cybozu
"Administrator" password:	cybozu
Database user password:	cybozu
Data to be installed:	Standard data
Installation identifier:	cbgrn
Web server user name:	apache
CGI installation directory:	/var/www/cgi-bin/cbgrn
Installation directory for image files:	/var/www/html/cbgrn
Port number for communicating with MySQL:	3770
Installation script for scheduling service:	/etc/systemd/system/cyss_cbgrn.service
Uninstallation script for Cybozu products:	/var/www/cgi-bin/cbgrn/uninstall_cbgrn
Installation script for MySQL:	/etc/systemd/system/cyde_5_0.service
Uninstallation script for MySQL:	/usr/local/cybozu/mysql-5.0/uninstall_cyde_5_0

Are you sure you want to install the product with the above settings? Are you sure?
[yes or no]:

The installation process may take a few moments. Afterwards, confirm that the installation is complete.

Installing MySQL...
[Thu Sep 21 18:08:52 JST 2023] mysql: [Warning] Using a password on the command line interface can be insecure.
[Thu Sep 21 18:08:55 JST 2023] mysql: [Warning] Using a password on the command line interface can be insecure.
Installing CGI...
installing DB Script....
Installing Cybozu Scheduling Service...
Created symlink /etc/systemd/system/multi-user.target.wants/cyss_cbgrn.service → /etc/systemd/system/cyss_cbgrn.service.
Created symlink /etc/systemd/system/graphical.target.wants/cyss_cbgrn.service → /etc/systemd/system/cyss_cbgrn.service.
Installing Web files...
Copying license files...
Installing uninstall scripts...
DataBase Initialization...
done.

The installation has completed successfully.
Start a web browser and access the URL below:

http://(FQDN or IP address of the server)/(virtual path to the CGI directory)/cbgrn/grn.cgi

Example) http://webserver.cybozu.co.jp/cgi-bin/cbgrn/grn.cgi
Example) http://10.10.203.55/cgi-bin/cbgrn/grn.cgi

The message below may appear during the installation process, but the installation is completed successfully. No action required.
Warning: Using a password on the command line interface can be insecure.

Configure the initial settings of Garoon.
For details, refer to Post-Installation Tasks.

Note

Garoon has been initialized during its installation process, so you do not need to initialize Garoon before you start using it.
After you start using Garoon, you can initialize Garoon if you want to delete data that you entered for trial use. For details on the initialization, refer to Initializing Garoon in the Linux Environment.
If you access the Garoon URL but the screen is not displayed properly, check the following points:
- The Run As user of the Web server ("apache" in the example above) has the Read permission on the document root directory of the Web server.
- The Web server has virtual directories configured properly.
  For details, refer to How to Create a Virtual Directory.
- SELinux is disabled.
- The firewall is configured correctly.
The installation logs for Garoon and MySQL are saved in the following directories:
- Installation log for Garoon: (directory where the installer was executed)/install.log
- Installation log for MySQL: (directory where the installer was executed)/install_cyde.log

Initializing Garoon in the Linux Environment

You can initialize Garoon when you want to delete sample data or data that you entered for trial use.
The initialization involves setting passwords for the Administrator of Garoon and the database user.

Steps:

Start a command-line console, and stop the scheduling service.
```
[root@garoon admin]# systemctl stop cyss_cbgrn.service
```

Move to the following directory:

(CGI directory)/(installation identifier)

Example:

cd /var/www/cgi-bin/cbgrn

Type the following command and press the Enter key:

Example:

./grn.cgi -C -q code/command/grn_initialize.csp db_admin_password='cybozu' db_user_password='cybozu' garoon_admin_password='cybozu' default_timezone='Asia/Tokyo' default_locale='ja' init_data='1'
  

Parameters:

db_admin_password	Specify the database administrator password.
db_user_password	Specify the database user password.
garoon_admin_password	Specify the Administrator password.
default_timezone	Specify the time zone information.
default_locale	This is a locale information. Select a language you use. ja: Japanese en: English zh: Chinese
init_data	Specify whether to install any data. 1: Installs standard data. 0: Installs no data. In the standard data, holidays, samples of workflow request form, and other information are registered.

Type 'y' and press the Enter key.
```
Do you really initialize Garoon? (y/[n]) :
```
To cancel the initialization, type 'n' and press the Enter key.
Confirm that the initialization is completed successfully.
```
Done in 18 minutes 18 seconds.
```

Start the scheduling service.

[root@garoon admin]# systemctl start cyss_cbgrn.service