Fix 2.4.2 upgrade notes formatting refs #19330
[arvados.git] / apps / workbench / README.textile
index e249b1338bb76a93a1c50330e66a8b9f97a93adb..18380ac3fe67be34a26175c24eb7eabaf26d6693 100644 (file)
@@ -1,3 +1,7 @@
+###. Copyright (C) The Arvados Authors. All rights reserved.
+....
+.... SPDX-License-Identifier: AGPL-3.0
+
 h1. Developing Workbench
 
 This document includes information to help developers who would like to contribute to Workbench.  If you just want to install it, please refer to our "Workbench installation guide":http://doc.arvados.org/install/install-workbench-app.html.
@@ -6,7 +10,13 @@ h2. Running tests
 
 The Workbench application includes a series of integration tests.  When you run these, it starts the API server in a test environment, with all of its fixtures loaded, then tests Workbench by starting that server and making requests against it.
 
-In addition to bundled gems, running the integration tests requires "PhantomJS":http://phantomjs.org/download.html to test JavaScript elements.  The simplest way to get started is to download one of the binary builds provided, and install the executable into one of the directories in your @$PATH@.
+In order for this to work, you must have Firefox installed (or Iceweasel, if you're running Debian), as well as the X Virtual Frame Buffer driver.
+
+<pre>
+$ sudo apt-get install iceweasel xvfb
+</pre>
+
+If you install the Workbench Bundle in deployment mode, you must also install the API server Bundle in deployment mode, and vice versa.  If your Bundle installs have mismatched modes, the integration tests will fail with "Gem not found" errors.
 
 h2. Writing tests