X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=094d81c4af6270d81032178cad8fcbebafed1a36;hb=759f8a29e95932023564ca98dcbc90d1acb92da0;hp=c9e76bb746b71c6c992207125a8897192c1ea8f2;hpb=e1e7d14480471108fc09298266ae084f6ea5832c;p=github%2FChocobozzz%2FPeerTube.git
diff --git a/README.md b/README.md
index c9e76bb74..094d81c4a 100644
--- a/README.md
+++ b/README.md
@@ -1,103 +1,288 @@
-# PeerTube
+
+ PeerTube
+
-Prototype of a decentralized video streaming platform using P2P (bittorent) directly in the web browser with [webtorrent](https://github.com/feross/webtorrent).
+
+Federated (ActivityPub) video streaming platform using P2P (BitTorrent)
+directly in the web browser with WebTorrent.
+
-[](https://github.com/feross/standard)
+**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/).**
+
+
+ Client
+
+
+
+
+ 
+
+
+
+ 
+
+
+
+
+ Server
+
+
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+
+
+
+
+
+ 
+
+
+
+## Demonstration
+
+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.
+
+## Why
+
+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.
## Features
-- [ ] Join a network
- - [X] Generate a RSA key
- - [X] Ask for the friend list of other pods and make friend with them
- - [ ] Get the list of the videos owned by a pod when making friend with it
- - [ ] Post the list of its own videos when making friend with another pod
+- [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...)
-- [ ] 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)
-
-## Front compatibility
+- [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
- * Chromium
- * Firefox (>= 42 for MediaSource support)
+## Installation
-## Usage
+See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete
+installation commands.
+
+### Front compatibility
+
+ * Chromium
+ * Firefox (>= 42 for MediaSource support)
### Dependencies
- * NodeJS == 0.12
- * Grunt-cli (npm install -g grunt-cli)
+ * **NodeJS >= 8.x**
+ * yarn
* OpenSSL (cli)
- * MongoDB
- * xvfb-run (for electron)
+ * 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:
+
+```bash
+ $ apt-get update
+ $ apt-get install ffmpeg postgresql openssl
+```
+
+#### Ubuntu 16.04
-### Test It!
+ 1. Install NodeJS 8.x (current LTS): (same as Debian)
+ 2. Install yarn: (same as Debian)
+ 3. Run:
- $ git clone https://github.com/Chocobozzz/PeerTube
+```bash
+ $ apt-get update
+ $ apt-get install ffmpeg postgresql openssl
+```
+
+#### Arch Linux
+
+ 1. Run:
+
+```bash
+ $ pacman -S nodejs yarn ffmpeg postgresql openssl
+```
+
+#### Other distributions
+
+Feel free to update this README file in a pull request!
+
+### Build from the sources
+
+```bash
+ $ 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
-### Test with 3 fresh nodes
- $ scripts/clean_test.sh
- $ scripts/run_servers.sh
+### Production
-Then you will can access to the three nodes at http://localhost:900{1,2,3}. If you call "make friends" on http://localhost:9002, the pod 2 and 3 will become friends. Then if you call "make friends" on http://localhost:9001 it will become friend with the pod 2 and 3 (check the configuration files). Then the pod will communicate with each others. If you add a video on the pod 3 you'll can see it on the pod 1 and 2 :)
+If you want to run PeerTube in production (which might be a bad idea for now :) ):
-## Why
+```bash
+ $ cp config/production.yaml.example config/production.yaml
+```
-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.
-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.
-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.
+Then edit the `config/production.yaml` file according to your webserver
+configuration. Keys set in this file will override those of
+`config/default.yml`.
-## Architecture
+Finally, run the server with the `NODE_ENV` environment variable set to
+`production`:
-See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
+```bash
+ $ NODE_ENV=production npm start
+```
-### Backend
+The administrator password is automatically generated and can be found in the
+logs. You can set another password with:
- * The backend whould be a REST API
- * Servers would communicate with each others with it
- * Each server of a network has a list of all other servers of the network
- * When a new installed server wants to join a network, it just has to get the list of the servers via one server and tell them "Hi I'm new in the network, communicate with me too please"
- * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
- * Server begins to seed and sends to the other servers of the network the video information (name, short description, torrent URI) of a new uploaded video
- * Each server has a RSA key to encrypt and sign communications with other servers
- * A server is a tracker responsible for all the videos uploaded in it
- * Even if nobody watches a video, it is seeded by the server where the video was uploaded
- * A server would run webtorrent-hybrid to be a bridge with webrtc/standard bittorrent protocol
- * A network can live and evolve by expelling bad pod (with too many downtimes for example)
+```bash
+ $ NODE_ENV=production npm run reset-password -- -u root
+```
-See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
+**Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx
+**Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd
-Here are some simple schemes:
+You can check the application (CORS headers, tracker websocket...) by running:
+
+```bash
+ $ NODE_ENV=production npm run check
+```
+
+### Upgrade
+
+The following commands will upgrade the source (according to your current
+branch), upgrade node modules and rebuild client application:
-
+```bash
+ # systemctl stop peertube
+ $ npm run upgrade-peertube
+ # systemctl start peertube
+```
-
+### Test with three fresh nodes
+
+```bash
+ $ npm run clean:server:test
+ $ npm run play
+```
+
+Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
+with the `root` as username and `test{1,2,3}` for the password.
+
+### Other commands
+
+To print all available commands, run:
+
+```bash
+ $ npm run help
+```
+
+## Contributing
+
+See the [contributing
+guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md)
+to see how to contribute to PeerTube. Spoiler alert: you don't need to be a
+coder to help!
+
+## Architecture
+
+See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explanation.
+
+### Backend
+
+ * The backend is a REST API.
+ * Servers communicate with each others with [Activity
+ Pub](https://www.w3.org/TR/activitypub/).
+ * Each server has its own users who query it (search videos, query where the
+ torrent URI of this specific video is...).
+ * If a user uploads a video, the server seeds it and sends its followers some
+ metadata (name, short description, torrent URI...).
+ * A server is a tracker responsible for all the videos uploaded in it.
+ * Even if nobody watches a video, it is seeded by the server (through
+ [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the
+ video was uploaded.
+
+Here are some simple schemes:
-
+
-
+
-
+
-### 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 bittorent protocol, so users could use their favorite bittorent client to download/play the video after having its torrent URI.
+