Loading...
Krugle Enterprise Quickstart

Chapter 4 - Configuration Settings

When Krugle Enterprise is first installed, the setup wizard captures and automatically configures the essential information needed for operation of the Krugle Enterprise. You may want to change the basic settings that were made during this initial installation. The Configuration tab provides access to the settings and controls you need to configure management tools for Krugle Enterprise.


These tools enable those with Administration access to manage administration accounts, schedule automatic maintenance tasks, setup notification email lists, control access to Open Source code files, and more. The settings and controls include:

  • IP Settings
  • SMTP
  • Logging
  • Maintenance
  • Backup / Restore
  • Email Notification
  • License Settings
  • Display Settings (available only with Krugle Enterprise)
  • Authentication
  • DC Reports
  • Admin Accounts
  • Saved Search Settings
  • Capacity Settings (available only with Krugle Basic)
  • Upgrade
  • Reboot/Shutdown

IP Settings

IP Settings control the network address and access setting that will be used with Krugle Enterprise on your organization's network. To review and edit this information:

  • Sign in to the Krugle Administration Console.
  • Click the Configuration tab.
  • Click IP Settings in the left navigation area.
  • To modify any of the information shown, click Edit. View and/or Modify.
    • IP address
    • Gateway
    • Subnet
    • DNS (Domain Name Server)
    • Host name
    • Domain name
    • HTTP proxy settings: host, port and any required credentials.
    • HTTPS settings.
    • Time server*: if blank, use defaults; otherwise, use specified alternative time server
  • Click Save or cancel when finished.

Note
By default, Krugle Enterprise keeps its internal clock synchronized via periodic Network Time Protocol (NTP) connection to public time servers. In the rare event that these time servers cannot be accessed (e.g. NTP port closed), Krugle Enterprise can instead use the rdate protocol to keep its clock synchronized with another machine running rdate.


SMTP

Krugle Enterprise sends operating warnings and notifications to the email addresses listed in the "Email Notification" section of the Configuration settings. Settings in the SMTP section identify the mail services used to send the email.

To review, edit and confirm this information:

  • Sign in to the Krugle Administration Console.
  • Click the Configuration tab.
  • Click SMTP in the left navigation area.
  • To modify any of the settings, click Edit. Edit the following values as desired:
  • SMTP host
  • SMTP port
  • SMTP username
  • SMTP password
  • HELO domain: optionally define the client domain to use when connecting to the SMTP server.
  • Use TLS: optionally use Transport Layer Security for SMTP.

Enter a test email address and click Save. This will send an email to the test email address. Check the specified email account to verify that you received the test email.

NOTE: If SMTP settings are not configured then Krugle Enterprise will be unable to send emails.


Logging

Logging settings affect the type and detail of information that is recorded in Krugle log files during operation of the Krugle Enterprise Appliance. Change the settings in this area only when directed by Krugle customer support. To view log files that have been created by Krugle Enterprise, choose Log Files from the Status/Reports tab.


Maintenance

Krugle Enterprise performs a series of automatic "housekeeping" activities. These activities maintain good system performance and ensure users are able to access the most current information available.

To review and / or modify these settings:

  • Sign in to the Krugle Administration Console.
  • Click the Configuration tab.
  • Click Maintenance in the left navigation area.
  • To edit the current settings click the Edit button.
  • To modify the number of recent log files that will be saved, select an option from the drop down list.
  • To set the frequency of log file deletion, select an option from the drop down list.
  • Click Save to keep your changes.

Backup and Restore

Krugle Enterprise periodically saves all the information that Krugle Enterprise needs to recreate its state at any point in time. This information is captured in backup files. Back-up files consist of two elements:

  • Configuration information - includes all non-project information that is displayed in the Krugle Enterprise Administration Console.
  • Project definition information - the information specified in the Projects tab of the Krugle Enterprise Administration Console These backup files can fully restore Krugle Enterprise to the state it was in when the backup was created. Features in this section allow administrators to create manual back-ups and restore the system to the state associated with any backup files that have been saved.

Automatic Backup

By default, Krugle Enterprise automatically creates a backup file each day. Krugle Enterprise will also automatically manage a specified number of the most recent backup files.

If you wish to change the frequency of automatic backup or the number of backups saved:

  • Sign in to the Krugle Administration Console.
  • Click the Configuration tab.
  • Click Backup / Restore in the left navigation area.
  • Change the backup frequency, if desired.
  • Modify the maximum number of backup files to be saved.
  • Click the "Save" button.

Manual Backup / Upload

To create a manual backup of Krugle Enterprise in its current state:

  • Sign in to the Krugle Administration Console.
  • Click the Configuration tab.
  • Click Backup / Restore in the left navigation area.
  • Click the "Backup Now" button in the section "Manually Backup / Upload" section.
  • When the backup is completed, the backup file is added to the list of files in the Download/Restore area. You will receive a confirmation message that displays the filename of the backup file just created.

