From 8ef5afce0e789a5948070115857a37242caeb89a Mon Sep 17 00:00:00 2001 From: n1ghthouse <121154936+n1ghthouse@users.noreply.github.com> Date: Mon, 26 Aug 2024 13:51:08 +0500 Subject: [PATCH 1/4] Updates theme.config to name Browser extension to Browser Extension. Adds better formatted steps for Chromium and Firefox browsers in the extension page. --- pages/extension.mdx | 73 +++++++++++++++++++++++++++++++++++---------- theme.config.tsx | 2 +- 2 files changed, 59 insertions(+), 16 deletions(-) diff --git a/pages/extension.mdx b/pages/extension.mdx index c3c5882..90fc0ba 100644 --- a/pages/extension.mdx +++ b/pages/extension.mdx @@ -1,20 +1,27 @@ --- -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. -# Installation Guide -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. -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. +# Disclaimer +The extension isn't currently available on officialstores 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. -## Loading a CRX file +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. + +## 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 - 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). Sometimes your browser may block downloading or installing CRX file from outside the Chrome Web Store. If so, download the ZIP file instead. @@ -27,15 +34,16 @@ Select one of the following methods to install the extension. Ensure that you do | :--------------- | :-------------------- | | Microsoft Edge | `edge://extensions` | | Google Chrome | `chrome://extensions` | - | Mozilla Firefox | `about:addons` | + | Vivaldi | `vivaldi://extensions`| + | Opera | `opera://extensions` | - Enable `Developer mode`, watch [this video](https://www.youtube.com/watch?v=sZeUZjhOfgM&t=65s) if you have trouble. + Enable `Developer mode` toggle, watch [this video](https://www.youtube.com/watch?v=sZeUZjhOfgM&t=65s) if you have trouble. - 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. @@ -43,19 +51,25 @@ Select one of the following methods to install the extension. Ensure that you do -## Loading a ZIP file +### Loading a ZIP file - 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). - 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` | - Enable `Developer mode` toggle. + Enable `Developer mode` toggle, watch [this video](https://www.youtube.com/watch?v=sZeUZjhOfgM&t=65s) if you have trouble. @@ -63,6 +77,35 @@ Select one of the following methods to install the extension. Ensure that you do - Select the folder inside the unpacked ZIP file from step 1 + Select the folder inside the unpacked ZIP file from **Step 1**. + + + +## 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 + + + + Open your browser and type `about:config` into the address bar. + + + + Click the `Accept the Risk and Continue` button. + + + + Search for `xpinstall.signatures.required` and set it to `false` by clicking the toggle. + + + + 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. + + + + When prompted, choose `Continue to Installation` and then `Add`. diff --git a/theme.config.tsx b/theme.config.tsx index 9bfc2b8..7e7c13f 100644 --- a/theme.config.tsx +++ b/theme.config.tsx @@ -84,7 +84,7 @@ export default defineTheme({ ...starLinks, group("Global", [ 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' }), ]), group("Self-Hosting", [ From de9ed69cd4729e0c5ba15b8f85d4f9a533f82f09 Mon Sep 17 00:00:00 2001 From: n1ghthouse <121154936+n1ghthouse@users.noreply.github.com> Date: Mon, 26 Aug 2024 13:55:42 +0500 Subject: [PATCH 2/4] changes chromium zip folder step to refer to the extracted folder --- pages/extension.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/extension.mdx b/pages/extension.mdx index 90fc0ba..13917d2 100644 --- a/pages/extension.mdx +++ b/pages/extension.mdx @@ -77,7 +77,7 @@ These installation steps are for any chromium-based browsers such as Microsoft E - Select the folder inside the unpacked ZIP file from **Step 1**. + Select the extracted folder from ZIP file from **Step 1**. From c14c3b0399f2008e4b300852903e29afe2fc39fa Mon Sep 17 00:00:00 2001 From: n1ghthouse <121154936+n1ghthouse@users.noreply.github.com> Date: Mon, 26 Aug 2024 14:39:38 +0500 Subject: [PATCH 3/4] minor grammatical error fix --- pages/extension.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/extension.mdx b/pages/extension.mdx index 13917d2..7754f5e 100644 --- a/pages/extension.mdx +++ b/pages/extension.mdx @@ -77,7 +77,7 @@ These installation steps are for any chromium-based browsers such as Microsoft E - Select the extracted folder from ZIP file from **Step 1**. + Select the extracted folder from the ZIP file from **Step 1**. From bf18b92cd92836435c24da5a26b91252102a040a Mon Sep 17 00:00:00 2001 From: n1ghthouse <121154936+n1ghthouse@users.noreply.github.com> Date: Mon, 26 Aug 2024 17:39:10 +0500 Subject: [PATCH 4/4] grammatical error, removes developer mode vid link, removes additional warning for chrome based ext --- pages/extension.mdx | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/pages/extension.mdx b/pages/extension.mdx index 7754f5e..54fd3b9 100644 --- a/pages/extension.mdx +++ b/pages/extension.mdx @@ -7,12 +7,10 @@ title: '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 officialstores 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. +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. - ## Chromium-based Installation These installation steps are for any chromium-based browsers such as Microsoft Edge, Google Chrome, Vivaldi, Brave, Arc or Opera. @@ -39,7 +37,7 @@ These installation steps are for any chromium-based browsers such as Microsoft E - Enable `Developer mode` toggle, watch [this video](https://www.youtube.com/watch?v=sZeUZjhOfgM&t=65s) if you have trouble. + Enable `Developer mode` toggle. @@ -69,7 +67,7 @@ These installation steps are for any chromium-based browsers such as Microsoft E - Enable `Developer mode` toggle, watch [this video](https://www.youtube.com/watch?v=sZeUZjhOfgM&t=65s) if you have trouble. + Enable `Developer mode` toggle.