Skip to main content
Sign Out

Welcome to Dell

My Account
  • Place orders quickly and easily
  • View orders and track your shipping status
  • Enjoy members-only rewards and discounts
  • Create and access a list of your products
  • Manage your Dell EMC sites, products, and product-level contacts using Company Administration.
Sign In Create an Account Dell Financial Services Premier Sign In Partner Program Sign In
Contact Us

Your Dell.com Carts

Dell Trusted Device Installation and Administrator Guide v5.5

PDF

Use the Appsettings Generator

NOTE: Certificates that are used with the Appsettings Generator must be in PEM format.

The Appsettings Generator builds the required appsettings.json file and writes it to the Docker console. Optionally, you can configure the Appsettings Generator to create a PbkdfTenantApiKey for PBKDF2 password storage

The following table describes options that are used with the Appsettings Generator.

Table 1. Options
Option Description
--help This option displays help file in text format.
--certfile This option forces the Appsettings Generator to find certificate in a predefined location.

The following table describes the parameters that are used to create the appsettings.json file.

Table 2. Parameters
Parameter Required Description
/app/Dell.TrustedDevice.EventsRepository.AppSettingsGenerator.dll Yes This string invokes the Appsettings Generator in the Event Repository container.
dellemc/dtd-event-repository Yes This string defines the container image to use for this container.
NOTE: If a specific version of the Event Repository image is required, append this command with :<version number>. For example: dellemc/dtd-event-repository:1.0.2.0
Iterations No The number of iterations used to generate the TenantApiKey hash.
NOTE:
  • If the RandomFunction in use is HMACSHA256, then the iteration must be at least 310000.
  • If the RandomFunction in use is HMACSHA512, then the iteration must be at least 120000.
  • If the Appsettings Generator does not detect the above expected values in use, the PbkdfTenantApiKey element is not created.
MaxFileSizeMb No The maximum size to which a log file can grow. When a log file exceeds this amount, the file is closed and a new log file is created. The default value for this parameter is 15 Mb.
MaxActiveFileDays No The maximum amount of time, which is specified in days, for which a log file can be open. When the log file is open for longer than the time specified, it is closed, and a new log file is opened. The default for this parameter is one day.
MaxFileAge No The time log files persist in the output folder. Files older than this time period, which is specified in days, are deleted. The default for this parameter is three days.
Path Yes This parameter is the file path of the Kestrel certificate.
Password Yes This parameter is the password to the Kestrel certificate.
RandomFunction No The function used to hash the TenantApiKey.
NOTE:
  • The RandomFunction must use HMACSHA256 or HMACSHA512.
  • If the Appsettings Generator does not detect the above expected values in use, the PbkdfTenantApiKey element is not created.
Salt No The salt value used to hash the TenantApiKey.
NOTE:
  • The salt value must be a valid base64 string generated using a 16 byte array at minimum.
  • If the Appsettings Generator does not detect the above expected values in use, the PbkdfTenantApiKey element is not created.
TenantName Yes This parameter is the name of the tenant. This name is typically based on the company name or division. The TenantName should be unique in an organization.
TenantApiKey Yes The TenantApiKey is a string that represents a password that a computer must provide during registration.
TenantApiKeyHash No A hash value of the TenantApiKey.
NOTE:
  • The TenantApiKeyHash value must be a valid base64 string.
  • If the Appsettings Generator does not detect the above expected values in use, the PbkdfTenantApiKey element is not created.
TenantUUID No This parameter is the GUID of the Tenant. If a GUID is not provided, the Appsettings Generator creates one.
--tty=false No To write the appsettings.json file to a specific location, use this option.
HttpPort No This parameter is the Kestrel endpoint entity port.
IssuerPublicCertsPem No This parameter is the file path of the public certificate.
NOTE: This parameter is required only if the --certfile option is not in use.
IssuerPrivateKeyPem No This parameter is the file path of the private certificate.
NOTE: This parameter is required only if the --certfile option is not in use.
TrustedRootsPem No This parameter is the file path of the trusted roots certificate.
NOTE: This parameter is required only if the --certfile option is not in use.

Example commands

  • The following example displays the help file for the Appsettings Generator in the Command line window. docker run dellemc/dtd-event-repository /app/Dell.TrustedDevice.EventsRepository.AppSettingsGenerator.dll --help
  • The following example creates the appsettings.json file in C:\eventrepository using the --certfile option with example parameters. 
    docker run dellemc/dtd-event-repository /app/Dell.TrustedDevice.EventsRepository.AppSettingsGenerator.dll --certfile TenantName=ExampleTenant TenantApiKey=ExampleTenantKey Path="/app/certs/example.pem" password=ExamplePassword
  • The following example creates the appsettings.json file in C:\eventrepository without the --certfile option with example parameters. 
    docker run dellemc/dtd-event-repository /app/Dell.TrustedDevice.EventsRepository.AppSettingsGenerator.dll TenantName=ExampleTenant TenantApiKey=ExampleTenantKey IssuerPublicCertsPem="C\eventrepository\Certs\ExamplePublicCert.pem" IssuerPrivateCertsPem="C\eventrepository\Certs\ExamplePrivateCert.pem" TrustedRootsPem="C\eventrepository\Certs\ExampleTrustedRoot.pem" Path="/app/certs/example.pem" password=ExamplePassword
  • The following example creates the appsettings.json file in C:\eventrepository using the --certfile option with example parameters and adds a PbkdfTenantApiKey for PBKDF2 password storage. 
    docker run dellemc/dtd-event-repository /app/Dell.TrustedDevice.EventsRepository.AppSettingsGenerator.dll --certfile TenantName=ExampleTenant TenantApiKey=ExampleTenantKey TenantApiKeyHash="ExampleTenantApiHash" Salt="ExampleSalt" RandomFunction="ExmapleRandomFunction" Iterations=120000 Path="/app/certs/example.pem" password=ExamplePassword

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\