ExtraWebapp Resources

2024-05-16

Static site-specific content, such as custom splash pages, sitemap files, robots.txt etc. can be placed in an extraWebapp directory. This directory is "loaded last" when a server starts and resources placed here will not be overwritten during upgrade.

extraWebapp Directory

Static site-specific content, such as custom splash pages, sitemap files, etc. can be placed in an extraWebapp directory, alongside the labkeyWebapp and modules directories. This directory is located in <LABKEY_HOME> (the main LabKey deployment directory) on production servers. On a development machine, it is placed inside the <LK_ENLISTMENT>\build\deploy directory.

Files in this directory will not be deleted when your site is upgraded to a new version of LabKey Server.

Robots.txt and Sitemap Files

If your server allows public access, you may wish to customize how external search engines crawl and index your site. Usually this is done through robots.txt and sitemap files.

You can place robots.txt and sitemap files (or other site-specific, static content) into the extraWebapp directory.

Alternatives

For a resource like a site "splash page", another good option is to define your resource in a module. This method lets you version control changes and still deploy consistent versions without manual updates.

Learn more about module development here: Develop Modules

Related Topics