Externalizing configurations

Developer Portal can be configured on startup using the custom_wrapper.conf and the application_dev.yml configuration files. These files are used to manage and provision configurations from a centralized location. The externalized configuration can be specified either within a single file providing all the necessary configurations or multiple files for individual configurations.

External Developer Portal configurations

Data management settings

  • -Dportal.server.config.max-results. Specifies the maximum number of records that must be included in the backup file.

    When you create a backup, the system saves 1000 records of each core asset in the backup file by default. You can increase this limit If the number of records that you want to backup exceed 1000. Core assets include APIs, Packages, access tokens of APIs, Applications, Communities, Providers, Custom assets and asset types.

Ignite configurations

The following parameters are used to specify the nodes in a cluster:
  • -Dportal.server.cache.distributed.cluster.peers.0
  • -Dportal.server.cache.distributed.cluster.peers.1
  • -Dportal.server.cache.distributed.cluster.peers.2

Keystore configurations

The following parameters are used to specify Keystore configuration:
  • -Dserver.ssl.key-store. Location of the keystore file.
  • -Dserver.ssl.key-alias. Alias of the keystore file.
  • -Dserver.ssl.key-password. Key password of the keystore file.
  • -Dserver.ssl.key-store-password. Password of the keystore file.
  • -Dserver.ssl.key-store-type. Type of the key store. Accepted values are JKS and PKCS12. The default value is JKS.

HTTPS port configuration

The following parameters are used to specify HTTPS port configuration:
  • -Dserver.ssl.enabled. Enables or disables HTTPs port.
  • -Dportal.server.config.redirect-http-to-https. Redirects incoming requests to a HTTPS port.

Community based asset visibility configuration

The following parameter is used to specify asset visibility configuration:
  • -Dportal.server.config.user-search-community-restricted. Allows or restricts the consumers to view assets based on their communities.

API ratelimit configuration

The following parameters are used to specify API ratelimit configuration:
  • Dportal.server.config.enable-rate-limiting. Enables or disables rate limit for APIs.
  • Dportal.server.config.rate-per-minute. Specifies the number of invocations that you want to allow per minute for the given APIs.
  • Dportal.server.config.rate-limited-apis. Specifies the list of APIs, separated by commas, that you want to configure rate limit.

Configuring HTTP Port

portal.server.config.http-port: 8080. Specifies the HTTP port in which Developer Portal runs.

User or Application onboarding approval process

The following parameters are used to specify the setting related to user or application onboarding approval:
  • portal.server.config.external-approval-expiry. Specifies the number of days after which the external approval request expires. The default value provided for this setting is 15d.
  • portal.server.config.email-verification-expiry. Specifies the number of days after which the e-mail verification link expires. The default value provided for this setting is 2d.
  • portal.server.config.external-user-invitation-expiry. Specifies the number of days after which a sign-up invitation expires. The default value provided for this setting is 7d.
  • portal.server.config.enable-ldap-onboarding. Specifies whether the user onboarding approval flow is enabled for the LDAP users. The default value provided for this setting is false.

General configurations

The following parameters are:
  • portal.server.config.max-zip-size. Specifies the maximum size of the zip file that can be uploaded to Developer Portal. The default value provided for this setting is 209715200.

    The 200 in the default value indicates 200 MB.

  • portal.server.config.image-types. Specifies the types of image files supported in Developer Portal. For example, image/jpeg, image/png, image/gif, image/svg+xml.
  • portal.server.config.doc-types. Specifies the types of documents that are supported in Developer Portal. The default values provided in this setting are text/plain, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/pdf, application/rtf, application/json, application/zip, application/xml, text/yaml, text/x-yaml, application/x-yaml.
  • portal.server.config.encryption-key. Specifies the key using which application credentials will be decrypted. This is applicable for owned or shared users. The default value provided for this setting is yap-portAl$ .
  • portal.server.config.page-size. Specifies the page size that can be returned in a any single GET response. The default value provided for this setting is 12.
  • portal.server.config.headers.content-security-policy. Specifies the resources that can be allowed to load in the Developer Portal pages. For example, if you want to allow resources from okta.com to be loaded in Developer Portal, then provide the *.okta.com value for this setting.

    If you do not provide any value in this setting, no resources are allowed to load.

  • portal.server.intranet-enabled.create-api. Specifies whether users can create APIs using an intranet URL or not. The values applicable for the setting are:
    • true. Users can create APIs by providing an intranet URL.
    • false. Users cannot create APIs by providing an intranet URL.

