If you need to take down your LabKey Server for maintainence or due to a serious database problem, you can configure the SiteDownServlet to notify users who try to access the site.

To enable the site down servlet, follow these steps:

  1. In the <labkey-home>/labkeywebapp/WEB-INF directory, locate and edit the web.xml file.
  2. Locate the <servlet-mapping> entry for the site down servlet, as shown below. To find it, search for the file for the string "SiteDownServlet".
  3. Remove the comments around the <servlet-mapping> entry to activate the site down servlet.
  4. Modify the message displayed to users if you wish.
  5. Restart Tomcat.

The relevant entries in the web.xml file appear as follows:

<servlet>
<servlet-name>SiteDownServlet</servlet-name>
<servlet-class>org.fhcrc.cpas.view.SiteDownServlet</servlet-class>
<init-param>
<param-name>message</param-name>
<param-value>
LabKey is currently down while we work on the server.
We will send email once the server is back up and available.
</param-value>
</init-param>
</servlet>

<!-- To display a nice error message in the case of a database error,
remove the comments around this servlet-mapping
and edit the message in in the init-param above.
<servlet-mapping>
<servlet-name>SiteDownServlet</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
-->

Discussion

previousnext
 
expand all collapse all