To upload a backup file (and add it to the list of Krugle Enterprise backup files):

  • Sign in to the Krugle Administration Console.
  • Click the Configuration tab.
  • Click Backup / Restore in the left navigation area.
  • Click the "Browse" button in the section "Manually Backup / Upload" section. Select a file.
  • Check "Replace configuration settings" ONLY if you want to replace current configuration settings with those from the selected backup file. Leaving this control unchecked will result in only project information being restored.
  • Click Upload.

Download / Restore

To restore Krugle Enterprise to a previous state from a backup file:

  • Sign in to the Krugle Administration Console.
  • Click the Configuration tab.
  • Click Backup / Restore option in the left navigation area.
  • In the Download / Restore section, select the backup file to be restored from the drop down list.
  • Click the "Restore" button.

If the backup file you want to restore to is not included in the list, follow the instructions for uploading in the previous section.


Email Notification

Krugle Enterprise sends email containing important Krugle Enterprise operating information to those listed in this section.

Note: Settings in the SMTP section identify the mail services that will be used for this email activity. You will not be able to access this Email Notification page unless SMTP settings have been configured.

To review and edit the list of email addresses that will be automatically sent Krugle Enterprise operating information:

  • Sign in to the Krugle Administration Console.
  • Click the Configuration tab.
  • Click Email Notification in the left navigation area.
  • Click the Add button to add a new email address to the list.
  • Click the Remove button to remove an existing address from the list.

License Settings

License settings allow Krugle Enterprise administrators to (i) filter Public code results served to users of Krugle Enterprise by OSI license type and (ii) monitor and analyze each Project for the presence of selected OSI license types (code monitoring reports for each project are available on the "Home" tab of the Krugle Enterprise client).

To view these license settings:

  • Sign in to the Krugle Administration Console.
  • Click the Configuration tab.
  • Click License Settings in the left navigation area.

To edit these license settings:

  • Click the Edit button at the bottom of the license list.
  • Check any boxes corresponding to individual licenses to be excluded from the Open Source code results delivered to your users through Krugle Enterprise; check the group heading checkbox to omit all licenses of a given type.
  • Change the monitoring status for any OSI license type by choosing a selection from the drop down list; the default value is "OK". Other choices include "Caution" and "Alert". When a Project contains one or more files with a caution or alert setting, the Home page Code License report in the Krugle browser client will provide a warning and direct access to the files with licenses that are not "OK". Click Save.

Display Settings

Display settings allow Krugle Enterprise administrators to control visual display elements within the Krugle Enterprise clients. The logos displayed on the main Krugle Enterprise browser page (logo size 155 x 45 pixels) and the Krugle Eclipse plug-in (logo size 80 x 20 pixels) can be specified in the Display Settings area. Settings also allow you to add your organization's name as a label prefix to the internal search tabs, or change content of the internal message board that is displayed in the Home tab.

To access and modify these settings:

  • Sign in to the Krugle Administration Console.
  • Click the Configuration tab.
  • Click Visual Settings in the left navigation area.
  • Click the "Edit" button to modify any of these settings.

Krugle Basic Note: Krugle Basic does not permit the customization of Display Settings; these options are not available to Krugle Basic users.

  • To modify logo displayed in the upper left area of the Krugle Enterprise browser client, enter a full URL in the "Logo - browser client" field.
  • To modify logo displayed in the upper left area of the Krugle Eclipse plug-in, enter a full URL in the "Logo - Eclipse client" field.
  • Customize the Internal search tab label by entering up to 12 characters in the "Internal Code and Projects search tab prefix" field.
  • To update the information in the Internal Message Board, enter an inline xhtml fragment* in the "Internal Message Board content" field.
  • To disable public channel queries, uncheck the "Display Krugle Public Channels" checkbox. This causes the public channel tabs to be hidden in the Krugle Search Environment.
  • Click Save to store and use your changes.

*NOTE: A valid inline xhtml fragment can include any of the xhtml elements inside of the tags.


Authentication

These settings specify the Authentication mechanism that can be used by Krugle Enterprise to authenticate users and control search access to your organization's files. Krugle Enterprise provides the option of using LDAP authentication, or can be customized to support other authentication methods.

To access and modify Authentication settings:

  • Sign in to the Krugle Administration Console.
  • Click the Configuration tab.
  • Click Authentication in the left navigation area.
  • Click the "Edit" button.

By default, User Authentication is disabled. This default setting will allow users to use Krugle Enterprise (through the browser or IDE client) without providing credentials.

To require that all users authenticate against your LDAP system before accessing infor-mation in Krugle Enterprise:

  • Click Edit. Select "LDAP" from "Authentication method". Enter the required LDAP settings:
    • LDAP host
    • LDAP port
    • LDAP user domain
    • LDAP group domain
    • Allow multiple OUs
    • Username format
    • Mail attribute name
    • Manager DN and password
    • Authentication type
    • SSL
  • To verify and then save any changes, enter a test Username/Password and click Save.

