Using the admin console, administrators can control many server configuration options via the Site Settings page.

  • Select (Admin) > Site > Admin Console.
  • Under Configuration, click Site Settings.


Set Site Administrators

  • Primary site administrator. Use this dropdown to select the primary site administrator. This user must have the Site Administrator role. This dropdown defaults to the first user assigned Site Administrator on the site. LabKey staff may contact this administrator to assist if the server is submitting exception reports or other information that indicates that there is a problem.

URL Settings

  • Base Server URL: Used to create links in emails sent by the system and also the root of Short URLs. The base URL should contain the protocol (http or https), hostname, and port if required. Examples: "" or ""
    • The webapp context path, if in use, should never be included here (i.e., not "").
  • Use "path first" urls (/home/project-begin.view): Use the URL pattern "path/controller-action", instead of the older "controller/path/action" version. Learn more in this topic: LabKey URLs.

Automatically Check for Updates and Report Usage Statistics

Check for updates to LabKey Server and report usage statistics to the LabKey team. Checking for updates helps ensure that you are running the most recent version of LabKey Server. Reporting anonymous usage statistics helps the LabKey team maintain and improve the features you are using. All data is transmitted securely over SSL.

For a complete list of usage statistics that are reported, see Usage/Exception Reporting.

Users of Premium Editions of LabKey Server have the option to turn off the reporting of usage statistics and update checks if desired, and see two options on this page:

  • OFF: Do not check for updates or report any usage data.
  • ON: Check for updates and report system information, usage data, and organization details.

View Usage Statistics

At any time, you can click the View button to display the information that would be reported. Note that this is for your information only and no data will be submitted to LabKey when you view this information locally.

Manually Report Usage Statistics

LabKey uses securely reported usage statistics to improve product features and service, but in some cases you may not want them reported automatically. Click Download to download a usage report that you can transmit to your Account Manager on your own schedule. LabKey can load these manually reported statistics and continue to help improve the product in ways that matter to you.

Automatically Report Exceptions

Reporting exceptions helps the LabKey team improve product quality. All data is transmitted securely over SSL.

There are three levels of exception reporting available. For a complete list of information reported at each level, see Usage/Exception Reporting.

  • Low level: Include anonymous system and exception information, including the stack trace, build number, server operating system, database name and version, JDBC driver and version, etc.
  • Medium level: All of the above, plus the exception message and URL that triggered it.
  • High level: All of the above, plus the user's email address. The user will be contacted only to ask for help in reproducing the bug, if necessary.
After selecting an exception reporting level, click the View button to display the information that would be reported for the given level (except for the actual stack trace). Note that this is for your information only and no data will be submitted to LabKey when you view this sample.

Reporting exceptions to the local server may help your local team improve product quality. Local reporting is always at the high level described above.

You can also Download the exception report and manually transmit it to your LabKey Account Manager to have your data included without enabling automated reporting.

Customize LabKey System Properties

Log memory usage frequency: If you are experiencing OutOfMemoryErrors with your installation, you can enable logging that will help the LabKey development team track down the problem. This will log the memory usage to <LABKEY_HOME>/logs/labkeyMemory.log. This setting is used for debugging, so it is typically disabled and set to 0.

Maximum file size, in bytes, to allow in database BLOBs: LabKey Server stores some file uploads as BLOBs in the database. These include attachments to wikis, issues, and messages. This setting establishes a maximum file upload size to be stored as a BLOB. Users are directed to upload larger files using other means, which are persisted in the file system itself.

The following options to load ExtJS v3 on each page are provided to support legacy applications which rely on Ext3 without explicitly declaring this dependency. The performance impact on LabKey Server may be substantial. Learn more here:

Require ExtJS v3.4.1 to be loaded on each page: Optional.

Require ExtJS v3.x based Client API be loaded on each page: Optional.

Configure Security

Require SSL connections: Specifies that users may connect to your LabKey site only via SSL (that is, via the https protocol). Learn more here:

SSL port: Specifies the port over which users can access your LabKey site over SSL. Set this value to correspond to the SSL port number you have specified in the file. Learn more here:

Configure API Keys

Allow API Keys: Enable to make API keys (i.e. tokens) available to logged in users for use in APIs. This enables client code to perform operations under a logged in user's identification without requiring passwords or other credentials to appear in said code. Learn more here: Expire API Keys: Configure how long-lived any API keys generated will be. Options include:
    • Never
    • 7 days
    • 30 days
    • 90 days
    • 365 days
Allow session keys: Enable to make available API keys which are attached only to the user's current logged-in session. Learn more here: Note: You can choose to independently enable either API Keys or Session Keys or enable both simultaneously.

Configure Pipeline Settings

Pipeline tools. A list of directories on the web server which contain the executables that are run for pipeline jobs. The list separator is ; (semicolon) or : (colon) on a Mac. It should include the directories where your TPP and X!Tandem files reside. The appropriate directory will entered automatically in this field the first time you run a schema upgrade and the web server finds it blank.

Ribbon Bar Message

Display Message: whether to display the message defined in Message HTML in a bar at the top of each page.

Message HTML: You can keep a recurring message defined here, such as for upgrade outages, and control whether it appears with the above checkbox. For example:

<b>Maintenance Notice: This server will be offline for an upgrade starting at 8:30pm Pacific Time. The site should be down for approximately one hour. Please save your work before this time. We apologize for any inconvenience.</b>

Put Web Site in Administrative Mode

Admin only mode: If checked, only site admins can log into this LabKey Server installation.

Message to users when site is in admin-only mode: Specifies the message that is displayed to users when this site is in admin-only mode. Wiki formatting is allowed in this message. For example:

This site is currently undergoing maintenance, and only site administrators can log in.

HTTP Security Settings


Controls whether or not a browser may render a server page in a <frame>, <iframe>, or <object>.

  • SAMEORIGIN - Pages may only be rendered in a frame when the frame is in the same domain.
  • Allow - Pages may be rendered in a frame in all circumstances.

Customize Navigation Options

Check the box if you want to Always include inaccessible parent folders in project menu when child folder is accessible.

Otherwise, i.e. when this box is unchecked, users who have access to a child folder but not the parent container(s) will not see that child folder on the project menu. In such a case, access would be by direct URL link only, such as from an outside source or from a wiki in another accessible project and folder tree.

This option is to provide support for security configurations where even the names and/or directory layout of parent containers should be obscured from a user granted access only to a specific subfolder.

Related Topics

Was this content helpful?

Log in or register an account to provide feedback

expand allcollapse all