libredirect/README.md

121 lines
5.1 KiB
Markdown
Raw Normal View History

2022-04-16 10:15:57 +02:00
<img src="./img/libredirect_full.svg" height="50"/>
2022-05-05 19:36:30 +02:00
A web extension that redirects YouTube, Twitter, Instagram... requests to alternative privacy friendly frontends and backends.
2022-01-28 15:04:53 +01:00
[![Matrix Badge](https://img.shields.io/matrix/libredirect:matrix.org?label=matrix%20chat)](https://matrix.to/#/#libredirect:matrix.org)
2022-05-11 17:59:47 +02:00
[![Firefox users Badge](https://img.shields.io/amo/users/libredirect?label=Firefox%20users)](https://addons.mozilla.org/firefox/addon/libredirect/)
2022-07-22 07:19:21 +02:00
[![LibrePay Badge](https://img.shields.io/liberapay/gives/libredirect?label=Liberapay)](https://liberapay.com/LibRedirect)
2022-05-11 17:59:47 +02:00
2022-04-16 09:53:17 +02:00
[![Firefox Add-on](./img/badge-amo.png)](https://addons.mozilla.org/firefox/addon/libredirect/)&nbsp;
2022-05-11 17:59:47 +02:00
<a href="./chromium.md">
<img src ="./img/badge-chromium.png" height=60 >
2022-05-11 17:59:47 +02:00
</a>
2022-04-16 09:53:17 +02:00
2022-04-15 18:46:57 +02:00
<img src ="./img/1.png" width=350>&nbsp;
<img src ="./img/2.png" width=350>&nbsp;
<img src ="./img/3.png" width=350>&nbsp;
<img src ="./img/4.png" width=350>&nbsp;
2022-10-21 11:39:38 +02:00
- Youtube => [Invidious](https://github.com/iv-org/invidious), [Piped](https://github.com/TeamPiped/Piped), [Piped-Material](https://github.com/mmjee/Piped-Material), [CloudTube](https://sr.ht/~cadence/tube/), [FreeTube](https://github.com/FreeTubeApp/FreeTube), [Yattee](https://github.com/yattee/yattee)
- Youtube Music => [Beatbump](https://github.com/snuffyDev/Beatbump), [Hyperpipe](https://codeberg.org/Hyperpipe/Hyperpipe)
- Twitter => [Nitter](https://github.com/zedeus/nitter)
- Instagram => [Bibliogram](https://sr.ht/~cadence/bibliogram/)
- TikTok => [ProxiTok](https://github.com/pablouser1/ProxiTok)
- Reddit => [Libreddit](https://github.com/spikecodes/libreddit#instances), [Teddit](https://codeberg.org/teddit/teddit#instances)
- Imgur => [Rimgo](https://codeberg.org/video-prize-ranch/rimgo)
- Wikipedia => [Wikiless](https://codeberg.org/orenom/wikiless)
- Medium => [Scribe](https://sr.ht/~edwardloveall/scribe/)
- Quora => [Quetre](https://github.com/zyachel/quetre)
- IMDb => [libremdb](https://github.com/zyachel/libremdb)
- PeerTube => [SimpleerTube](https://git.sr.ht/~metalune/simpleweb_peertube)
- LBRY/Odysee => [Librarian](https://codeberg.org/librarian/librarian), [LBRY Desktop](https://lbry.com/get)
- Search => [SearXNG](https://github.com/searxng/searxng), [SearX](https://searx.github.io/searx/), [Whoogle](https://benbusby.com/projects/whoogle-search/), [LibreX](https://github.com/hnhx/librex/)
- Translate => [SimplyTranslate](https://git.sr.ht/~metalune/simplytranslate_web), [LingvaTranslate](https://github.com/TheDavidDelta/lingva-translate), [LibreTranslate](https://github.com/LibreTranslate/LibreTranslate)
- Maps => [OpenStreetMap](https://www.openstreetmap.org/), [FacilMap](https://github.com/FacilMap/facilmap)
- Send Files => [Send](https://gitlab.com/timvisee/send)
2022-01-28 15:04:53 +01:00
2022-04-29 06:32:39 +02:00
**Note**: The Extension will be using random instances by default. You can modify this and add custom instances too.
2022-01-28 14:13:06 +01:00
2022-10-04 20:10:07 +02:00
# Please read the [FAQ](https://libredirect.codeberg.page/faq.html) if you have any questions!
2022-06-05 19:10:42 +02:00
2021-01-11 07:50:49 +01:00
## Donate
[![Liberapay](./img/liberapay.svg)](https://liberapay.com/LibRedirect)&nbsp;
[![Patreon](./img/patreon.svg)](https://patreon.com/LibRedirect)&nbsp;
2022-10-09 09:36:44 +02:00
[![Buy me a coffee](./img/bmc.svg)](https://www.buymeacoffee.com/libredirect)&nbsp;
<a href="https://opencollective.com/libredirect"><img src = ./img/Open-Collective.png width=17% height=17%></a>
2022-10-21 11:39:38 +02:00
- BTC: `bc1qrhue0frps6p2vkg978u9ayethnwprtmfug827q`
- BCH: `qqz5vfnrngk0tjy73q2688qzw4wnllnuzqfndflhl8`
- ETH: `0x896E5796Da76E49A400A9186E1c459CD2C64b4E8`
- XMR: `4AM5CVfaGsnEXQQjZSzJvaWufe7pT86ubcZPr83fCjb2Hn3iwcForTWFy2Z3ugXcufUwHaGcucfPMFgPXBFSYGFvNrmV5XR`
2022-05-08 12:34:13 +02:00
## Mirror Repos
2022-05-08 12:34:13 +02:00
[![Codeberg](https://raw.githubusercontent.com/ManeraKai/manerakai/main/icons/codeberg.svg)](https://codeberg.org/LibRedirect/libredirect)&nbsp;&nbsp;
2022-10-09 09:53:06 +02:00
[![GitHub](https://raw.githubusercontent.com/ManeraKai/manerakai/main/icons/github.svg)](https://github.com/libredirect/libredirect/)&nbsp;&nbsp;
2022-05-08 12:34:13 +02:00
2022-06-05 19:10:42 +02:00
## Translate
2022-06-05 19:10:42 +02:00
[![Weblate](./img/weblate.svg)](https://hosted.weblate.org/projects/libredirect/extension)
## Development
### Install Dependencies
[Node.js](https://nodejs.org/) latest LTS is recommended
2022-05-05 19:36:30 +02:00
```
npm update
npm install
```
To generate html that uses `config.json` (needed to develop/build the extention), run:
```
2022-09-28 21:18:32 +02:00
npm run ejs
```
Afterwards, you will need to run it if you modify `config.json` or any files ending with .ejs.
2022-09-28 21:18:32 +02:00
### Build the extention zip archive:
2022-05-05 19:36:30 +02:00
```
npm run build
```
2022-09-28 21:18:32 +02:00
### Run automated tests
2022-05-05 19:36:30 +02:00
```
npm run test
```
2019-09-20 12:45:58 +02:00
### Test in Firefox
2022-05-05 19:36:30 +02:00
```
npm run start
```
### Install temporarily
2022-10-21 11:39:38 +02:00
1. open `about:addons`
2. type in the address bar `about:debugging`
3. press `load temporarily addon`
2022-04-16 10:15:57 +02:00
### Install in Firefox ESR, Developer Edition, Nightly
2022-10-21 11:39:38 +02:00
1. open `about:config`
2. set `xpinstall.signatures.required` to `false`
3. open `about:addons`
4. click on the gear shaped `settings` button and select `Install Add-on From File...`
5. select `libredirect-VERSION.zip` from `web-ext-artifacts` folder
2022-04-16 10:15:57 +02:00
### Install in Chromium browsers
2022-10-21 11:39:38 +02:00
1. open `chrome://extensions`
2. enable `dev mode`
3. select `load unpacked extension`
4. select `src` folder
2022-03-28 18:47:05 +02:00
[Privacy Policy](Privacy-Policy.md)\
2022-09-28 21:18:32 +02:00
Forked from [Privacy Redirect](https://github.com/SimonBrazell/privacy-redirect)