TeamPiped-mirror/documentation
1
0
Fork 0
mirror of https://github.com/TeamPiped/documentation.git synced 2024-08-14 23:50:09 +00:00
Code Issues Projects Releases Packages Wiki Activity

fix type and run formatter

Browse source
This commit is contained in:
FireMasterK 2021-02-07 21:08:23 +05:30
parent 44298d0f39
commit d02269972a
No known key found for this signature in database
GPG key ID: 8DFF5DD33E93DB58
4 changed files with 55 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
content/_index.md
View file

@ -1,5 +1,5 @@
--- ---
title: 'Piped' title: "Piped"
--- ---
Piped is a privacy friendly alternative YouTube frontend, which is efficient and scalable by design. Piped is a privacy friendly alternative YouTube frontend, which is efficient and scalable by design.

2
content/docs/_index.md
View file

@ -1,5 +1,5 @@
--- ---
title: 'Overview' title: "Overview"
weight: 1 weight: 1
--- ---

9
content/docs/architecture/index.md
View file

@ -1,10 +1,10 @@
--- ---
title: 'Architecture' title: "Architecture"
weight: 4 weight: 4
summary: What is Piped architectured? summary: How is Piped architectured?
--- ---
## What is Piped's architecture? ## How is Piped's architecture?
Piped has 3 components: Piped has 3 components:
@ -15,10 +15,12 @@ Piped has 3 components:
links: https://github.com/TeamPiped/Piped\, https://github.com/TeamPiped/Piped-Backend and, https://github.com/FireMasterK/http3-ytproxy links: https://github.com/TeamPiped/Piped\, https://github.com/TeamPiped/Piped-Backend and, https://github.com/FireMasterK/http3-ytproxy
## Frontend ## Frontend
- Uses videojs - Uses videojs
- Uses a router for a single page application. - Uses a router for a single page application.
## Backend ## Backend
- Uses Java 11 - Uses Java 11
- Uses the native HTTP client introduced in Java 9 - Uses the native HTTP client introduced in Java 9
- Uses netty-reactor to acheive maximum performance and a low footprint. - Uses netty-reactor to acheive maximum performance and a low footprint.
@ -27,6 +29,7 @@ links: https://github.com/TeamPiped/Piped\, https://github.com/TeamPiped/Piped-B
- Uses ~70-130 MB of ram. (on OpenJ9) - Uses ~70-130 MB of ram. (on OpenJ9)
# Proxy # Proxy
- Uses Golang - Uses Golang
- Has HTTP/2 support. (HTTP/3 is unstable in the current library) - Has HTTP/2 support. (HTTP/3 is unstable in the current library)
- Low memory footprint and high throughput. - Low memory footprint and high throughput.

4
content/docs/why/index.md
View file

@ -1,5 +1,5 @@
--- ---
title: 'Why' title: "Why"
weight: 4 weight: 4
summary: Why did I create Piped? summary: Why did I create Piped?
--- ---
@ -34,10 +34,12 @@ A lot of inspiration came from NewPipe and Invidious.
I created Piped to fix issues in NewPipe and Invidious which are architectural issues and cannot be fixed easily. I created Piped to fix issues in NewPipe and Invidious which are architectural issues and cannot be fixed easily.
### NewPipe ### NewPipe
- Your IP is exposed to YouTube. - Your IP is exposed to YouTube.
- Feeds are slow to load. - Feeds are slow to load.
### Invidious ### Invidious
- Uses way too much resources. - Uses way too much resources.
- Total bandwidth limited by the peak capacity of the load balancer. - Total bandwidth limited by the peak capacity of the load balancer.
- Coded in Crystal, a language that is relatively hard for beginners. - Coded in Crystal, a language that is relatively hard for beginners.