This topic is under construction for the 25.3 (March 2025) release. For the previous documentation of this feature, click here.
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.
Topics
Set Site Administrator
- 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: "https://www.example.org/" or "http://localhost.org:8080"
- The webapp context path, if in use, should never be included here (i.e., not "http://localhost.org:8080/labkey").
- 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 and report usage statistics to the LabKey team. Reported usage statistics are used to prioritize enhancements. Turn this on to ensure the features you use are maintained and improved over time. All data is transmitted securely over HTTPS. 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 either or both upgrade banners or reporting of usage statistics if desired:
- Off: Do not check for updates or report any usage data.
- On: Report system information, usage data, and organization details, and show messages when important upgrades are available.
- Report only: Report system information, usage data, and organization details, but do not show upgrade messages.
View Usage Statistics
At any time, you can click
View 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.
The
Usage Statistics page shows the usage statistics in JSON. Use the
JSON Path text entry box to narrow down the JSON to something more specific. It also renders a list of keys available in the current JSON blob, which lets you easily filter to metrics of interest. For example, if you are interested in the metrics we send about lists, such as specifically the listCount, you could enter, respectively:
modules.List
modules.List.listCount
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
Report exceptions to the LabKey team who will use this information to identify and fix product issues encountered on your deployment. All data is transmitted securely over HTTPS.
There are three levels of exception reporting available. For a complete list of information reported at each level, see
Usage/Exception Reporting.
- Off: Do not report exceptions.
- Low: 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: All of the above, plus the exception message and URL that triggered it.
- High: 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 at the interval (in minutes) you specify. This setting is typically disabled and set to 0 until needed.
Timeout for read-only HTTP requests, in seconds: After the timeout set here, resources like database connections and spawned processes will be killed to abort processing the request. Set to 0 to disable the timeout.
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, such as to the file system.
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:
Optional.
Require ExtJS v3.x based Client API be loaded on each page: Optional.
Configure Security
Require HTTPS connections: Specifies that users must connect to your LabKey site via SSL/TLS. Learn more here:
When this setting is in use, the server will send a "Strict-Transport-Security" header to prevent future attempts to connect via HTTP.
HTTPS port number: Specified in the application.properties file. The port over which users can access your LabKey site. Learn more here:
Configure API Keys
Let users create API Keys: Enable to make API keys (i.e. tokens) available to logged in users for use in APIs. API keys enable 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
- 180 days
- 365 days
Let users create session keys: Enable to make available session-specific API keys which are attached only to the user's current logged-in session. Learn more here:
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.
Ribbon Bar Message
Display Message: Check the box 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 administrators 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
X-Frame-Options: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.
Include a Server HTTP header in responses: When the box is checked, the HTTP header will include a line like the following. Uncheck to drop this line from the response.
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 with a direct link.
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
