X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=88eac088a1471f5c91a11acab7eafd3692cd5b4d;hb=e1a540b5fa14b0fafa63f99e344927b10fdbee00;hp=b37d79e554f7ba16b8bf85c4446df491fb5df267;hpb=afe817679974cec47f5bea1699cee3fe58cd5ada;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index b37d79e55..88eac088a 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,10 @@ Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent. -**PeerTube is sponsored by [Framasoft](https://framatube.org/#en), a non-profit -that promotes, spreads and develops free culture in general, and free-libre -software in particular. If you want to support this project, please [consider -donating them](https://soutenir.framasoft.org/en/).** +**PeerTube is developed by [Framasoft](https://framasoft.org/?l=en), a non-profit +that promotes and spreads free culture in general, and free-libre software in +particular. If you want to support this project, please [consider +donating to them](https://soutenir.framasoft.org/en/).**
Client
@@ -21,9 +21,13 @@ donating them](https://soutenir.framasoft.org/en/).**
-
+
+
+
+
+
@@ -39,7 +43,7 @@ donating them](https://soutenir.framasoft.org/en/).**
-
+
@@ -60,16 +64,24 @@ donating them](https://soutenir.framasoft.org/en/).**
+ Website | + Instances list + +
+ ## Demonstration Want to see it in action? * Demonstration servers: - * [peertube.cpy.re](http://peertube.cpy.re) - * [peertube2.cpy.re](http://peertube2.cpy.re) + * [peertube.cpy.re](http://peertube.cpy.re) + * [peertube2.cpy.re](http://peertube2.cpy.re) * [peertube3.cpy.re](http://peertube3.cpy.re) * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504) - to see how the "decentralization feature" looks like + to see what the "decentralization feature" looks like + * [Video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) to see + the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon) ## Why @@ -84,69 +96,49 @@ reason why we need to use a P2P protocol to limit the server load. Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus BitTorrent) inside the web browser, as of today. -## Features - -- [X] Angular frontend -- [X] Join the fediverse - - [X] Follow other instances - - [X] Unfollow an instance - - [X] Get for the followers/following list -- [X] Upload a video - - [X] Seed the video - - [X] Send the meta data with ActivityPub to followers -- [X] Remove the video -- [X] List the videos -- [X] View the video in an HTML5 player with WebTorrent -- [X] Admin panel -- [X] OpenGraph tags -- [X] OEmbed -- [X] Update video -- [X] Federated videos view counter -- [X] Federated videos likes/dislikes -- [X] Transcoding to different definitions -- [X] Download file/torrent -- [X] User video bytes quota -- [X] User video channels -- [X] NSFW warnings/settings -- [X] Video description in markdown -- [X] User roles (administrator, moderator) -- [X] User registration -- [X] Video privacy settings (public, unlisted or private) -- [X] Signaling a video to the admin origin PeerTube instance -- [X] Federated videos comments -- [ ] Video imports (URL, Torrent, YouTube...) -- [ ] Advanced search -- [ ] Subtitles -- [ ] User playlist -- [ ] User subscriptions (by tags, author...) -- [ ] Add "DDOS" security - - -## Front compatibility - - * Firefox - * Chrome/Chromium - ## Dependencies * nginx * PostgreSQL + * Redis * **NodeJS >= 8.x** * yarn * OpenSSL (cli) - * FFmpeg + * **FFmpeg >= 3.x** + +## Run using Docker + +See the [docker guide](/support/doc/docker.md) ## Production -See the [production guide](support/doc/production.md). +See the [production guide](/support/doc/production.md). -## Contributing +## Contributing/Test See the [contributing guide](/.github/CONTRIBUTING.md) -to see how to contribute to PeerTube. Spoiler alert: you don't need to be a +to see how to test or contribute to PeerTube. Spoiler alert: you don't need to be a coder to help! +## API REST documentation + +Quick Start: [/support/doc/api/quickstart.md](/support/doc/api/quickstart.md) + +Endpoints documentation: + + * HTML version: [/support/doc/api/html/index.html](https://htmlpreview.github.io/?https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/html/index.html) + * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml) + +## Tools + + * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md) + * [Upload videos from the CLI](/support/doc/tools.md) + +## FAQ + +If you have a question, please try to find the answer in the [FAQ](/FAQ.md) first. + ## Architecture See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation. @@ -176,3 +168,20 @@ Here are some simple schemes: