X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=077d6b8f0bbcfe648b6238231b2e9065684cfd9c;hb=bb82394c0d41cc939a35782e50ce908c92e3ecfe;hp=8cae42aab5239dc64dc646b8678cef728d4b61a4;hpb=e7870ff368251c6368137aab4f670517b37a2a20;p=github%2FChocobozzz%2FPeerTube.git
diff --git a/README.md b/README.md
index 8cae42aab..077d6b8f0 100644
--- a/README.md
+++ b/README.md
@@ -1,50 +1,117 @@
-# PeerTube
+
+ PeerTube
+
-[](https://travis-ci.org/Chocobozzz/PeerTube)
-[](https://david-dm.org/Chocobozzz/PeerTube)
-[](https://codeclimate.com/github/Chocobozzz/PeerTube)
+
+Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent.
+
-Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [webtorrent](https://github.com/feross/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/).**
-[](https://github.com/feross/standard)
+
+ 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
@@ -53,37 +120,120 @@ Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (t
### Dependencies
- * **NodeJS >= 4.2**
+ * **NodeJS >= 8.x**
+ * yarn
* OpenSSL (cli)
- * MongoDB
- * xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 (for electron)
+ * PostgreSQL
+ * FFmpeg
#### Debian
-Install NodeJS 4.2: [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)
+ 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
+
+#### Arch Linux
- # apt-get install mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1
- # npm install -g electron-prebuilt
+ 1. Run:
+ $ pacman -S nodejs yarn ffmpeg postgresql openssl
-### Test It!
+#### Other distribution... (PR welcome)
- $ 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
+**Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd
+
+You can check the application (CORS headers, tracker websocket...) by running:
+
+ $ 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:
+
+ # systemctl stop peertube
+ $ npm run upgrade-peertube
+ # systemctl start peertube
+
+### Development
+
+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: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*
+**Password**: *test*
### Test with 3 fresh nodes
- $ bin/clean_test.sh
- $ bin/run_servers.sh
+ $ 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
-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 :)
+To print all available command run:
-### Dockerfile
+ $ npm run help
+
+## Contributing
+
+See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md).
+
+See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
+
+See the [client code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md).
-You can test it inside Docker with the [PeerTube-Docker repository](https://github.com/Chocobozzz/PeerTube-Docker). Moreover it can help you to check how to create an environment with the required dependencies for PeerTube on a GNU/Linux distribution.
## Architecture
@@ -91,33 +241,21 @@ See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITE
### Backend
- * 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
+ * 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, where the torrent URI of this specific video is...)
+ * If a user upload a video, the server seeds it and sends the video information (name, short description, torrent URI...) its followers
* 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)
-
-See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
+ * 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 bittorrent protocol, so users could use their favorite bittorrent client to download/play the video after having its torrent URI.
+