X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=68b5dc519420010a6fa3a181eb1650d026b2e09d;hb=c60774b05b12d262ed27d8efeb0905ac283eeebb;hp=d3d6433a7b7aaa5e67f44fbd3d6cf1ed2308d39b;hpb=86435b9baedfe300a28ea4545511c1b50d4119f6;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index d3d6433a7..68b5dc519 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,117 @@ -# PeerTube +
+ Client
+
+
+
+
+
+
+
+
+
+
+
+ Server
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + +
+ +## Demonstration + +Want to see 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. ## 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. +Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now. ## Features -- [ ] Frontend - - [X] Simple frontend (All elements are generated by jQuery) - - [ ] AngularJS 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] 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 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 -- [ ] Manage user accounts - - [ ] Inscription - - [ ] Connection - - [ ] Account rights (upload...) -- [X] Make the network auto sufficient (eject bad pods etc) -- [ ] Manage API breaks -- [ ] Add "DDOS" security (check if a pod don't send too many requests for example) - - -## Usage +- [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 @@ -52,30 +120,107 @@ Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (t ### Dependencies - * **NodeJS >= 4.2** - * Grunt-cli (npm install -g grunt-cli) + * **NodeJS >= 6.x** + * **npm >= 3.x** + * yarn * OpenSSL (cli) - * MongoDB - * xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 (for electron) + * PostgreSQL + * FFmpeg + +#### 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: + + # apt-get update + # apt-get install ffmpeg postgresql-9.4 openssl + +#### Other distribution... (PR welcome) -### Test It! - $ git clone https://github.com/Chocobozzz/PeerTube +### Sources + + $ git clone -b master https://github.com/Chocobozzz/PeerTube $ cd PeerTube - # npm install -g electron-prebuilt - $ npm install - $ npm start + $ yarn install + $ npm run build + +## Usage + +### Production + +If you want to run PeerTube for production (bad idea for now :) ): + + $ cp config/production.yaml.example config/production.yaml + +Then edit the `config/production.yaml` file according to your webserver configuration. Keys set in this file will override those of `config/default.yml`. + +Finally, run the server with the `production` `NODE_ENV` variable set. + + $ NODE_ENV=production npm start + +The administrator password is automatically generated and can be found in the logs. You can set another password with: + + $ NODE_ENV=production npm run reset-password -- -u root + +**Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx-![Join a network](http://lutim.cpy.re/ijuCgmpI) + -![Many networks](http://lutim.cpy.re/iz8mXHug) + -### Frontend + -There would be a simple frontend (Bootstrap, AngularJS) but since the backend is a REST API anybody could 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 after having its torrent URI. +