IntenseWebs/PeerTube
3
0
Fork 0
mirror of https://github.com/Chocobozzz/PeerTube.git synced 2024-11-22 08:46:54 -06:00
Code Issues Packages Projects Releases Wiki Activity
4bbc373f13
PeerTube/ARCHITECTURE.md
Benjamin Bouvier e755a63a1b Reword docs (#176) 
* Reword documentation;

* Wrap lines at 80 characters in the documentation.

* Wrap CONTRIBUTING.md too;

* Tweaks to CONTRIBUTING.md wording;

* Move development section to CONTRIBUTING.md;

* Explain database creation in CONTRIBUTING.md;
2018-01-06 18:10:30 +01:00

1.9 KiB
Raw Blame History

Architecture

Vocabulary

  • Fediverse: several servers following each others.
  • Instance: a server which runs PeerTube in the fediverse.
  • Origin instance: the instance on which the video was uploaded and which is seeding (through the WebSeed protocol) the video.
  • Following: the action of a PeerTube instance which will follow another instance (subscribe to its videos).

Base

Communications

  • All the communication between the instances are signed with Linked Data Signatures with the private key of the account that authored the action.
  • We use the ActivityPub protocol (only server-server for now). Object models could be found in shared/models/activitypub directory.
  • All the requests are retried several times if they fail.
  • The maximum of points would be defined.

Instance

  • An instance has a websocket tracker which is responsible for all the video uploaded in it.
  • An instance has an administrator that can follow other instances.
  • An instance can be configured to follow back automatically.
  • An instance can blacklist other instances (only used in "follow back" mode).
  • An instance cannot choose which other instances follow it, but it can decide to reject all followers.
  • After having uploaded a video, the instance seeds it (WebSeed protocol).
  • If a user wants to watch a video, they ask its instance the magnet URI and the frontend adds the torrent (with WebTorrent), creates the HTML5 video player and streams the file into it.
  • A user watching a video seeds it too (BitTorrent). Thus another user who is watching the same video can get the data from the origin server and other users watching it.