X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=inline;f=README.md;h=a6f6cfab85dc82d3c676f525515da9bee6b68287;hb=232f04c809bf25952b790da5685b36f05cb19750;hp=7693fd300c20053a99319dd3c1f8687b9835ab9e;hpb=45ef55fccd120184ed5d02aaa1254a2b26162fac;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index 7693fd300..a6f6cfab8 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,11 @@
Client @@ -50,7 +52,7 @@ Decentralized video streaming platform using P2P (BitTorrent) directly in the we
@@ -58,16 +60,16 @@ Decentralized video streaming platform using P2P (BitTorrent) directly in the we Want to see in action? - * You can directly test in your browser with this [demo server](http://peertube.cpy.re). Don't forget to use the latest version of Firefox/Chromium/(Opera?) and check your firewall configuration (for WebRTC) - * You can find [a video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like + * [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. ## Why -We can't build a FOSS video streaming alternatives to YouTube, Dailymotion, Vimeo... with a centralized software. One organization alone cannot have enought money to pay bandwith and video storage of its server. +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 enought because one video could become famous and overload the server. +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. @@ -75,39 +77,36 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t - [X] Frontend - [X] Angular frontend -- [X] Join a network - - [X] Generate a RSA key - - [X] Ask for the friend list of other pods and make friend with them - - [X] Get the list of the videos owned by a pod when making friend with it - - [X] Post the list of its own videos when making friend with another pod -- [X] Quit a network +- [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 to all other friends + - [X] Send the meta data with ActivityPub to followers - [X] Remove the video - [X] List the videos -- [X] Search a video name (local index) -- [X] View the video in an HTML5 page with WebTorrent -- [X] Manage admin account - - [X] Connection - - [X] Account rights (upload...) -- [X] Make the network auto sufficient (eject bad pods etc) -- [X] Validate the prototype (test PeerTube in a real world) -- [ ] Manage inter pod API breaks -- [ ] Add "DDOS" security (check if a pod don't send too many requests for example) +- [X] View the video in an HTML5 player with WebTorrent - [X] Admin panel - - [X] Stats - - [X] Friends list - - [X] Manage users (create/remove) - [X] OpenGraph tags +- [X] OEmbed - [X] Update video -- [X] Videos view count +- [X] Videos view counter - [X] Videos likes/dislikes -- [ ] Videos comments? +- [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 -- [ ] User playlists +- [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...) -- [X] Signaling a video to the admin origin pod +- [ ] Add "DDOS" security ## Installation @@ -121,8 +120,7 @@ See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete installatio ### Dependencies - * **NodeJS >= 6.x** - * **npm >= 3.x** + * **NodeJS >= 8.x** * yarn * OpenSSL (cli) * PostgreSQL @@ -130,13 +128,21 @@ See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete installatio #### Debian - * Install NodeJS 6.x (actual 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) - * Install yarn: [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install) - * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/ - * Run: + 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 - # apt-get update - # apt-get install ffmpeg postgresql-9.4 openssl + 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) @@ -178,14 +184,25 @@ You can check the application (CORS headers, tracker websocket...) by running: The following commands will upgrade the source (according to your current branch), upgrade node modules and rebuild client application: # systemctl stop peertube - $ npm run upgrade + $ npm run upgrade-peertube # systemctl start peertube ### Development -In this mode, the server will run requests between pods more quickly, the videos duration are limited to a few seconds and the client files are automatically compiled when we modify them: +In this mode, the server will run requests between instances more quickly, the video durations are limited to a few seconds. + +To develop on the server-side (server files are automatically compiled when we modify them and the server restarts automatically too): + + $ npm run dev:server + +The server (with the client) will listen on `localhost:9000`. + + +To develop on the client side (client files are automatically compiled when we modify them): - $ npm run dev + $ npm run dev:client + +The API will listen on `localhost:9000` and the frontend on `localhost:3000` (with hot module replacement, you don't need to refresh the web browser). **Username**: *root*- + - + - - - - - +
- -### Frontend - -There already is a frontend (Angular 2) but the backend is a REST API so anybody can build a frontend (Web application, desktop application...). -The backend uses BitTorrent protocol, so users could use their favorite BitTorrent client to download/play the video with its torrent URI.