Configuration via the Web Console
- Shaun Morris
- Brad Hards
Accessing the Web Console
Open the web administration console.
- http://localhost:8181/system/console
- Enter Username and Password
The default username/password is admin/admin. To change this refer to the Hardening section.
Configuring DDF Platform Global Settings
Open the web administration console.
- http://localhost:8181/system/console
- Enter Username and Password
The default username/password is admin/admin. To change this refer to the Hardening section.
- Select the Configuration tab
- Select the Platform Global Configuration bundle
- Enter the DDF configuration values per the Configurable Properties table below.
- Select the "Save" Button
Configurable Properties
| Title | Property | Type | Description | Default Value | Required |
|---|---|---|---|---|---|
| Protocol | protocol | String | Default protocol that should be used to connect to this machine. | http | yes |
| Host | host | String | The host name or IP address of the machine that DDF is running on. Do not enter localhost. | yes | |
| Port | port | String | The port that DDF is running on. | yes | |
| Trust Store | trustStore | String | The trust store used for outgoing SSL connections. Path is relative to ddf.home. | etc/keystores/clientTruststore.jks | no |
| Trust Store Password | trustStorePassword | String | The password associated with the trust store. | changeit (encrypted) | no |
| Key Store | keyStore | String | The key store used for outgoing SSL connections. Path is relative to karaf.home. | etc/keystores/clientKeystore.jks | no |
| Key Store Password | keyStorePassword | String | The password associated with the key store. | changeit (encrypted) | no |
| Site Name | id | String | The site name for DDF | ddf.distribution | yes |
| Version | version | String | The version of DDF that is running. This value should not be changed from the factory default. | 2.2.1 | yes |
| Organization | organization | String | The organization responsible for this installation of DDF | Codice Foundation | yes |
Managing Features
DDF includes many components, packaged as features, that can be installed and/or uninstalled without restarting the system. Features are collections of OSGi bundles, configuration data, and/or other features. For more information on the features that come with DDF, including a list of the ones included, consult the DDF Included Features page in the Software Version Description Document (SVDD).
Transitive Dependencies
Features may have dependencies on other features and will auto-install them as needed.
Installing Features via the Web Console
Open the web administration console.
- http://localhost:8181/system/console
- Enter Username and Password
The default username/password is admin/admin. To change this refer to the Hardening section.
- Select the Features tab.
- Click on the 'Play' arrow under the Actions column for the feature that should be installed.
- Wait for the Status to change from Uninstalled to Installed
- Optional: Check Bundle Status
- Select the Bundles tab
- Scroll down to the associated bundles and verify they were installed with a status of Active
Uninstalling Features
Open the web administration console.
- http://localhost:8181/system/console
- Enter Username and Password
The default username/password is admin/admin. To change this refer to the Hardening section.
- Select the Features tab.
- Click on the 'Eject' icon under the Actions column for the feature that should be uninstalled.
- Wait for the Status to change from Installed to Uninstalled
- Optional: Check Bundle Status
- Select the Bundles tab
- Verify the absence of the associated bundle(s)
Adding Feature Repositories
Open the web administration console.
- http://localhost:8181/system/console
- Enter Username and Password
The default username/password is admin/admin. To change this refer to the Hardening section.
- Select the Features tab.
- Enter the URL to the feature repository (see below) to be added and click the Add URL button.
The new feature repository should be added to the list of Feature Repositories above where you entered the URL.
There are several ways a new feature repository can be discovered based on the URL entered.
The URL can contain the fully qualified path to the feature repository, e.g.,mvn:https://tools.codice.org/artifacts/content/groups/public/ddf-standard/2.2.0/xml/features. This URL can include the username and password credentials if necessary. e.g., mvn:https://user/password@tools.codice.org/artifacts/content/groups/public/ddf-standard/2.2.0/xml/features. Note that the password will be in clear text.
The URL can just be the mvn URL, e.g., mvn:ddf.features/ddf-standard/2.2/xml/features ddf-standard/2.2.0/xml/features and the feature repositories configured for DDF will be searched.
Repositories to be searched by DDF can be configured in one of several ways:
- By setting the
org.ops4j.pax.url.mvn.repositoriesproperty in the<DDF_INSTALL_DIR>/etc/org.ops4j.pax.url.mvn.cfgfile (most common) - or by setting the org.ops4j.pax.url.mvn.settings property in the
<DDF_INSTALL_DIR>/etc/org.ops4j.pax.url.mvn.cfgfile to the mavensettings.xmlfile that specifies the repository(ies) to be searched
Note that a settings.xml template file for this configuration is provided in<DDF_INSTALL_DIR>/etc/templates/settings.xml - or by having a maven
settings.xmlfile in the<USER_HOME_DIR>/.m2directory of the user running DDF that specifies the repository(ies) to be searched (this would be typical for a developer)
The simplest approach is to specify the fully qualified URL to the feature repository.
Known Issues
Blank Web ConsoleDDF uses Pax Web as part of its HTTP support. Modifying the Pax Web runtime configuration in the web console may cause the web console to freeze.
Solution
Use the configuration instructions according to the hardening instructions.
Additional Information
For more information on the Web Console see the following link: http://felix.apache.org/site/apache-felix-web-console.html