Installing Cyberbro Extension¶
Tip
This extension requires a running instance of Cyberbro. If you do not have Cyberbro installed, check this doc for instructions on how to set it up.
Get the extension with the stores¶
Info
If you are using a reverse proxy with Cyberbro, ensure that the CORS headers are properly set and that the certificated is trusted on you computer or verified.
Without the correct CORS configuration and certificates trust chain (pretty basic, but you can do hardening), the extension will not function correctly.
See the example with Caddy.
For localhost:5000 version of Cyberbro (e.g. on your machine with Docker), CORS is already enabled by default in Flask, so no additional configuration is needed.
Demo¶
Development¶
Prerequisites¶
- Google Chrome / Microsoft Edge / Firefox browser
- Git
Steps to Install on Chrome and Edge for development¶
-
Clone the Repository
git clone https://github.com/stanfrbd/cyberbro-chrome-extension.git cd cyberbro-chrome-extension
-
Load the Extension in Chrome
- Open Chrome and navigate to
chrome://extensions/
. - Enable "Developer mode" by toggling the switch in the top right corner.
- Click on "Load unpacked" and select the
cyberbro-chrome-extension
directory.
- Open Chrome and navigate to
-
Load the Extension in Edge
- Open Edge and navigate to
edge://extensions/
. - Enable "Developer mode" by toggling the switch in the bottom left corner.
- Click on "Load unpacked" and select the
cyberbro-chrome-extension
directory.
- Open Edge and navigate to
Steps to Install on Firefox for development¶
Dev mode:
- Clone the repository:
git clone https://github.com/stanfrbd/cyberbro-firefox-extension.git
- Navigate to the extension directory:
cd cyberbro-firefox-extension
- Open Firefox and go to
about:debugging
:- Click on "This Firefox" in the sidebar.
- Click on "Load Temporary Add-on..."
- Select the
manifest.json
file from the cloned repository.
The extension should now be installed in development mode and ready for testing.
Extension options¶
After installing the extension, you can configure it by clicking on the extension icon in the browser toolbar and selecting "Options".
The extension options include:
- Cyberbro URL: The URL of your Cyberbro instance (e.g. http://127.0.0.1:5000
- default). This URL is used to send requests to Cyberbro API.
- api-prefix (optional): The prefix for the Cyberbro API (e.g. /api
- default). This prefix is used to send requests to Cyberbro API.
- Selected engines: The list of engines that will be used to search for the selected text. You can enable or disable engines by checking or unchecking the checkboxes.
Note
The extension will not work if the Cyberbro instance is not running or the URL is incorrect. The engines will not work if the Cyberbro instance does not have the secrets file properly configured.
Usage¶
To use the extension, select some text on a webpage, right-click, and choose "Analyze with Cyberbro". The extension will send the selected text to Cyberbro, which will search for it using the enabled engines.
See the dedicated repo for Chrome and Edge See the dedicated repo for Firefox
Privacy¶
No information is sent somewhere else than your Cyberbro instance (the one you set in "Cyberbro URL" section).