DC 5.5 Installation/Upgrade

This section provides information on how to install Digizuite DAM Center.

Before upgrading

If you are installing a new DC skip this step. 

If you are upgrading from 5.3 or older to 5.5, then you must do this.

This app should be run to cleanup a table which is likely to have data errors. This is done as an app to avoid a potential long running SQL script as part of the DAM update process.

NB

You may need to update Dotnet manually if you are skipping many versions. This application is built using Dotnet 3

Ensure all queues in RabbitMQ are empty. We do not support upgrading with data left in RabbitMQ.

Running the app

Do a database backup first.

  1. Unzip the zip-file to a new folder.
  2. Edit appsettings.json and set the connectionstring to match that of the DC. It can be copy-pasted from the DC web.config.
  3. Open a command prompt in the folder made for the app. The only logging is done in prompt so this is the only way to see how it goes.
  4. Run CleanupAssetDigiupload.exe.

Questions

Why do I need to do this?

There is a table belonging to the core asset data which has data errors preventing normal load to memory cache which becomes a part of DC 5.4.

What happens with the asset data load if there are data errors?

The DC has a simple self-healing mechanism which will ensure normal operation when loading assets, however it will not fix all the errors.

Is this error found on any DC?

Yes. Significantly for any DC which has ever done any asset replace. The number of data errors scale linearly with the number of asset replaces.

Why is the error important to fix now if we always lived with it?

The load of asset data needs to be very quick and to achieve that we need a stricter control with the asset data structure.

Installing/Upgrading Digizuite

The Digizuie DAM Center is installed/Upgraded using Powershell. The package, provided by the Digizuite DAM Vendor, is a zip file with the following structure:


How to install/Upgrade

To install/upgrade the Digizuite DAM Center, do the following:

  1. Edit the Install.ps1 - See section 1.2 for a description of all the parameters
  2. Run the Install.ps1, as administrator, either from Powershell or the PowerShell ISE

Variables

All the parameters that need to be filled out, are described in the table below

Variable

Mandatory

Default value

Example /options

Description

NewInstallationTrue$True$FalseThis variable controls whether it is an update or a new installation (True = new installation, false = update)
PreStagedDatabasesTrue$False$TrueThis variable controls whether the installer should create the databases and user if it is a new installation. Set this to True only if the databases have been pre-stages, see section

Users





assetstreamUsernameTrue
assetstreamThis variable is for the username of the storage user. See /wiki/spaces/DD/pages/1322483793, section 2.1
assetstreamPasswordTrue
SuperSecretPasswordThis variable is for the password of the storage user.
digiadminUsernameTrue
digiadminThis variable is for the username of the administrative user.
digiadminPasswordTrue
SuperSecretPasswordThis variable is for the password of the administrative user
useActiveDirectoryTrue$False$TrueThis variable will setup the web site to require windows authentication. Do NOT set this to true on NewInstallations. Only use it on updates that are already set up for active directory.

Web





portTrue
443This is the port on which the web interface is installed in the IIS. Usually port 80 or 443
protocolTrue
httpsThe protocol used for the web interface installed in the IIS. Typically HTTP or HTTPS
siteUrlTrue
dam.company.comThe DNS for the web interface which is installed in the IIS
CorsAllowOriginsTrue@("$protocol://$siteurl")@("https://dam.company.com", "https://mm.company.com")A comma-separated list of allowed cors origins

Database





dbServerName