Search configuration

The following parameters are used to specify search configurations:
  • portal.server.config.keyword-search.objects. Specifies the list of objects that can be searched in the header navigation. Only the objects specified in this list can be searched using the text box given in the UI header. The default values provided for this setting are API, PACKAGE, CUSTOM_ASSET.
  • portal.server.config.advanced-search.objects. Species the list of objects that can searched in the advanced search. The default values provided in this setting are API, COMPONENT, ENDPOINT, METHOD, ODATA_OPERATION, ODATA_STRUCTURE, PACKAGE, RESOURCE, RESTMETHOD, CUSTOM_ASSET.

Locale configuration

The following parameters are used to specify locale configuration settings:
  • portal.server.config.default-locale. Specifies the default language. The default value provided for this setting is en_US.
  • portal.server.config.supported-locales. Specifies the list of supported languages. The default values available for this setting are en_US, ar_SA, zh_CN, nl_NL, pl_PL, pt_PT,it_IT, ru_RU, ko_KR, es_ES, fr_FR,de_DE, ja_JP.

Logging configuration

The following parameters are used to specify settings to configure events logging in Developer Portal:
  • logging.pattern.file. Specifies the syntax of log entries saved in log files. The default value specified for this setting is 
    %d|[%thread]|[%X{tenant:-default}]| %-5level| %logger{36} - %msg%n
    Sample log entry saved in default format: 
    2024-03-16 17:39:11,265|[WrapperSimpleAppMain]|[default]| INFO | c.s.p.umc.inject.ServiceInitializer - Starting services...
  • logging.pattern.console. Specifies the syntax of console messages. The default value specified for this setting is 
    %d|[%thread]|[%X{tenant:-default}]| %-5level| %logger{36} - %msg%n
  • logging.file.name. Specifies the name of the log file that will be created during the start up of Developer Portal. The default value provided for this setting is dev-portal.log.
  • logging.logback.rollingpolicy.max-file-size:. Specifies the maximum size of log file. When a log file reaches the specified size, then the current log file is renamed and the further logs are saved in a new file. You can provide the format for renaming old log files using the logging.logback.rollingpolicy.file-name-pattern setting. The default value provided for this setting is 10 MB.
  • logging.logback.rollingpolicy.file-name-pattern. Specifies the syntax for renaming the log files that have reached the maximum size. The default value provided for this setting is dev-portal-%d{yyyy-MM-dd}.%i.log.

Community

The following parameters are used to specify settings related to the Developer Portal communities:
  • portal.server.config.communities.public-community-id. Specifies the Id for the public community. The default value specified for this setting is 3bdf8005-5685-3ef5-b132-de4681963fb6.
  • portal.server.config.communities.public-community-name. Specifies the name of the public community. The default value specified for this setting is Public Community .

License management configuration

The following parameter is used to configure the license file expiry:
  • portal.server.config.license-expiry-alert. Specifies the number of days before the license expiry that the expiry alert has to be displayed. The default value provided for this setting is 5.

Points to remember

Some point that you must remember when setting your configurations in dpo_wrapper.conf file.

  • The dpo_wrapper.config file is located in the InstallDir/profiles/CTP/ folder of your installation folder.
  • Format to provide the settings is as follows: 
    wrapper.java.additional.Settingincremental_number=Value of the setting
    The incremental number must be a positive integer that increments with each setting. You can specify numbers of your choice. As a recommended practice, find the biggest number in the configuration file and start incrementing the numbers for the next entries as and when you add them to the file. For example, if you see 2008 as the biggest value, then start assigning 2009, 2010 and so on to further entries.
    Sample 
    wrapper.java.additional.2013=-Dserver.ssl.enabled=false