mirror of
https://github.com/TeamPiped/Piped.git
synced 2024-08-14 23:57:27 +00:00
167 lines
8.1 KiB
Markdown
167 lines
8.1 KiB
Markdown
# Piped
|
|
|
|
[](https://www.gnu.org/licenses/agpl-3.0.en.html)
|
|
[](https://matrix.to/#/#piped:matrix.org)
|
|
[](https://feddit.rocks/c/piped)
|
|
[](https://piped.video/register)
|
|
[](https://piped-ipfs.kavin.rocks/)
|
|
[](https://github.com/TeamPiped/Piped/stargazers)
|
|
[](https://github.com/TeamPiped/Piped/commits)
|
|
[](https://hosted.weblate.org/projects/piped/frontend/)
|
|
|
|
An open-source alternative frontend for YouTube which is efficient by design.
|
|
|
|
# The Problem
|
|
|
|
YouTube has an extremely invasive privacy policy which relies on using user data in unethical ways. You give them a lot of data - ranging from ideas, music taste, content, political opinions, and much more than you think.
|
|
|
|
By using Piped, you can freely watch and listen to content without the fear of prying eyes watching everything you are doing.
|
|
|
|
## Features:
|
|
|
|
**User Features**
|
|
|
|
- [x] No Ads
|
|
- [x] No Tracking
|
|
- [x] Lightweight on server and client
|
|
- [x] Infinite Scrolling
|
|
- [x] Light/Dark themes
|
|
- [x] Login
|
|
- [x] Feeds
|
|
- [x] Playlists
|
|
- [x] Integration with [SponsorBlock](https://github.com/ajayyy/SponsorBlock)
|
|
- [x] Integration with [LBRY](https://lbry.com/) for streaming
|
|
- [x] Integration with [Return YouTube Dislike](https://returnyoutubedislike.com/) via [RYD-Proxy](https://github.com/TeamPiped/RYD-Proxy)
|
|
- [x] 4K support
|
|
- [x] No connections to Google's servers
|
|
- [x] Playing just audio
|
|
- [x] PWA support
|
|
- [x] Locally saved Preferences
|
|
- [x] [Available in many languages](src/locales), thanks to [our translators](https://hosted.weblate.org/projects/piped/frontend/)
|
|
- [x] Embedded video support
|
|
- [x] No age restriction
|
|
- [x] Bypasses Geo restrictions if possible through a federated network
|
|
|
|
**Technical Features**
|
|
|
|
- [x] Multi-region load-balancing
|
|
- [x] Performant by design, designed to handle 1000s of users concurrently
|
|
- [x] Does not use official YouTube APIs
|
|
- [x] Uses [NewPipeExtractor](https://github.com/TeamNewPipe/NewPipeExtractor) to extract information
|
|
- [x] Public [JSON API](https://docs.piped.video/docs/api-documentation/)
|
|
- [x] Federated protocol on Matrix to let instances collaborate with each other
|
|
|
|
## Screenshots
|
|
|
|
| Player | Trending | Channel |
|
|
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
|
|  |  |  |
|
|
|
|
## Public Chat Rooms
|
|
|
|
- You can join us via Matrix at [#piped](https://matrix.to/#/#piped:matrix.org).
|
|
- You can also join us at the libera.chat IRC network which is bridged to the Matrix room at [#piped](https://web.libera.chat/#piped).
|
|
|
|
## Public Communities
|
|
|
|
- You can join us on Lemmy on the [!piped@feddit.rocks](https://feddit.rocks/c/piped) community.
|
|
|
|
## Self-Hosting
|
|
|
|
See https://docs.piped.video/docs/self-hosting/ for more details.
|
|
|
|
The source code of the documentation website is available at https://github.com/TeamPiped/Documentation.
|
|
|
|
## Documentation
|
|
|
|
The documentation can be found at https://docs.piped.video (accessible via IPNS as well).
|
|
|
|
## Extensions
|
|
|
|
To redirect all YouTube links to Piped, you are highly recommended to use either [Piped-Redirects](https://github.com/TeamPiped/Piped-Redirects) or [Libredirect](https://github.com/libredirect/libredirect#readme).
|
|
|
|
## Contributing
|
|
|
|
### Translations
|
|
|
|
You can help by translating the project to a language you speak at https://hosted.weblate.org/projects/piped/frontend/
|
|
|
|
### Mirrors
|
|
|
|
- Cloudflare Pages - [cf.piped.video](https://cf.piped.video/)
|
|
- Vercel - [vc.piped.video](https://vc.piped.video/)
|
|
- Render - [re.piped.video](https://re.piped.video/)
|
|
- Fleek - [fl.piped.video](https://fl.piped.video/)
|
|
- DigitalOcean - [do.piped.video](https://do.piped.video/)
|
|
- Netlify - [nf.piped.video](https://nf.piped.video/)
|
|
- Azure - [az.piped.video](https://az.piped.video/)
|
|
|
|
### Forking, and contributing
|
|
|
|
- Fork the repository on GitHub: https://github.com/TeamPiped/Piped/fork
|
|
- Create your feature branch: `git checkout -b my-awesome-feature`
|
|
- Stage your files `git add .`
|
|
- Commit your changes `git commit -am 'Add awesome new feature'`
|
|
- Push to the branch `git push origin my-awesome-feature`
|
|
- Create a new pull request: https://github.com/TeamPiped/Piped/compare
|
|
|
|
### Development Setup
|
|
|
|
```
|
|
pnpm install
|
|
```
|
|
|
|
### Compiles and hot-reloads for development
|
|
|
|
```
|
|
pnpm serve
|
|
```
|
|
|
|
You can now make changes and view then in realtime!
|
|
|
|
## Contact
|
|
|
|
If you would like to contact me personally, you may do so with the following means:
|
|
|
|
- Matrix: @kavin1337:matrix.org
|
|
- Mastodon: https://mastodon.online/@kavin
|
|
- Email: kavin@kavin.rocks
|
|
|
|
## Donations
|
|
|
|
Donations can be made at:
|
|
|
|
- bc1qhq8zjxmu405nvp37njj6zv3s980zg400pu9jfe (BTC)
|
|
- 0x1D77D4cfB1a947514241bcf19B1F04738495e2fD (ETH)
|
|
- 8A5Up8rKgagVAz6TuUduBqHp518H1U6fYc6GqCfWsaEfjGzbSccfYpgMqp5d4oe5Ws5MuFE1iKmhQTadhMhvuk3bHRT5Ebk (XMR, aka Monero)
|
|
- nano_1ngejzydncche4rdua3iebhj7sa95pw5geq4pb8phugtjf3tku933ktjb4pq (Nano)
|
|
- XpzgouDTKCUuE8a92XqjX9b43gKL8oLihw (Dash)
|
|
|
|
FIAT donations can be made at: https://liberapay.com/kavin
|
|
|
|
Contributions in any other form are also welcomed.
|
|
|
|
# Made with Piped
|
|
|
|
- [Yattee](https://github.com/yattee/yattee) - an alternative frontend for YouTube, for IOS.
|
|
- [LibreTube](https://github.com/Libre-tube/LibreTube) - an alternative frontend for YouTube, for Android.
|
|
- [Racoon](https://github.com/shailendramaurya/racoon) - A web based minimal YouTube downloader.
|
|
- [Hyperpipe](https://codeberg.org/Hyperpipe/Hyperpipe) - an alternative privacy respecting frontend for YouTube Music.
|
|
- [Musicale](https://github.com/Bellisario/musicale) - an alternative to YouTube Music, with style.
|
|
- [ytify](https://github.com/n-ce/ytify) - a complementary minimal audio streaming frontend for YouTube.
|
|
- [PsTube](https://github.com/prateekmedia/pstube) - Watch and download videos without ads on Android, Linux, Windows, iOS, and Mac OSX.
|
|
- [Piped-Material](https://github.com/mmjee/Piped-Material) - A fork of Piped, focusing on better performance and a more usable design.
|
|
- [ReacTube](https://github.com/NeeRaj-2401/ReacTube) - Privacy friendly & distraction free Youtube front-end using Piped API.
|
|
- [YTDLnis](https://github.com/deniscerri/ytdlnis) - Video and audio downloader for Android that uses Piped to update formats.
|
|
- [DeskVideo](https://github.com/malisipi/DeskVideo) - A desktop styled, customizable alternative front-end for YouTube.
|
|
|
|
## YourKit
|
|
|
|
|
|
|
|
YourKit has given an open source license for their profiler, greatly simplifying the profiling of Piped's performance.
|
|
|
|
YourKit supports open source projects with its full-featured Java Profiler.
|
|
YourKit, LLC is the creator of [YourKit Java Profiler](https://www.yourkit.com/java/profiler/)
|
|
and [YourKit .NET Profiler](https://www.yourkit.com/.net/profiler/),
|
|
innovative and intelligent tools for profiling Java and .NET applications.
|