Install Pleasanter on AlmaLinux

Overview¶

This manual describes the procedure for building a Pleasanter operating environment in the following environment.

Notes¶

1. When installing ver1.4.6 or later, if you run CodeDefiner without specifying arguments, it will be set up with the language: English and the time zone: UTC, so please specify the language and time zone as necessary.
2. MySQL can be used from ver1.4.9.0 onwards. Pleasanter versions earlier than ver1.4.9.0 do not support MySQL.
3. If you want to separate the web server and DB server in MySQL, please refer to "Configure the Web Server and DB Server to Use MySQL Separately".
4. When configuring a separated web server and DB server setup in MySQL, please refer to "Configure MySQL to be used in a configuration where the web server and DB server" or "Configure the Web Server and DB Server to Use MySQL Separately".

Prerequisites¶

1. We will not describe how to set up the OS. We assume that the OS has been set up in advance.
2. For details on the operating environment and specifications, please check here.
   FAQ: I want to know the operating environment and recommended specifications
3. Decide in advance the user who will start Pleasanter. User who will launch Pleasanter in the procedure refers to this user.
4. This procedure explains the case where .NET is installed in /usr/local/bin. If you need multiple versions of .NET in the same environment and you want to install .NET in a different directory, change the directory specified in ExecStart when running CodeDefiner or creating a script for the Pleasanter service to match the installation destination.

Procedure¶

The construction procedure is as follows.
1. Set up .NET
1. Setting up the database:
Perform the following setup for either PostgresSQL or MySQL.
*The order in which the settings are implemented may not match the order shown below.
1. Install the DB
1. Set up a user with DB manager privileges
1. Set up DB log output
1. Turn the DB into a service and enabling automatic startup
1. Set up to allow external access to the D
1. Set up Pleasanter
1. Prepare the application
1. Configure the database
1. Run CodeDefiner
1. Check that Pleasanter is running
1. Create a script for the Pleasanter service
1. Register as a service and starting the service
1. Set up a reverse proxy (nginx)
1. Change SELinux settings
1. Install nginx
1. Set up the reverse proxy
1. Allow access to Http(80)
1. Check that Pleasanter is running

1. Set Up .NET¶

Run the following command to install .NET.

sudo wget https://dot.net/v1/dotnet-install.sh -O dotnet-install.sh
sudo chmod +x ./dotnet-install.sh
sudo dnf install libicu
sudo ./dotnet-install.sh -c 10.0 -i /usr/local/bin
dotnet --version

For details, please refer to the official page below Scripted install.
https://learn.microsoft.com/en-us/dotnet/core/install/linux-scripted-manual#scripted-install

There are cases where an error occurs regarding a specific file when executing the dotnet command. In that case, please refer to the following page.
https://learn.microsoft.com/en-us/dotnet/core/install/linux-package-mixup?pivots=os-linux-redhat

2. Set Up The Database¶

Refer to either "Set up PostgreSQL" or "Set up MySQL" below to set up the database.

1. Set Up PostgreSQL¶

The procedure for setting up PostgreSQL is as follows.

sudo dnf install -y https://download.postgresql.org/pub/repos/yum/reporpms/EL-9-x86_64/pgdg-redhat-repo-latest.noarch.rpm
sudo dnf install -y postgresql18-server postgresql18-contrib

sudo su - postgres -c '/usr/pgsql-18/bin/initdb -E UTF8 -A scram-sha-256 -W'

log_destination = 'stderr'
logging_collector = on
log_line_prefix = '[%t]%u %d %p[%l]'

sudo systemctl restart postgresql-18
sudo systemctl enable postgresql-18

# - Connection Settings -
listen_addresses = '*'  # what IP address(es) to listen on;
port = 5432             # (change requires restart)

# TYPE  DATABASE        USER            ADDRESS                 METHOD
host    all             all             192.168.1.0/24          scram-sha-256

sudo systemctl restart postgresql-18

2. Set Up MySQL¶

The procedure for setting up MySQL is as follows.

sudo dnf install -y https://dev.mysql.com/get/mysql84-community-release-el9-1.noarch.rpm
sudo dnf install mysql-community-server

systemctl status mysqld.service

○ mysqld.service - MySQL Server
     Loaded: loaded (/usr/lib/systemd/system/mysqld.service; enabled; preset: disabled)
     Active: inactive (dead)
       Docs: man:mysqld(8)
             http://dev.mysql.com/doc/refman/en/using-systemd.html

sudo systemctl start mysqld

sudo systemctl enable mysqld

[mysqld]
skip-grant-tables

sudo systemctl restart mysqld

mysql -u root

