mirror of
https://github.com/p-stream/extension.git
synced 2026-01-11 12:00:48 +00:00
Update README with safety information
Added safety section to clarify extension usage and privacy.
This commit is contained in:
parent
555a260e10
commit
775a1dbea4
1 changed files with 8 additions and 8 deletions
16
README.md
16
README.md
|
|
@ -8,7 +8,7 @@ The extension is an optional "plugin" for P-Stream (and all movie-web forks) tha
|
|||
|
||||
In simple terms: it acts as a local proxy. Imagine it opens an invisible tab to extract (scrape) the stream from the desired website. The only difference is that the extension can send specific headers, cookies, and is locally based. Some sources have restrictions that block scrapers; the extension helps us bypass that, such as IP restrictions, where the stream needs to be loaded on the same IP that it was originally scraped from.
|
||||
|
||||
In more conplex terms: It uses the declarativeNetRequest API to connect to third party sites and fetch their html content. Because browsers have Cross Origin Resource Security (CORS) that protects sites from fetching content from other sites, a proxy is needed. This extension acts as a local proxy to bypass CORS and fetch the content.
|
||||
In more complex terms: It uses the declarativeNetRequest API to connect to third party sites and fetch their html content. Because browsers have Cross Origin Resource Security (CORS) that protects sites from fetching content from other sites, a proxy is needed. This extension acts as a local proxy to bypass CORS and fetch the content.
|
||||
|
||||
During the onboarding process (/onboarding) the user can select between 3 options:
|
||||
- Extension - This gives the user the most sources —sometimes with the best quality. (This extension)
|
||||
|
|
@ -19,6 +19,13 @@ During the onboarding process (/onboarding) the user can select between 3 option
|
|||
- This project (movie-web) is designed to be 100% self-hostable and is completely open-source. Hard coding a set list of sites that it asks for permission would prevent the extension from working on self-hosted sites. The user would need to edit the code to manually add their site to the permission list.
|
||||
- Because we scrape from many sites, it would be tedious to allow every site.
|
||||
|
||||
## Safety
|
||||
- It's **not required** to use P-Stream, it's entirely optional.
|
||||
- It doesn't track the user in any way or send data to any site besides the site you intend to use it with.
|
||||
- **All of the code is open-source and anyone can inspect it.**
|
||||
- The extension **must** be enabled on a per site basis, otherwise the connecting site cannot talk to the extension (using runtime.sendMessage).
|
||||
> Previously offical sites were hardcoded to automatically be enabled on, but due to concerns about how this could be abused, that has been removed. **We do not believe this was ever exploited.**
|
||||
|
||||
### Will this ever work with Safari?
|
||||
TL:DR: No, Apple's restrictions make it impossible currently.
|
||||
|
||||
|
|
@ -31,13 +38,6 @@ https://orionfeedback.org/d/8053-extensions-support-for-declarativenetrequest-re
|
|||
|
||||
These can both be fixed, and I’m surprised WebKit’s APIs are so under-baked but it is what it is.
|
||||
|
||||
## Safety
|
||||
- It's **not required** to use P-Stream, it's entirely optional.
|
||||
- It doesn't track the user in any way or send data to any site besides the site you intend to use it with.
|
||||
- **All of the code is open-source and anyone can inspect it.**
|
||||
- The extension **must** be enabled on a per site basis, otherwise the connecting site cannot talk to the extension (using runtime.sendMessage).
|
||||
> Previously offical sites were hardcoded to automatically be enabled on, but due to concerns about how this could be abused, that has been removed. **We do not believe this was ever exploited.**
|
||||
|
||||
## Running for development
|
||||
|
||||
We use pnpm with the latest version of NodeJS.
|
||||
|
|
|
|||
Loading…
Reference in a new issue