Skip to main content

Installation

We have made the installation as simple as possible to skip the headaches. It consists of three steps:

  1. Creating an API key
  2. Add a script tag to your site
  3. Optional, host a JS file.

1. Creating an API key​

When your organization has been created in our platform and you haven't received any sessions, a setup page will be accessible through the sidebar. There you can create and API key.

Otherwise, go into settings, scroll down, and find your domain. Options for managing your API keys will be visible there.

2. Adding our <script /> tag​

In your site's <head> add the following snippet:

<script
  async
  src="https://cdn.byteboost.io/v1beta/repo/inspector/main.js"
  data-byteboost-key="YOUR_API_KEY"
></script>

Replace "YOUR_API_KEY" with the one you created in the previous step.

3. Host a JS file.​

Optional

We utilize a Service Worker to give you additional information about all network requests. This step can be skipped and everything will still work as expected.

Create a javascript file in your project's file system so it can be accessed on https://www.youdomain.com/byteboost.js.

Then, populate it with:

importScripts("https://cdn.byteboost.io/v1beta/repo/inspector/byteboost.js")`;

That is it! You have now installed Byteboost on your site. If you have any questions or got stuck, feel free to reach out to us at [email protected] or chat with us on byteboost.io