X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=f9de61c724236b67c7dbe81d4769b05415f4c467;hb=99fe265a5fc077cb66c322e7f3d191ff7110aea0;hp=cb3e83f3e8ad7b6bc9374fd48542e11e87a94198;hpb=844e39c2f843c6e2db81699176f13972c29c42fa;p=github%2FChocobozzz%2FPeerTube.git
diff --git a/README.md b/README.md
index cb3e83f3e..f9de61c72 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
-Prototype of a decentralized 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.
@@ -44,6 +44,10 @@ Prototype of a decentralized video streaming platform using P2P (bittorrent) dir
+
+
+
+
@@ -100,6 +104,7 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
- [X] Stats
- [X] Friends list
- [X] Manage users (create/remove)
+- [X] OpenGraph tags
- [ ] User playlists
- [ ] User subscriptions (by tags, author...)
- [ ] Signaling a video to the admin pod
@@ -116,7 +121,7 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
* **NodeJS >= 4.x**
* **npm >= 3.x**
* OpenSSL (cli)
- * MongoDB
+ * PostgreSQL
* ffmpeg
#### Debian
@@ -126,7 +131,7 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
* Run:
# apt-get update
- # apt-get install ffmpeg mongodb openssl
+ # apt-get install ffmpeg postgresql-9.4 openssl
# npm install -g npm@3
#### Other distribution... (PR welcome)
@@ -136,29 +141,18 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
$ git clone https://github.com/Chocobozzz/PeerTube
$ cd PeerTube
- $ npm install
+ $ npm install # Or npm install --unsafe-perm for root user
$ npm run build
## Usage
-### Development
-
- $ npm run dev
-
-### Test with 3 fresh nodes
-
- $ npm run clean:server:test
- $ npm run play
-
-Then you will can 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. 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 :)
-
### 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.
+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.
@@ -172,6 +166,27 @@ 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
+ # 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:
+
+ $ npm run dev
+
+### Test with 3 fresh nodes
+
+ $ npm run clean:server:test
+ $ npm run play
+
+Then you will can 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. 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 :)
+
### Other commands
To print all available command run:
@@ -188,6 +203,8 @@ See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/
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).
+
## Architecture
@@ -221,7 +238,7 @@ Here are some simple schemes:
-