docs/pages/extension.mdx
2024-09-19 14:34:45 +05:00

156 lines
5 KiB
Text

---
title: 'Browser Extension'
---
# Browser Extension
The sudo-flix browser extension enhances streaming quality and makes it possible to scrape more sources.
# Disclaimer
The extension isn't currently available on official stores so **developer mode has to be enabled** to use the extension, we are working on getting the extension on the stores to make the process easier.
Select one of the following methods to install the extension. Ensure that you download the files compatible with your browser.
## Chromium-based Installation
These installation steps are for any chromium-based browsers such as Microsoft Edge, Google Chrome, Vivaldi, Brave, Arc or Opera.
### Loading a CRX file
<Steps>
<Steps.Step>
Download the CRX file [here](https://github.com/sussy-code/browser-ext/releases/download/1.2.0/1.2.0-mwext-CHROME.crx).
<Warning>
Sometimes your browser may block downloading or installing CRX file from outside the Chrome Web Store. If so, download the ZIP file instead.
</Warning>
</Steps.Step>
<Steps.Step>
Go to your extensions page by typing the corresponding URL into your browser from the table below.
| Browser | URL |
| :--------------- | :-------------------- |
| Microsoft Edge | `edge://extensions` |
| Google Chrome | `chrome://extensions` |
| Vivaldi | `vivaldi://extensions`|
| Opera | `opera://extensions` |
</Steps.Step>
<Steps.Step>
Enable `Developer mode` toggle.
</Steps.Step>
<Steps.Step>
Drag and drop the downloaded extension CRX file onto the Extensions page.
</Steps.Step>
<Steps.Step>
When prompted, click Add extension to install the extension.
</Steps.Step>
</Steps>
### Loading a ZIP file
<Steps>
<Steps.Step>
Download and **unpack** the ZIP file from [here](https://github.com/sussy-code/browser-ext/releases/download/1.2.0/1.2.0-mwext-CHROME.zip).
</Steps.Step>
<Steps.Step>
Go to your extensions page by typing the corresponding URL into your browser from the table below.
| Browser | URL |
| :--------------- | :-------------------- |
| Microsoft Edge | `edge://extensions` |
| Google Chrome | `chrome://extensions` |
| Vivaldi | `vivaldi://extensions`|
| Opera | `opera://extensions` |
</Steps.Step>
<Steps.Step>
Enable `Developer mode` toggle.
</Steps.Step>
<Steps.Step>
Click the `Load unpacked` button.
</Steps.Step>
<Steps.Step>
Select the extracted folder from the ZIP file from **Step 1**.
</Steps.Step>
</Steps>
## Firefox-based Installation (Desktop)
These installation steps are limited to [Firefox Extended Support Release (ESR)](https://www.mozilla.org/en-US/firefox/enterprise/), [Firefox Developer Edition and Nightly versions](https://www.mozilla.org/en-US/firefox/channel/desktop/) of Firefox
that will allow you to override the setting that enforces the extension signing requirement.
### Loading an XPI file
<Steps>
<Steps.Step>
Open your browser and type `about:config` into the address bar.
</Steps.Step>
<Steps.Step>
Click the `Accept the Risk and Continue` button.
</Steps.Step>
<Steps.Step>
Search for `xpinstall.signatures.required` and set it to `false` by clicking the toggle.
</Steps.Step>
<Steps.Step>
Download the XPI file from [here](https://github.com/sussy-code/browser-ext/releases/download/1.2.0/1.2.0-mwext-FIREFOX.xpi). It should automatically start the installation process.
</Steps.Step>
<Steps.Step>
When prompted, choose `Continue to Installation` and then `Add`.
</Steps.Step>
</Steps>
## Firefox-based Installation (Android)
These installation steps are limited to [**Firefox Nightly for Developers**](https://play.google.com/store/apps/details?id=org.mozilla.fenix)
that will allow you to override the setting that enforces the extension signing requirement.
### Loading an XPI file
<Steps>
<Steps.Step>
Download the XPI file from [here](https://github.com/sussy-code/browser-ext/releases/download/1.2.0/1.2.0-mwext-FIREFOX.xpi). It should automatically start the installation process.
</Steps.Step>
<Steps.Step>
Find and open your Firefox Nightly for Developers settings.
</Steps.Step>
<Steps.Step>
Scroll down to the bottom and open the `About Firefox Nightly` tab.
</Steps.Step>
<Steps.Step>
Tap the Firefox Nightly logo 5 times to enable `debug mode`.
</Steps.Step>
<Steps.Step>
Return to your browser and type `about:config` into the address bar.
</Steps.Step>
<Steps.Step>
Search for `xpinstall.signatures.required` and set it to `false` by clicking the toggle.
</Steps.Step>
<Steps.Step>
Return to your settings menu, find the `Install extension from file` tab under the Advanced category.
</Steps.Step>
<Steps.Step>
Choose the XPI file downloaded in the first step.
</Steps.Step>
<Steps.Step>
When prompted, choose `Continue to Installation` and then `Add`.
</Steps.Step>
</Steps>