Installation

This guide covers installing the TrueAssert browser plugin and setting up API keys for authentication.

Browser Plugin Installation

The TrueAssert browser plugin is a Chrome extension that allows you to record user interactions and create automated tests.

Method 1: Download from TrueAssert (Recommended)

  1. Navigate to Browser Plugin Page:

    • Log into your TrueAssert account

    • Go to Browser Plugin page or click "Browser Plugin" in the navigation menu

  2. Download the Plugin:

    • Click the download button to get browser_plugin.zip

    • The ZIP file contains the extension files

  3. Install in Chrome:

    • Open Chrome and navigate to chrome://extensions/

    • Enable "Developer mode" (toggle in the top right corner)

    • Click "Load unpacked"

    • Extract the ZIP file and select the extracted browser_plugin folder

    • The TrueAssert extension should now appear in your extensions list

Method 2: Development Installation

If you're working with the TrueAssert source code:

  1. Navigate to the browser_plugin directory in the repository

  2. Open Chrome and go to chrome://extensions/

  3. Enable "Developer mode"

  4. Click "Load unpacked" and select the browser_plugin directory

Creating an API Key

The browser plugin requires an API key to authenticate with your TrueAssert account.

Step 1: Navigate to Agents Page

  1. Log into your TrueAssert account

  2. Go to Agents page or click "Agents" in the navigation menu

  3. This page shows all your API keys and connected agents

Step 2: Create New API Key

  1. Click the "Create API Key" button

  2. A modal dialog will appear with:

    • Name field: Enter a descriptive name (e.g., "Browser Plugin", "Development")

    • Organization dropdown: Select which organization this API key belongs to

  3. Click "Create"

Step 3: Copy Your API Key

⚠️ Important: The API key is shown only once after creation. Copy it immediately!

  1. After creating the API key, a modal shows your new key

  2. The key format is: tp_[random_string] (e.g., tp_abc123xyz...)

  3. Click "Copy" to copy the key to your clipboard

  4. Store it securely - you'll need it to connect the browser plugin

API Key Details

  • Format: tp_ prefix followed by a secure random string

  • Scope: Organization-level (belongs to a specific organization)

  • Usage: Can be shared across multiple agents/browser plugins

  • Security: Keys are hashed in the database (SHA-256)

  • Revocation: You can revoke API keys from the Agents page

Connecting the Browser Plugin

Step 1: Open the Plugin

  1. Click the TrueAssert extension icon in your Chrome toolbar

  2. The plugin popup will open

Step 2: Enter API Key

  1. You'll see the "Connect to your account" screen

  2. Paste your API key into the "API Key" input field

  3. Click "Connect" or press Enter

Step 3: Verify Connection

  • If successful, the plugin will transition to the "Ready to Record" state

  • You'll see a large "Record" button

  • The plugin is now authenticated and ready to use

Troubleshooting Connection

"Invalid API Key" Error:

  • Verify you copied the complete API key (including the tp_ prefix)

  • Check that the API key hasn't been revoked

  • Ensure you're using the correct API key for your organization

"Connection Failed" Error:

  • Check your internet connection

  • Verify the server URL is correct (check plugin settings)

  • For local development, ensure the server is running on the correct port

Plugin Settings

Server Host Configuration

If you're using a custom server or local development:

  1. Click the Settings icon (gear) in the plugin

  2. Enter your server host URL:

  3. Click "Save Settings"

The plugin stores the server host in chrome.storage.local for persistence.

What's Next?

After installing the plugin and connecting with an API key:

  1. Create Your First Test - Record your first automated test

  2. Browser Plugin Recording Guide - Learn advanced recording features

  3. Session Management - Set up authentication flows

Managing API Keys

Viewing API Keys

  • Go to Agents page to see all your API keys

  • Each key shows:

    • Name

    • Organization

    • Creation date

    • Number of connected agents

    • Active status

Revoking API Keys

  1. Go to Agents page

  2. Find the API key you want to revoke

  3. Click "Revoke"

  4. Confirm the action

  5. The key will be marked as inactive and can no longer be used

Note: Revoking an API key will disconnect all agents and browser plugins using that key.

Security Best Practices

  • Don't share API keys: Keep them private and secure

  • Use separate keys: Create different keys for different purposes (development, production, browser plugin)

  • Rotate keys regularly: Revoke old keys and create new ones periodically

  • Revoke unused keys: Remove keys that are no longer needed

Related Topics

← Back to Getting Started | Next: Core Concepts → | Create First Test →

PreviousAccount SetupNextCore Concepts

Last updated