Configure repositories and proxy settings for the installUtility command

The installUtility command can access the following repositories:

Both the installUtility command and the featureManager command use the same configuration properties file, repositories.properties. The proxy settings are shared, but the repository settings are used only by the installUtility command. To manage assets and complete repository-based installation, find, or uninstallation operations, use the installUtility command instead of the featureManager command.

Tip: We can download or install assets from a single local directory-based repository by specifying the repository on the --from option. No additional configuration in repositories.properties is required.


Procedure

  1. Ensure that we have access to the following hosts and ports:

    • public.dhe.ibm.com on port 443
    • asset-websphere.ibm.com on port 443

    The installUtility command supports only proxy servers with HTTP/HTTPS protocols.

  2. Optional: Output a configuration template for repositories.properties.

      installUtility viewSets

  3. Copy the template into a new properties file at...

      ${wlp.install.dir}/etc/repositories.properties

  4. Edit...

      ${wlp.install.dir}/etc/repositories.properties

  5. To disable access to the Liberty Repository:

      useDefaultRepository=false

    The Liberty Repository is enabled by default and is the last repository accessed installing or downloading assets.

  6. To define a repository, add a property as either...

    • repoName.url=url
    • repoName.url=file_path

    For example...

      dev-rep.url=http://dev.repo.ibm.com:9080/ma/v1
      local-rep2.url=file:///c:/IBM/localrepo2
      local-rep3.url=C:\IBM\localrepo3
      local-rep4.url=C:\IBM\localrepo4.zip

      dev-rep.url=http://dev.repo.ibm.com:9080/ma/v1
      local-rep2.url=file:///usr/IBM/localrepo2
      local-rep3.url=/usr/IBM/localrepo3
      local-rep4.url=/usr/IBM/localrepo4.zip

    The defined repositories are accessed in the order that they are specified in repositories.properties.

    Each repository name must be unique.

  7. If a repository requires a user name and password, set...

      dev-rep.user=myname
      dev-rep.userPassword={aes}AH5NLyd7DfGb12pK17Pw+

    If a user name and password are required and they are not set, we receive a prompt to provide them. For enhanced security, encode the password using the securityUtility encode action.

  8. If the system requires access to the Liberty Repository or an instance of the Liberty Asset Repository Service through a proxy server, set the proxyHost, proxyPort, proxyUser, and proxyPassword proxy properties.

    For example:

      proxyHost=my.proxy.server.ibm.com
      proxyPort=9080
      proxyUser=myname
      proxyPassword={aes}AH5NLyd7DfGb12pK17Pw+

    If we do not set the user name and password, we receive a prompt to provide them.

  9. Save the changes to repositories.properties.

  10. Review and validate the repository and proxy settings...

      installUtility viewSets

    To view detailed validation messages, use option --viewValidationMessages.

      installUtility viewSets

      installUtility Sets
      ----------------------------------------------------------------------
      Properties File: c:\wlp\etc\repositories.properties
      Default Assets Repository: IBM WebSphere Liberty Repository
      Use Default Repository: True

      Properties File Validation
      ----------------------------------------------------------------------
      Validation Results: The properties file successfully passed the validation.
      Configured Repositories
      ----------------------------------------------------------------------
      Name: dev-rep
      Location: http://dev.repo.ibm.com:9080/ma/v1
      User Name: myname
      Password: <Unspecified>

      Proxy Sets
      ----------------------------------------------------------------------
      Proxy Server: my.proxy.server.ibm.com
      Port: 9080
      User Name: myname
      Password: ********

  11. Test the repository connection...

      installUtility testConnection

    If we do not set the user name and password, we receive a prompt to provide them.

      installUtility testConnection
      Testing the connection to all configured repositories...
      This process might take several minutes to complete.

      Configured Repositories
      ----------------------------------------------------------------------
      Name: dev-rep
      Location: http://dev.repo.ibm.com:9080/ma/v1
      Status: Successfully connected to the configured repository.
      Name: IBM WebSphere Liberty Repository (Default Assets Repository)
      Status: Successfully connected to the configured repository.

    We can test all configured repositories in repositories.properties at once by running...

      installUtility testConnection

    ...with no repoName specified. The repository name for the Liberty Repository is default. To test the connection to the Liberty Repository...

      installUtility testConnection default


What to do next

We can use the installUtility command to search for assets and install or download them from the configured repositories.

See also: installUtility command