Skip to content

README.md

Latest commit

 

History

History
80 lines (53 loc) · 2.45 KB

README.md

File metadata and controls

80 lines (53 loc) · 2.45 KB

Flagon UserALE Browser Extension

This package provides a browser extension for Flagon UserALE, enabling effortless, no-code instrumentation of websites. It captures user interactions and sends behavioral logs to a logging endpoint.

The extension is built with Plasmo and supports modern browser environments like Chrome and Firefox.

Features

✅ Passive user interaction logging
✅ No code changes required on instrumented pages
✅ Configurable via extension options (logging endpoint, user ID, tool metadata)
✅ Supports local development and custom deployments

Getting Started (Development)

  1. Install dependencies:
pnpm install
  1. Start the development build:
pnpm dev
  1. Load the extension in your browser:
    • Chrome: Visit chrome://extensions/, enable Developer Mode, click "Load unpacked", and select the build/chrome-mv3-dev/ directory.
    • Firefox: Visit about:debugging, "This Firefox", "Load Temporary Add-on", and select the manifest.json file in build/firefox-mv3-dev/.

Building for Production

To create a production build:

pnpm build

This outputs a zipped production bundle.

Extension Options

After installing the extension, click the icon in your browser toolbar to open the Options page. From here you can configure:

  • Logging Endpoint – Where logs will be sent
  • URL allowlist – A regex of URL's to allow logging on
  • OAuth Credentials – Details of an OAuth login to authenticate with the logging endpoint.

Resources