Unattended installation
- Product Management
- Mr. Schmittberger
All yuuvis RAD setups can be run in unattended mode as described below.
BitRock Setups (Core-Service, Service-Manager, Rendition-Plus, Elasticsearch, Metrics-Manager)
The BitRock setups support command line execution. All parameters that can be set during the GUI mode can also be set on the command line - either directly or via an options-file. The list of all parameters and their default values for each setup can be retrieved by executing the setup.exe with the parameter “--help” on the command line. The output language corresponds to the language of the Windows installation. Currently german and english are supported. Other languages will fallback to the default = german.
With the core-service as an example the command using an options file (in the same directory) looks like this:
yuuvis_rad_core-service_setup_x.y.z.exe --mode unattended --optionfile install.options |
Example for the install.options
installDir=C:\core-service
serviceName=yuuvis_core-service
serviceDisplayName=yuuvis RAD Core-Service
dbType=PostgreSQL
dbServer=10.1.4.149
dbPort=5432
dbInstance=
dbName=yuuvisdb
dbUser=user
dbPassword=password
baseinit=1
dataDir=C:\core-service\DATA
dmsSidecarUrl=http://10.1.4.149:7301
systemuserapikey=0e4e1828-e3e2-41b2-bf51-7924b9985328
update=false
setupStartService=0 |
Description of the installation parameters
Option | Description |
|---|---|
installDir | Installation directory |
serviceName | Installierted technical service name (without blank) |
serviceDisplayName | Display name for the service |
dbType | Database-type, possible values : MSSQL or PostgreSQL |
dbServer | Database server (name or IP) |
dbPort | Database port, defaults: |
dbInstance | Databse instance name (optional) |
dbName | Database name |
dbUser | Database user |
dbPassword | Database password |
baseinit | Controls if database tables and base configuration is created or an existing database is used |
dataDir | Data directory (WORK/CACHE) |
dmsSidecarUrl | URL to the service-manager’s dms-sidecar service (http://localhost:7301) |
systemuserapikey | API-Key for the system user |
update | If 'false' a new fresh installation is performed. Otherwise the setup runs in update mode. |
setupStartService | If '1', the core-service will be started automatically after the setup finished. |
MSI Setups (Agent, Designer, Office Add-In, Outlook Add-In, Outlook Drag&Drop Add-in, Template Editor)
All MSI installers do not require any parameters other than the installation path. They can be called on the command line as described here:
https://learn.microsoft.com/en-us/windows/win32/msi/command-line-options
See here for (optional) parameters: https://help.optimal-systems.com/yuuvisRAD/v80/admin/en/administration/installation/home_installation.htm
As an example, the Designer can be installed by the following command:
|
|---|
Finreader
Download the below “setup.iss” file and and save it in the FineReader12 setup folder (where the setup.exe is).
Open the file with a text-editor and adapt the installation directory in line 17 (szDir=<path>) to your needs.
Run “setup.exe /w /s /a /f1 setup.iss” with the working dir being the FineReader12 setup folder. See https://docs.revenera.com/installshield21helplib/helplibrary/IHelpSetup_EXECmdLine.htm for a list of all parameters supported by the installshield setup.exe
Copy the License File to <FineReader12>\Bin and <FineReader12>\Bin64.
Add the Bin and Bin64 folders to the Windows PATH environment variable.
Putting it together
For an automatic, unattended installation the setups should be called one after another in some sort of script or programm. This can for example be a simple batch or powershell script or a Java or C# program. It is also possible to realize this with a Dockerfile, running everything in docker-containers. However there are some things to pay attention to:
The systemuserapikey parameter needs to be defined in the script and equally passed to the core-service and the service-manager. Otherwise the core-service will generate the key itself and you will have to get it out of the registry before being able to pass it to the service-manager.
After the elasticsearch installation the service needs to be started and the file <elastcisearch>\bin\elasticsearch-set-initial-passwords.bat needs to be executed to initialize the elasticsearch users passwords (especially that of the elastic user). The script will return the set passwords on stdout and write the file <elasticsearch>\config\built-in.usr which contains the passwords. For the installation of the service-manager the password of the elastic user is required and thus it needs to be parsed and passed by the script / program.
It is expected that there is a database ready to use - with a db_owner user and the corresponding settings correctly initialized (see the system requirements / installation guid). This needs to be taken care of (in the script / program) beforehand.