Installation and configuration of parameter
Describes the process of installing ProSync Manager.
1. Installation parameter configuration
Open the install.cfg file in $PRSMGR_HOME
to set the parameter values required to install ProSync Manager.
Each parameter is separated by a newline, and only one equals sign (=) is entered between the parameter name and the value, with no spaces.
ROOT_ID=admin
ROOT_PW=admin
SERVER_IP=localhost
SERVER_PORT=8080
REPODB_IP=localhost
REPODB_PORT=13852
REPODB_USERNAME=repo_user
REPODB_PASSWORD=password
REPODB_DBNAME=prosyncmanager
REPODB_DOCKERNAME=prosyncmanager
# set at the same time when mounting the repodb volume
#REPODB_PATH=$PRSMGR_HOME/repodb/data
#REPODB_LOG_PATH=$PRSMGR_HOME/repodb/log
# for repoDB management
REPODB_SUPERUSER_NAME=prsmgr_superuser
REPODB_SUPERUSER_PASSWORD=prsmgr_password
# for repoDB shared buffers(B, kB, MB, GB, TB)
# 0 is the setting that makes it determined based on the value according to the system memory.
REPODB_SHARED_BUFFERS=0
# if you need, enable and type the path to jar
# JDBC_ORACLE=/path/to/ojdbc.jar
# Optional: if the Oracle database uses a character set not included in the JDBC driver, add orai18n jar (e.g., KO16MSWIN949)
# JDBC_ORACLE_I18N=/path/to/orai18n.jar
The following describes each parameter.
ROOT_ID
Root account ID of ProSync Manager
admin
ROOT_PW
Root account password of ProSync Manager
admin
SERVER_IP
Connection IP of ProSyncManager
localhost
SERVER_PORT
Connection port of ProSyncManager
8080
REPODB_IP
Connection IP of ProSync Manager repoDB
localhost
REPODB_PORT
Connection port of ProSync Manager repoDB
(Range: 0 - 65535)
13852
REPODB_USERNAME
User name of ProSync Manager repoDB
repo_user
REPODB_PASSWORD
REPODB_USERNAME's password of ProSync Manager repoDB
password
REPODB_DBNAME
DB name of ProSync Manager repoDB
(Range: 0 - 63Byte)
prosyncmanager
REPODB_DOCKERNAME
Docker container name of ProSync Manager repoDB
prosyncmanager
REPODB_PATH
Path where the ProSync Manager repoDB's data will be stored in. If not specified, it is stored in the default path managed by docker.
$PRSMGR_HOME/repodb/data
REPODB_LOG_PATH
Path where the ProSync Manager repoDB' logs are stored. If not specified, it is stored in the default path managed by docker.
$PRSMGR_HOME/repodb/log
REPODB_SUPERUSER_NAME
Superuser name of ProSync Manager repoDB
prsmgr_superuser
REPODB_SUPERUSER_PASSWORD
Superuser's password of ProSync Manager repoDB
prsmgr_passsword
REPODB_SHARED_BUFFERS
ProSync Manager repoDB uses shared_buffers as a percentage of total memory for optimization, so repoDB startup will fail if memory is insufficient. Therefore, this parameter allows the user to force its size, and if it is 0 (default), it is based on the system's calculation.(0, 128kB - ... )
0
JDBC_ORACLE
The path to the Oracle JDBC to be used by ProSync Manager, and should be set if Oracle is included in the ProSync configuration. In a typical environment with Oracle installed, it is located in $ORACLE_HOME/jdbc/lib/ojdbc.jar
.
null
JDBC_ORACLE_I18N
If the character set of the Oracle server is not included in the Oracle JDBC (e.g., KO16MSWIN949), the users must set the path to the jar file corresponding to i18n. In a typical environment where Oracle is installed, it is located in $ORACLE_HOME/jlib/orai18n.jar
.
null
2. Installation
After setting the parameters, execute the install.sh script to perform the installation.
The install.sh script can be executed as below.
. $PRSMGR_HOME/install.sh
The following describes the procedure for selecting options during installation.
want to clean previously deployed application?
This is the procedure that appears if a previously deployed application exists; enter y if the users want to remove the existing deployed application.
install repoDB?
This procedure asks if the users want to install a new REPO DB, enter y if the users want to install the existing REPO DB.
want remove container?
This is the procedure that appears if a docker container named 'prosyncmanager' already exists, enter y if the users want to remove the existing docker container.
start server?
The server installation is complete and asks if the users want to start the server, enter y if the users want to start the server.
Here's an example of the installation.
$ . $PRSMGR_HOME/install.sh
want to clean previously deployed application? (y/n): y
**********************************************************************
* clean webapps directory
**********************************************************************
clean webapps directory complete
install repoDB? (y/n): y
**********************************************************************
* install repoDB
**********************************************************************
there's container whose name is 'prosyncmanager'
want remove container (y/n): y
8288a8287696
8288a8287696
container whose name is 'prosyncmanager' removed
container prosyncmanager created
==============================DOCKER LOG==============================
...
repoDB created
...
============================DOCKER LOG END============================
repoDB restarted
**********************************************************************
* create meta tables
**********************************************************************
meta tables created
**********************************************************************
* create superuser
**********************************************************************
superuser created
**********************************************************************
* restart repoDB
**********************************************************************
repoDB started
**********************************************************************
* repoDB install finished
**********************************************************************
repoDB install complete
**********************************************************************
* Extract Tomcat
**********************************************************************
Applying SERVER_PORT to tomcat server.xml...
Copying WAR files to the webapps directory...
**********************************************************************
* Configure Tomcat
**********************************************************************
PRSMGR_HOME=/path/to/prsmgr_home
CATALINA_BASE=/path/to/prsmgr_home/apache-tomcat
CATALINA_HOME=/path/to/prsmgr_home/apache-tomcat
CATALINA_PID=/path/to/prsmgr_home/apache-tomcat/temp/tomcat.pid
start server? (y/n): y
Starting Tomcat...
Using CATALINA_BASE: /path/to/prsmgr_home/apache-tomcat
Using CATALINA_HOME: /path/to/prsmgr_home/apache-tomcat
Using CATALINA_TMPDIR: /path/to/prsmgr_home/apache-tomcat/temp
Using JRE_HOME: /usr/lib/jvm/jdk1.8.0_311
Using CLASSPATH: /path/to/prsmgr_home/apache-tomcat/conf:/path/to/prsmgr_home/apache-tomcat/lib/*:/path/to/prsmgr_home/apache-tomcat/bin/bootstrap.jar:/path/to/prsmgr_home/apache-tomcat/bin/tomcat-juli.jar
Using CATALINA_OPTS:
Using CATALINA_PID: /path/to/prsmgr_home/apache-tomcat/temp/tomcat.pid
Tomcat started.
prosyncmanager started
**********************************************************************
* Install Done.
* URL : http://localhost:8080/
* ID / PW : admin/admin
**********************************************************************
If an error occurs during installation, it prints the part or statement where the error occurred and the associated error message to a log file for debugging purposes and aborts the installation.
Details about the error can be found in the install.log file.
3. Installation check
Connect to the URL resolved at the bottom of the install log and verify that the users are prompted with a login, and that the users are logged in with the ID/PW the users set in install.cfg.
Last updated