X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=9ba01d99e2ba1111e95f4bbb4351ad8638d8539f;hb=cfdd9eb4b0458b64fa388685c1e9784fab81b7f2;hp=a6f6cfab85dc82d3c676f525515da9bee6b68287;hpb=6f045b57915d0eac8e590c503b362d2df5e16b85;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index a6f6cfab8..9ba01d99e 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,14 @@ PeerTube -
+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-libre software. If you want to support this project, please [consider donating them](https://soutenir.framasoft.org/en/).** ++We are running a crowdfunding campaign to pave the road to version 1.0 of PeerTube! +
Client
@@ -17,9 +20,13 @@ Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly
-
+
+
+
+
+
@@ -35,7 +42,7 @@ Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly
-
+
@@ -56,191 +63,98 @@ Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly
+ Website | + Instances list + +
+ ## Demonstration -Want to see in action? +Want to see it in action? - * [Demo server](http://peertube.cpy.re) - * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504) to see how the "decentralization feature" looks like - * Experimental demo servers that share videos (they are in the same network): [peertube2](http://peertube2.cpy.re), [peertube3](http://peertube3.cpy.re). Since I do experiments with them, sometimes they might not work correctly. + * Demonstration servers: + * [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 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 -We can't build a FOSS video streaming alternatives to YouTube, Dailymotion, Vimeo... with a centralized software. One organization alone cannot have enough money to pay bandwidth and video storage of its server. - -So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example). -But it's not enough because one video could become famous and overload the server. -It's the 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 right now. - -## Features - -- [X] Frontend - - [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] Videos view counter -- [X] 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 -- [ ] Videos comments -- [ ] User playlist -- [ ] User subscriptions (by tags, author...) -- [ ] Add "DDOS" security - - -## Installation - -See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete installation commands. - -### Front compatibility - - * Chromium - * Firefox (>= 42 for MediaSource support) - -### Dependencies +We can't build a FOSS video streaming alternatives to YouTube, Dailymotion, +Vimeo... with a centralized software. One organization alone may not have +enough money to pay for bandwidth and video storage of its servers. + +So we need to have a decentralized network of servers seeding videos (as +[Diaspora](https://github.com/diaspora/diaspora) for example). But it's not +enough because one video could become famous and overload the server. It's the +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. + +## Dependencies + * nginx + * PostgreSQL + * Redis * **NodeJS >= 8.x** * yarn * OpenSSL (cli) - * PostgreSQL - * FFmpeg - -#### Debian - - 1. Install NodeJS 8.x (current LTS): [https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions) - 2. Install yarn: [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install) - 4. Run: - - $ apt-get update - $ apt-get install ffmpeg postgresql openssl - -#### Ubuntu 16.04 - - 1. Install NodeJS 8.x (current LTS): (same as Debian) - 2. Install yarn: (same as Debian) - 3. Run: - - $ apt-get update - $ apt-get install ffmpeg postgresql openssl - -#### Other distribution... (PR welcome) - - -### Sources - - $ git clone -b master https://github.com/Chocobozzz/PeerTube - $ cd PeerTube - $ yarn install - $ npm run build - -## Usage - -### Production - -If you want to run PeerTube for production (bad idea for now :) ): + * **FFmpeg >= 3.x** - $ cp config/production.yaml.example config/production.yaml +## Run using Docker -Then edit the `config/production.yaml` file according to your webserver configuration. Keys set in this file will override those of `config/default.yml`. +See the [docker guide](/support/doc/docker.md) -Finally, run the server with the `production` `NODE_ENV` variable set. +## Production - $ NODE_ENV=production npm start +See the [production guide](/support/doc/production.md). -The administrator password is automatically generated and can be found in the logs. You can set another password with: +## Contributing/Test - $ NODE_ENV=production npm run reset-password -- -u root +See the [contributing +guide](/.github/CONTRIBUTING.md) +to see how to test or contribute to PeerTube. Spoiler alert: you don't need to be a +coder to help! -**Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx