Krugle Administration Guide v6

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:

  • SMTP
  • Logging
  • Maintenance
  • Backup and Restore
  • Email Notification
  • Display Settings
  • Authentication
  • Admin Accounts
  • Failed Projects

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 Backup saves all the information needed to recreate its state at any point in time. This information is captured in separate files. Backup files contain two types of information:

  • 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 backups 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 & Restore

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 restore Krugle Enterprise projects (and optionally configuration settings):

  • Sign in to the Krugle Administration Console.
  • Click the Configuration tab.
  • Click Backup / Restore in the left navigation area.
  • Click the "Choose File" button in the section "Manually Backup / Upload & Restore" section.
  • Select a previously downloaded backup 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 the "Upload & Restore" button". The list of projects will be restored from your uploaded backup file, and (optionally) the configuration settings will also be restored.

Restore / Download

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 Restore / Download 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.

Use Download to save a backup file onto your machine as protection against catastrophic failure of the server where Krugle Enterprise is running. To save 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 Restore / Download section, select the backup file to be downloaded from the drop down list.
  • Click the "Download" button.

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.

Display Settings

Display settings allow Krugle Enterprise administrators to control visual display elements within the Krugle Enterprise clients. The logo displayed on the main Krugle Enterprise browser page (logo size 155 x 45 pixels) can be specified in the Display Settings area. Settings also allow you to change content (with plain text or basic HTML markup) 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 Display Settings in the left navigation area.
  • Click the "Edit" button to modify any of these settings.
  • To modify the logo displayed in the upper left area of the Krugle Enterprise browser client, enter a full URL in the "Logo - Browser Client" field.
  • To update the information in the Internal Message Board, enter an inline XHTML fragment* in the "Internal Message Board content" field.
  • 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.


Note

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

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 can be customized to support LDAP and other authentication methods via the Krugle Authentication Service (KAS).

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 information in Krugle Enterprise:

  • Make sure that the KDAP KAS is deployed and configured on a server accessible by Krugle Enterprise.
  • Select Krugle Authentication Service (KAS) from the "Authentication method" menu.
  • Enter the URL to the KAS Connector
  • Enter Parameters that are required by your organization's LDAP structure.
  • To verify and then save any changes, enter a test Username/Password and click Save.

To learn more about KAS, please contact Krugle Enterprise Support.


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 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 username and Email address for any users that you want to add as administrators, then click "Add".

Note

When Krugle Enterprise is initially configured, a special Admin account named "Admin" is created. This account cannot be deleted. Additionally, only the "Admin" account 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" account 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".

Failed Projects

Normally Krugle Enterprise will skip any project which it has been unable to crawl, until an admin user manually triggers a recrawl. This avoids repetitive errors being emailed to the admin and saved in the log files. If your SCM systems have regular issues that automatically resolve after time, you might want to change this setting to true, in which case Krugle Enterprise will continue to attempt recrawling projects which have failed in the past.

Admin Guide Menu