Add docs for Private Instances

README.md

@@ -29,6 +29,7 @@
 - 👥 Invite the whole team so that everyone (devs, ops, product, marketing…) is involved in performance
 - 🗺 Audit the performance of individual URLs or entire user journeys ([even on Single Page Apps!](https://css-tricks.com/recipes-for-performance-testing-single-page-applications-in-webpagetest/))
 - 📸 Easily access and compare WebPageTest results between audits
+- 🙈 Can be used with your own Private Instance of WebPageTest
 
 You can try a demo version by logging in to https://falco.theo.do with the credentials `demo / demodemo`.
 
@@ -40,6 +41,8 @@ You can deploy Falco on Heroku by clicking on the following button:
 
 You will need to provide your credit card details to Heroku, but you will be under the free tier by default. You can find more details on why they are needed and Heroku’s pricing policy [in the docs](https://getfal.co).
 
+After deployment, you can connect to Falco (and the admin interface at `/admin/`) with the credentials `admin` and `admin`: make sure to change your password after connecting!
+
 <details>
 <summary>Heroku Teams user? Click here to deploy Falco.</summary>
 <br />

docs/docs/wpt-private-instances/about-wpt-private-instances.md

@@ -0,0 +1,24 @@
+---
+id: about-wpt-private-instances
+title: About WebPageTest Private Instances
+sidebar_label: About WebPageTest Private Instances
+---
+
+WebPageTest is Open Source, meaning everyone can [access and modify its source code](https://github.com/WPO-Foundation/webpagetest)—meaning that it can be ran on one’s own infrastructure as well. 
+
+Although the public instance, hosted at https://webpagetest.org, is perfectly suitable for most use cases, sometimes it can be useful to host one’s own Private Instance of WebPageTest:
+
+- A Private Instance has no API rate limiting, meaning you can use the API to test more than 200 page views per day (the limit on the public instance);
+- WebPageTest audits results started through the API [will only be stored for 30 days](https://www.webpagetest.org/forums/showthread.php?tid=15759&pid=31710#pid31710) on the public instance, whereas you can store them indefinitely on your Private Instance;
+- As your organization will likely be the sole user of the Private Instance, queuing times will be greatly reduced;
+- A Private Instance can be hosted inside your own VPN, so that it will be able to access websites that are not accessible outside your network;
+- It helps alleviate the load on the public instance 🙂
+
+A few points to keep in mind if you’re planning to host your own Private Instance:
+
+- If you’re going to host it on AWS or GCP, it will cost you money. How much money will depend on your usage, as (at least on AWS) the WebPageTest test agents are spawned and killed automatically as you need them;
+- Private Instances do not allow testing on mobile devices.
+
+To deploy your own WebPageTest Instance, follow the [documentation](https://github.com/WPO-Foundation/webpagetest-docs/blob/master/user/Private%20Instances/README.md). If you have any trouble, you might want to ask for help on the [WebPageTest Forums](https://www.webpagetest.org/forums/) or on the [WebPerformance Slack community](https://webperformance.herokuapp.com/), in the `#webpagetest-instances` channel.
+
+Once your Private Instance is up and running, you can setup Falco to use it!

docs/docs/wpt-private-instances/setting-up-falco-for-private-instances.md

@@ -0,0 +1,20 @@
+---
+id: setting-up-falco-for-private-instances
+title: Setting up Falco for Private Instances
+sidebar_label: Setting up Falco for Private Instances
+---
+
+Falco can be configure to use your Private Instance of WebPageTest to run audits, instead of the public one. This can be set up on a Project basis, so that some of your projects can use your Private Instance and other can use the public one—you can even use several Private Instances should you need to.
+
+To configure a Private Instance on a project, [make sure you are a Project Admin](/docs/getting-started/managing-users), and click on the “Manage project settings” link in the left-hand menu on that Project’s page.
+
+There, you should be able to enter your Private Instance URL (without the trailing slash) and the associated API Key that you declared during the Private Instance setup. If you get an error at that point, please make sure that:
+
+- The URL is correct;
+- The API of the instance is correctly working (you can try to head to `<your-private-instance-url>/getLocations.php/getLocations.php?f=html`).
+
+In case you still encounter a problem, please [open an issue](https://github.com/theodo/falco/issues/new?template=bug.md) on the Falco repository!
+
+If everything went OK, you should see a green confirmation message. You can now head to the “Project environments” setting page and pick the environments you want to run the audits in. 
+
+Falco will now run your audits against your Private instance 🎉

docs/sidebars.js

@@ -21,5 +21,9 @@ module.exports = {
       'api-reference/api-docs',
       'api-reference/swagger-ui'
     ],
+    'WebPageTest Private Instances': [
+      'wpt-private-instances/about-wpt-private-instances',
+      'wpt-private-instances/setting-up-falco-for-private-instances'
+    ]
   },
 };