True
sqlserverThis is used for the SQL server name
dbUsernameTrue
sqluserThe user who has access to the database
dbPasswordTrue
SuperSecretPasswordThe password of the database user
collationTrueSQL_Latin1_General_CP1_CI_ASSQL_Latin1_General_CP1_CI_ASThe database collation
CompatabilityLevelTrue120130The compatibility level of the database. has to be either 120 or 130
dbNameTrue
company_damThe name of the database to be installed/updated. It has to be called _dam in the end.
DamdbPasswordFalse
SuperSecretPasswordPassword for database DAM database user. If blank it defaults to: 
admin_{#dbName}
DamRecoveryModelTrueSIMPLEFULLThis variable defines what the recovery model of the DAM database should be

Locations





localStoragePathTrueC:\StorageC:\StorageThe local storage path. This is only used if the storage is located on the webserver. Leave as "C:\Storage" if Azure storage is used
uncStoragePathFalse
\\server\storageThe UNC storage path. If on the webserver, the installer creates the share itself. If remote, then it has to exist.
SetStorageFilesystemRightsFalse$True$true $falseAllow disabling update of Storage FileSystemRights IF DISABLED RIGHTS MUST BE HANDLED MANUALLY
logRootTrue"C:\LogFiles\" + $siteUrlD:\logFile\dam.company.comThis is the path on which the log files are written to
servicesFolderTrueC:\Program Files\Digizuite\" + $siteUrlC:\Program Files\Digizuite\dam.company.comThis is the path on which all the binaries of the services are placed.
MonitoringServicesFolderTrueC:\Services\Digizuite
The folder to install different monitoring services in, such as Prometheus and Grafana
sitePathTrue"C:\Webs\" + $siteUrlD:\Webs\dam.company.com

This is the path on which the files for the web interface are placed.

Monitoring



MonitoringServicesFolderTrueC:\Services\Digizuite
The folder to install different monitoring services in, such as Prometheus and Grafana

LokiStorageFolder

True
$($MonitoringServicesFolder)\loki

The folder to install loki in. Logs are stored as part of this folder also.

LokiHostName

true
$env:ComputerName
10.0.0.5The hostname/ip-adress of the server that is hosting Loki. Usually it's the web server. If you have multiple web servers, you need to point to the same webserver on all machines.  

RabbitMQ





InstallRabbitMQTrue$True$True $FalseShould RabbitMQ be installed
RabbitMQHostTrue
dam.company.comThe hostname of the RabbitMQ Server
RabbitMQUsernameTrue
[aRabbitMqUsername]

Username for connecting to RabbitMQ Server 

Note: guest is not allowed anymore

RabbitMQPasswordTrue

Password for connecting to RabbitMQ Server
RabbitMQVirtualHostTrue

VHost on RabbitMQ, normally set to dam database name, excluding _dam
RabbitMQStorageTrue
C:\ProgramData\RabbitMQ

The location where RabbitMQ Database and logs are stored – only used when RabbitMQ is installed for the first time on the server!

RabbitMQPathTrue
C:\Program FilesParent folder, where the RabbitMQ Application is installed.
FirewallRemoteIpAddressesTrue
@("192.168.1.0/24","172.16.1.22")

Ip address or address ranges that are allowed for rabbitmq and erlang ports, these are needed as Batch machines needs access to RabbitMQ. if an empty array are used all ip addresses are allowed = @()

IPV4 and IPV6 is possible, ranges only with CIDR notation WIKI CIDR

Solr and SearchService





solrUrlTrue - if installSolr is True, else falsehttp://localhost:8983/solr/http://localhost:8983/solr/The URL which Solr should use
solrLocalPathTrue - if installSolr is True, else falseC:\Services\SolrServiceC:\Services\SolrServiceLocal path on which the Solr binaries are placed
solrUncPathTrue - if installSolr is True, else false$solrLocalPath\\server\Services\SolrServiceUnc path on which the Solr binaries are placed
ForceRepopulateAllSearchesTrue$false
True = all searches will be repopulated, false = only changed searches will be repopulated
SolRUsernameTrue - if installSolr is True, else false$digiadminUsername
The username used when connecting to Solr through an authenticated api. If you are not using authentication with Solr, then the value does not matter.

SolRPassword

True - if installSolr is True, else false$digiadminPassword
The password for solr if using authentication.

SMTP





smtpUsernameFalse
smtpuserThe username of the smtp user
smtpPasswordFalse
SuperSecretPasswordThe password of the smtp user
smtpFromEmailFalse
noreply@company.comThe e-mail which should be used to send from
smtpPortFalse587587The port used for the smtp server
smtpServerFalse
smtp.company.comThe smtp server

Licenses





licenseNameTrue
CompanyThe license holder name
licenseSerialNumberTrue
42The serial number of the license
licenseApplicationTrue
-The license for the main application
licenseAssetsTrue
-The license for the assets
licenseUsersTrue
-The license for the users
licenseMetadataTrue
-The license for metadata
licenseOfficeFalse
-The license for the office connector
licenseDamForSitecoreFalse
-The license for the Dam For Sitecore connector

Azure





azureStorageAccountBeFalse
BackendStorageCompanyThe storage account name of backend storage
azureAccessKeyBeFalse
-The access key for the backend storage
azureStorageAccountFeFalse
FrontendStorageCompanyThe storage account name of frontend storage
azureAccessKeyFeFalse
-The access key for the frontend storage

Install scenarios

As the same script is used for multiple purposes, this section describes different scenarios and what parameters to be especially aware of.

Installation

To install a new Digizuite DAM Center with UNC storage, the important parameters are the following

VariableValueDescription
NewInstallation$TrueThis has to be true on new installations, as otherwise databases won't be created
PrestagedDatabases$True/$FalseIf databases and users have not been pre-staged (created), then set this to $False, $True otherwise. This is for installing without sysadmin rights
Azure parameters
Leave them blank, if UNC storage is used

Upgrade

To upgrade Digizuite DAM Center, the following parameters are important

VariableValueDescription
NewInstallation$TrueThis has to be true on new installations, as otherwise databases won't be created
PrestagedDatabases$True/$FalseWhat happens if it is false, is the databases and the user mapping is checked and corrected (if wrong), but that requires sysadmin rights on the SQL server

Local UNC

To use a Local UNC (Local means it is located on the webserver), the following parameters are important:

VariableValueDescription
localStoragePathLocal storage path

Has to point to the local storage path (e.g. C:\Storage)

uncStoragePathUNC storage path

Has to point to the local share (\\Webserver\Storage)

External UNC

To use an external UNC (External means that storage is not located on the webserver), the following parameters are important

VariableValueDescription
localStoragePathC:\Storage

Leave it as: C:\Storage

uncStoragePathUNC storage path

Has to point to the external share (\\SomeExternalServer\Storage)

Azure storage (New install)

To use Azure storage, the following parameters are important

VariableValueDescription
localStoragePathLocal storage path

If provided, it configures up local storage, that can be enabled in the future

uncStoragePathUNC storage path

if provided, it configures a local unc share, that can be enabled in the future

azureStorageAccountBe

Has to be a Microsoft Azure storage account name

azureAccessKeyBe

Accesskey of the above

azureStorageAccountFe

Has to be another Microsoft Azure Storage account name

azureAccessKeyFe

Accesskey of the above

The reason there are two storage accounts is that frontend (used by satellite products, for instance, DAM For Sitecore) and backend (used by the administration web interface) storage is separated. 

Azure storage (Upgrade)

The same parameters as the new install are important, but the difference is, that the azure storage account and accesskeys have to correspond to what is already configured in the existing system.

Solr

In old versions of the Digizuite DAM Center, the installer handled the installation and set up of Solr. This is now taken out, enabling you to choose your own Solr provider.

The installer still configures some things for Solr though, which means that the installer still retains the parameter "installSolr".

"installSolr" no longer decides whether or not Solr should be installed. It now works together with the parameter "solrLocalPath", where if "installSolr" is $True, a folder will be created during the installation in the place where "solrLocalPath" describes.

In short, the first time you perform an installation of the DC where you already have a Solr installed, you set both "installSolr" (to $True) and "solrLocalPath". A folder will now be generated in your Solr installation with all the necessary security settings configured for the relevant users. Additionally, the DC's web.config will get the Solr URL inserted.

VariableValueDescription
installSolr$True/$FalseIf $True, DC will create and set up rights to a folder in the Solr installation + The Solr URL will be set in the web.config file.

After having run through the installer (or updated with the installer) where "installSolr" has been set to $True, then performing an update where "installSolr" is $True again is redundant, as the folder and rights have already been created/set.

You can, of course, perform an installation where "installSolr" is $False, and then afterward perform an update where "installSolr" is $True.

Azure SQL

Info

The created databases in the Azure portal has to be postfixed with _dam  (i.e. YourCompanyName_dam) 

We refer to Microsoft's documentation on how to setup Azure SQL.

If Digizuite DAM Center is installed/upgraded with Azure SQL database, then the following parameters are important:

VariableValueDescription
dbServerNameYourAzureSQLServerThis should point to the Azure SQL Server name
dbUsernameYourAzureSQLServerUserNameThis should be the username set up on the Azure SQL server
DamdbPasswordSomeSuperSecretPasswordStandard Azure configuration enforces a password policy, so the password should follow these (i.e. default password is not strong enough)

Grafana

Once the installer has been run, it's extremely important that you go to {damurl}/grafana and login with admin/admin and pick a new password. Grafana is a well know system, so it's ripe for security problems if you don't login and change the password as soon as possible. This only needs to be done once per server, since the Grafana installation itself is server-wide, and not per site. 

Exclude Folders in Antivirus

To avoid problems with files being locked by AV some folders should be Excluded from RealTime Scanning

Edit and Run the powershell script ExcludePathsInAntiVirus.ps1 to perform this.

NOTE: If another antivirus is used these paths should be excluded via the management interface of the Antivirus.

VariableValueDescription
StorageArealocalStoragePathStorage Area eg. G:\Storage\
PrometeusAreaPrometeusDataFolderPrometeus Data Folder eg. G:\Services\prometheus-2.19.0.windows-amd64\data
SolrAreaSolrFoldersolr Folder - can be found via the AppSetting 'SolRUncPath' in web.config eg. C:\Bitnami\solr-8.3.1-1\apache-solr\server\solr
LogAreaLogRootLog Area eg. G:\LogFiles\dc.example.com
RabbitStorageRabbitMQ Data AreaRabbitData Area eg: RABBITMQ_BASE environment variable