Configuring your first project

Getting a WebPageTest API Key

As Falco relies on the WebPageTest REST API to run the audits, it is necessary to create a WebPageTest API Key.

To do so, head to WebPageTest’s Request API Key page, fill up the (really small) form by entering your email, name, company and website, and click the link on the the confirmation email you should have recieved upon sumbission.

This email contains your WebPageTest API Key that we will use in the next section.

Creating your first project

To create your first project, head to <your Falco instance URL>/admin/ and connect to the admin interface. Then click on the + Add button in the Projects section, and you should see the following form:

The form used to create a project

The form fields are as follow:

  • Name: the name of the project;
  • WPT API Key: the WebPageTest API key that you created earlier;
  • Pages: A page is a public (non-authenticated) URL to do a performance audit against. Pages have a name and an associated URL;
  • Scripts: A script is the code for a WebPageTest script, which can be used to test user journeys, or pages that are behind an authentication, or pages that do not have a proper URL. To know more about WebPageTest scripting, you can read “Recipes for Performance Testing Single Page Applications in WebPageTest” by @phacks (phacks is a maintainer of Falco).
  • Project Audit Parameters: A project audit parameter is a set of conditions under with the audits will be ran. You can configure the geographic situation, the browser, the device, and the network shape—and give this set of conditions a more concise, memorable name. The available configurations are updated daily from the ones available on the WebPageTest website.

Once you have created your project, you can lanch a manual audit from either:

  • The Django Admin interface, under Projects
  • The Falco interface, with the button Launch audits manually
Last updated on 10/24/2019 by Nicolas Goutay