Installation Guide

1) Integrate our script tag on every page

<script src="https://example.app.baqend.com/v1/speedkit/install.js?d=production" async crossorigin="anonymous"></script>

Insert our script tag in the HEAD section of your HTML template. An integration via Tag Manager is also possible. Regardless of the scope, we recommend adding it to every page. This way, Speed Kit will always be installed and can start serving whenever needed. Note: For the staging deployment just change the “d” parameter from “production” to “staging”.

2) Upload our service worker in your root path

https://www.example.com/wrapper-sw.js
//wrapper-sw.js
importScripts(`https://example.app.baqend.com/v1/speedkit/sw.js${location.search}`);

If it is not possible to upload the Service Worker to the root scope, you can also add it to any other path (e.g. "/static/wrapper-sw.js") and serve it with the following HTTP header: Service-Worker-Allowed: "/"

3) Whitelist our server IP ranges

45.140.152.0/22
88.130.168.217

Our servers generate significantly more requests than regular users. In order to prevent your rate limiting and DDoS protection from stopping our requests, you have to whitelist our IP range (45.140.152.0/22). If your staging environments are protected via IP address, please whitelist our office IP range (88.130.168.217) as well.

4) Deploy Speed Kit on staging (optional)

In the first step, you can test Speed Kit in your staging environment. If you give us access, we are happy to support your team with extensive quality assurance.

5) Deploy Speed Kit on production

We start with a test group split of 0% on production to evaluate if your production system is any different than your staging environment. Speed Kit stays disabled for all users until the quality assurance process has been completed.

We highly recommend to use our Browser Extension for testing. It enables you to activate Speed Kit solely for your browser while other users remain unaffected. For other browser you can use our Bookmarklet.

Safeguards

You can disable Speed Kit for all users at any given time. Simply open the “Status” tab in your dashboard and click the “Disable Speed Kit” button. Whenever there is a problem (e.g. downtime) on our side, Speed Kit will automatically disable itself.

Rollout Timeline