flush privileges;
alter user 'root'@'localhost' identified by '<new password for MySQL root account (*)>';

quit;

skip-grant-tables

sudo systemctl restart mysqld

mysql -u root -p<MySQL root account password without any spaces between -p>

quit;

[mysqld]
log-error=/var/log/mysqld.log

sudo systemctl restart mysqld

3. Set up Pleasanter¶

1. Prepare the application¶

1. Run the following command to create a "web" directory in the root directory ("/").

sudo mkdir /web

1. Download the latest version of Pleasanter from the download center.
   When installing Pleasanter version 1.4.23.3 or earlier, download the zip file for the desired version (e.g., Pleasanter_1.4.23.3.zip) from GitHub.

2. Extract the downloaded zip file and place the entire extracted "pleasanter" folder to "/web" on the server using a file transfer application such as WinSCP.

3. Execute the following command to change the owner of the Pleasanter directory to the user who will start Pleasanter.

sudo chown -R <User who will start Pleasanter> /web/pleasanter

2. Database Configuration¶

Set the database connection information in /web/pleasanter/Implem.Pleasanter/App_Data/Parameters/Rds.json. A setting e.g. is shown below. Please also refer to the Rds.json manual if necessary.
Set Parameter: Rds.json

E.g. Of Rds.json Settings When Using PostgreSQL¶

The following is an e.g. of Rds.json settings when using PostgreSQL.

{
    "Dbms": "PostgreSQL",
    "Provider": "Local",
    "SaConnectionString": "Server=localhost;Port=5432;Database=postgres;UID=postgres;PWD=<「PostgreSQLデータベースの初期化」で設定したパスワード>",
    "OwnerConnectionString": "Server=localhost;Port=5432;Database=#ServiceName#;UID=#ServiceName#_Owner;PWD=SetAdminsPWD",
    "UserConnectionString": "Server=localhost;Port=5432;Database=#ServiceName#;UID=#ServiceName#_User;PWD=SetUsersPWD",
    "SqlCommandTimeOut": 0,
    "MinimumTime": 3,
    "DeadlockRetryCount": 4,
    "DeadlockRetryInterval": 1000,
    "DisableIndexChangeDetection": true,
    "SysLogsSchemaVersion": 1
}

E.g. Of Rds.json Settings When Using MySQL¶

The following is an e.g. of Rds.json settings when using MySQL.

{
    "Dbms": "MySQL",
    "Provider": "Local",
    "SaConnectionString": "Server=localhost;Port=3306;Database=mysql;UID=root;PWD=<「MySQLユーザの設定」で設定したパスワード>",
    "OwnerConnectionString": "Server=localhost;Port=3306;Database=#ServiceName#;UID=#ServiceName#_Owner;PWD=Set_0_Admins_0_PWD",
    "UserConnectionString": "Server=localhost;Port=3306;Database=#ServiceName#;UID=#ServiceName#_User;PWD=Set_0_Users_0_PWD",
    "SqlCommandTimeOut": 0,
    "MinimumTime": 3,
    "DeadlockRetryCount": 4,
    "DeadlockRetryInterval": 1000,
    "DisableIndexChangeDetection": true,
    "SysLogsSchemaVersion": 1
    "MySqlConnectingHost": "%"
}

3. Run CodeDefiner¶

Execute the following command to run CodeDefiner with the user that will start Pleasanter as determined in advance.
This procedure explains the case where .NET is installed in /usr/local/bin. If you need to install .NET in a different directory due to requirements such as needing multiple versions of .NET in the same environment, please change the directory specified when running CodeDefiner to match the installation destination.
(*)The following command is executed only during the initial installation.

cd /web/pleasanter/Implem.CodeDefiner
sudo -u <user who will launch Pleasanter> /usr/local/bin/dotnet Implem.CodeDefiner.dll _rds /l "<Language>" /z "<Timezone>"

(*1) For language and timezone, please refer to the following manual page.
FAQ: I want to know the supported languages and timezone parameter setting values in Pleasanter

If you are using it in a English environment, use the following command.

cd /web/pleasanter/Implem.CodeDefiner
sudo -u <User who starts Pleasanter> /usr/local/bin/dotnet Implem.CodeDefiner.dll _rds /l "en" /z "UTC"

If the message "Type 'y' (yes) if the license is correct, otherwise type 'n' (no)." appears, enter y.

4. Check that Pleasanter is running¶

1. Run the following command to start Pleasanter with a predefined user.

cd /web/pleasanter/Implem.Pleasanter
sudo -u <User who will start Pleasanter> /usr/local/bin/dotnet Implem.Pleasanter.dll