NOTE: The LDAP group domain is an optional field that defines the access control groups which can be used to specify group level access control for a Project (the Project level access control settings are explained in Chapter 3). All groups that are "children" underneath the specified group domain will be included.

NOTE: Multiple user domains can be specified for user authentication. To specify multiple user domains, enter a root level user domain in the LDAP User Domain field, and set the Allow multiple OUs field to true. This option will require that all users sign in with their fully qualified domain username (e.g. [user OU]\[username]").

As an alternative to LDAP authentication, Krugle Enterprise supports the Krugle Authentication Service (KAS), which allows integration with other authentication systems. To learn more about KAS, please contact Krugle, enterprise-support@krugle.com.


Admin Accounts

Admin Accounts have viewing and editing access to Krugle Enterprise system settings, project definitions and all reports and log files.

Admin accounts can be added in this section. To verify the identity of these users in your environment, Krugle Enterprise requires each Admin account to be based on valid user credentials in your organization's LDAP system or other authentication systems.

NOTE: this in turn requires that LDAP or KAS-based authentication be active - see the preceding section for more information about enabling authentication.

To add an Admin account:

  • Sign in to the Krugle Administration Console.
  • Click the Configuration tab.
  • Click Admin Accounts in the left navigation area.
  • Enter the LDAP or KAS username and Email address for any users that you want to add as administrators, then click the "Add" button.

NOTE: When Krugle Enterprise is initially configured, a special Admin account named "Admin" is created. This account cannot be deleted. Additionally, only the "Admin" ac-count can edit and delete other Admin accounts. To remove an account, click "Remove" corresponding to the account(s) you wish to remove. When signed in as the "Admin" ac-count you will also see an "Edit" button in the right column of the Admin Accounts list. You can then edit "Admin" account information by clicking "Edit".


These settings determine the amount (and location) of system disk storage allocated to individual users for storing saved searches and for saving search results generated by AutoSearch™ automatic searches. To view or modify resource allocations:

  • Sign in to the Krugle Administration Console.
  • Click the Configuration tab.
  • Click Saved Search in the left navigation area.
  • Click the Edit button to modify any settings.

To increase system resources available for operations not related to Saved Search or AutoSearch™ you can decrease the values of the following settings:

  • Search result count
  • Number of saved searches per user
  • Number of AutoSearch™ automated searches per user
  • Number of saved search cycles for AutoSearch™ searches

To make AutoSearch™ results sent via email notification, you need to modify the "Report download address". This value should be a domain/ip address which you use to access KSE (Krgule Search Environment, the Krugle client).


NOTE: AutoSearch™ requested start time and search frequency settings can be adjusted by individual users to limit the level and timing of system processing. In general, users should be encouraged to set AutoSearch™ query times to correspond to levels of low system usage (e.g. late evenings, weekend day, etc.).

Capacity Settings

Krugle Basic customers may purchase an increase in the capacity of their Krugle Basic instance by contacting support@aragoncg.com. Customers will then receive an upgrade file.

Note that this option is only visible to Krugle Basic users. Krugle Enterprise capacity is limited only by disk size.

To upgrade, simply select the "Update" button and then upload the upgrade file by follow-ing the prompts. The capacity change will be immediately reflected on the Capacity Set-tings page and on the main Status page.


Upgrade

Krugle Enterprise software upgrades will be available periodically. These upgrades will not be automatically applied to your current version of Krugle Enterprise. A Krugle Enterprise administrator will need to sign in to the Krugle Enterprise Administration Console and manually install each upgrade.

To check for - and as appropriate, install - upgrades to Krugle Enterprise:

  • Sign in to the Krugle Administration Console.
  • Click the Configuration tab.
  • Click Upgrade in the left navigation area.
  • Click the Check for Upgrades button.

Available upgrades to your current version of Krugle Enterprise will be noted. At your discretion, you will be able to update to the newer version.

NOTE: Krugle Enterprise requires an internet connection to Krugle in order to detect and process upgrades to your Krugle software. NOTE: When Krugle Enterprise software is updated, the Krugle Enterprise service will shut down and be unavailable on the network during the update process. It is recommended that (i) updating occur during light use periods and (ii) all users on the network be notified before starting the Update process that Krugle Enterprise will be unavailable until the Update has completed.

NOTE: After you confirm that you want to upgrade the Krugle Enterprise software, the Krugle Enterprise service will shutdown - and you will be automatically signed off Krugle Enterprise. The Administrator will be notified by Email when the update process is complete (if SMTP is enabled).


Reboot / Shutdown

If you are instructed by Krugle Technical Support to Reboot or Shutdown Krugle Enterprise:

  • Sign in to the Krugle Administration Console.
  • Click the Configuration tab.
  • Click Reboot in the left navigation area.
  • Click either the Reboot button or Shutdown button.

Request Form - Free Download of Krugle Basic

Fill out the form to download Krugle Basic V5.



Fields marked with * are required.


×