X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=68c2f907b2a04283b112a0cda1db6da9ecb3b438;hb=67bf9b96bbcd92b069fe86d9223fe0f8b9c6e677;hp=bff2c4e60c460d0fd71dc6e314f8a6b18f7ed5a1;hpb=643a5fc5185ff9829313f22dc76db6b7e173fb49;p=github%2FChocobozzz%2FPeerTube.git
diff --git a/README.md b/README.md
index bff2c4e60..68c2f907b 100644
--- a/README.md
+++ b/README.md
@@ -100,6 +100,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 +117,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 +127,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 +137,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.
@@ -180,6 +170,19 @@ The following commands will upgrade the source (according to your current branch
$ 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:
@@ -196,6 +199,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
@@ -229,7 +234,7 @@ Here are some simple schemes:
-