1. While Pleasanter is running, run the following command in another terminal to check that Pleasanter is running. Exit with "Ctrl+C".
2. Execution command

curl -v http://localhost:5000/

• Execution result

*   Trying ::1:5000...
* Connected to localhost (::1) port 5000 (#0)
> GET / HTTP/1.1
> Host: localhost:5000
> User-Agent: curl/7.76.1
> Accept: */*
>
* Mark bundle as not supporting multiuse
< HTTP/1.1 302 Found
< Content-Length: 0
< Date: Tue, 25 Jul 2023 11:33:38 GMT
< Server: Kestrel
< Location: http://localhost:5000/users/login?ReturnUrl=%2F
< X-Frame-Options: SAMEORIGIN
< X-XSS-Protection: 1; mode=block
< X-Content-Type-Options: nosniff
<
* Connection #0 to host localhost left intact

5. Create A Script For The Pleasanter Service¶

Create /etc/systemd/system/pleasanter.service with the following content. For User below, specify the user who will start Pleasanter.
In this procedure, .NET is installed in /usr/local/bin. If you need to install .NET in a different directory, such as when multiple versions of .NET are required in the same environment, modify the directory specified in ExecStart to match the installation location.

[Unit]
Description = Pleasanter
Documentation =
Wants=network.target
After=network.target

[Service]
ExecStart = /usr/local/bin/dotnet Implem.Pleasanter.dll
WorkingDirectory = /web/pleasanter/Implem.Pleasanter
Restart = always
RestartSec = 10
KillSignal=SIGINT
SyslogIdentifier=dotnet-pleasanter
User = <User who starts Pleasanter>
Group = root
Environment=ASPNETCORE_ENVIRONMENT=Production
Environment=DOTNET_PRINT_TELEMETRY_MESSAGE=false

[Install]
WantedBy = multi-user.target

6. Register As A Service And Start The Service¶

Execute the following command to enable the Pleasanter service start and automatic service start.

sudo systemctl daemon-reload 
sudo systemctl enable pleasanter 
sudo systemctl start pleasanter 

4. Set Up A Reverse Proxy (nginx)¶

Set up the reverse proxy so that it can be accessed through Port 80, the same as a normal web server.

1. Change SELinux Settings¶

Execute the following command.

getenforce

a. If "Command 'getenforce' not found," "Permissive," or "Disabled" is displayed¶

Proceed to "2. Install nginx."

b. If "Enforcing" is displayed¶

Execute the following command.

sudo setsebool -P httpd_can_network_connect on

*Change the above Boolean value of SELinux will allow all network connections by scripts and modules on the server in question.

2. Install nginx¶

Execute the following command to install nginx.

sudo dnf install -y nginx
sudo systemctl enable nginx

3. Reverse Proxy Settings¶

1. Create /etc/nginx/conf.d/pleasanter.conf with the following contents. In the server_name line, specify the hostname or IP address of the server you want to access.

server {
    listen  80;
    server_name   192.168.1.100;
    client_max_body_size 100M;
    location / {
       proxy_pass         http://localhost:5000;
       proxy_http_version 1.1;
       proxy_set_header   Upgrade $http_upgrade;
       proxy_set_header   Connection keep-alive;
       proxy_set_header   Host $host;
       proxy_cache_bypass $http_upgrade;
       proxy_set_header   X-Forwarded-For $proxy_add_x_forwarded_for;
       proxy_set_header   X-Forwarded-Proto $scheme;
    }
}

sudo systemctl restart nginx

3. Permission To Access Http(80)¶

Execute the following command to set permission to access Http (port:80) to allow clients to access the web service.

sudo firewall-cmd --permanent --add-port=80/tcp
sudo firewall-cmd --reload

5. Check The Operation Of Pleasanter¶

1. After starting Pleasanter, enter "Login ID: Administrator" and "Initial password: pleasanter" on the Pleasanter login screen and click the "Login" button.
   

2. After logging in, you will be asked to change the password for the "Administrator" user, so enter a password of your option and click the "Change" button.
   

If The Redirection Is Not Correct¶

Check that the nginx settings are correct. The behavior may change depending on small differences such as the presence or absence of/in the description.

If The Pleasanter Screen Does Not Open¶

If the above steps have been completed without any errors, but a page such as "Welcome to nginx!" (not an error message) is displayed when accessed from a browser, the security settings of the browser may prevent you from transitioning to the Pleasanter login screen.

Please check the security settings of your browser.

Supported Versions¶

Related Information¶

FAQ: I want to install Pleasanter 1.3.43.0 or earlier in a Linux environment