Merge pull request #6 from n1ghthouse/master

Updates browser extension documentation to be more clear and correct.
This commit is contained in:
TPN 2024-09-01 10:39:35 +05:30 committed by GitHub
commit 3c1444f2ea
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 56 additions and 15 deletions

View File

@ -1,20 +1,25 @@
--- ---
title: 'Browser extension' title: 'Browser Extension'
--- ---
# Browser extension # Browser Extension
The sudo-flix browser extension enhances streaming quality and makes it possible to scrape more sources. The sudo-flix browser extension enhances streaming quality and makes it possible to scrape more sources.
# Installation Guide # Disclaimer
For now the extension isn't availible on stores so developer mode has to be enabled to use the extenison, we are working on getting the extension on the stores to make the installation easier. 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. Please be aware that Google Chrome may block CRX files from sources outside the Chrome Web Store. If this occurs, consider an alternative installation method.
## Loading a CRX file 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>
<Steps.Step> <Steps.Step>
Download the CRX file [here](https://github.com/sussy-code/browser-ext/releases/tag/1.2.0). Download the CRX file [here](https://github.com/sussy-code/browser-ext/releases/download/1.2.0/1.2.0-mwext-CHROME.crx).
<Warning> <Warning>
Sometimes your browser may block downloading or installing CRX file from outside the Chrome Web Store. If so, download the ZIP file instead. Sometimes your browser may block downloading or installing CRX file from outside the Chrome Web Store. If so, download the ZIP file instead.
</Warning> </Warning>
@ -27,15 +32,16 @@ Select one of the following methods to install the extension. Ensure that you do
| :--------------- | :-------------------- | | :--------------- | :-------------------- |
| Microsoft Edge | `edge://extensions` | | Microsoft Edge | `edge://extensions` |
| Google Chrome | `chrome://extensions` | | Google Chrome | `chrome://extensions` |
| Mozilla Firefox | `about:addons` | | Vivaldi | `vivaldi://extensions`|
| Opera | `opera://extensions` |
</Steps.Step> </Steps.Step>
<Steps.Step> <Steps.Step>
Enable `Developer mode`, watch [this video](https://www.youtube.com/watch?v=sZeUZjhOfgM&t=65s) if you have trouble. Enable `Developer mode` toggle.
</Steps.Step> </Steps.Step>
<Steps.Step> <Steps.Step>
Drag and drop the downloaded extension CRX or XPI file into the Extensions page. Drag and drop the downloaded extension CRX file onto the Extensions page.
</Steps.Step> </Steps.Step>
<Steps.Step> <Steps.Step>
@ -43,15 +49,21 @@ Select one of the following methods to install the extension. Ensure that you do
</Steps.Step> </Steps.Step>
</Steps> </Steps>
## Loading a ZIP file ### Loading a ZIP file
<Steps> <Steps>
<Steps.Step> <Steps.Step>
Download and unpack the ZIP file from [here](https://github.com/sussy-code/browser-ext/releases/tag/1.2.0). 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>
<Steps.Step> <Steps.Step>
Head to your browser's extensions page (see table above). 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>
<Steps.Step> <Steps.Step>
@ -63,6 +75,35 @@ Select one of the following methods to install the extension. Ensure that you do
</Steps.Step> </Steps.Step>
<Steps.Step> <Steps.Step>
Select the folder inside the unpacked ZIP file from step 1 Select the extracted folder from the ZIP file from **Step 1**.
</Steps.Step>
</Steps>
## Firefox-based Installation
These installation steps are limited to **Firefox Extended Support Release (ESR), Firefox Developer Edition and Nightly versions** 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.Step>
</Steps> </Steps>

View File

@ -84,7 +84,7 @@ export default defineTheme({
...starLinks, ...starLinks,
group("Global", [ group("Global", [
link("Instances", "/instances", { icon: 'mdi:web' }), link("Instances", "/instances", { icon: 'mdi:web' }),
link("Browser extension", "/extension", { icon: 'mdi:extension' }), link("Browser Extension", "/extension", { icon: 'mdi:extension' }),
link("Support", "/support", { icon: 'mdi:help' }), link("Support", "/support", { icon: 'mdi:help' }),
]), ]),
group("Self-Hosting", [ group("Self-Hosting", [