aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorChocobozzz <florian.bigard@gmail.com>2016-10-02 15:39:09 +0200
committerChocobozzz <florian.bigard@gmail.com>2016-10-02 15:39:09 +0200
commita6375e69668ea42e19531c6bc68dcd37f3f7cbd7 (patch)
tree03204a408d56311692c3528bedcf95d2455e94f2 /README.md
parent052937db8a8d282eccdbdf38d487ed8d85d3c0a7 (diff)
parentc4403b29ad4db097af528a7f04eea07e0ed320d0 (diff)
downloadPeerTube-a6375e69668ea42e19531c6bc68dcd37f3f7cbd7.tar.gz
PeerTube-a6375e69668ea42e19531c6bc68dcd37f3f7cbd7.tar.zst
PeerTube-a6375e69668ea42e19531c6bc68dcd37f3f7cbd7.zip
Merge branch 'master' into webseed-merged
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 14 insertions, 5 deletions
diff --git a/README.md b/README.md
index 1a3470711..777df6d7d 100644
--- a/README.md
+++ b/README.md
@@ -60,6 +60,7 @@ Want to see in action?
60 60
61 * You can directly test in your browser with this [demo server](http://peertube.cpy.re). Don't forget to use the latest version of Firefox/Chromium/(Opera?) and check your firewall configuration (for WebRTC) 61 * You can directly test in your browser with this [demo server](http://peertube.cpy.re). Don't forget to use the latest version of Firefox/Chromium/(Opera?) and check your firewall configuration (for WebRTC)
62 * You can find [a video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like 62 * You can find [a video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like
63 * 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.
63 64
64## Why 65## Why
65 66
@@ -95,10 +96,12 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
95- [ ] Validate the prototype (test PeerTube in a real world with many pods and videos) 96- [ ] Validate the prototype (test PeerTube in a real world with many pods and videos)
96- [ ] Manage API breaks 97- [ ] Manage API breaks
97- [ ] Add "DDOS" security (check if a pod don't send too many requests for example) 98- [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
98- [ ] Admin panel 99- [X] Admin panel
99 - [ ] Stats about the network (how many friends, how many requests per hour...) 100 - [X] Stats
100 - [ ] Stats about videos 101 - [X] Friends list
101 - [ ] Manage users (create/remove) 102 - [X] Manage users (create/remove)
103- [ ] User playlists
104- [ ] User subscriptions (by tags, author...)
102 105
103 106
104## Installation 107## Installation
@@ -111,6 +114,7 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
111### Dependencies 114### Dependencies
112 115
113 * **NodeJS >= 4.2** 116 * **NodeJS >= 4.2**
117 * **npm >= 3.0**
114 * OpenSSL (cli) 118 * OpenSSL (cli)
115 * MongoDB 119 * MongoDB
116 * ffmpeg xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron) 120 * ffmpeg xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron)
@@ -123,7 +127,8 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
123 127
124 # apt-get update 128 # apt-get update
125 # apt-get install ffmpeg mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin 129 # apt-get install ffmpeg mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin
126 # npm install -g electron-prebuilt 130 # npm install -g npm@3
131 # npm install -g electron
127 132
128#### Other distribution... (PR welcome) 133#### Other distribution... (PR welcome)
129 134
@@ -160,6 +165,10 @@ Finally, run the server with the `production` `NODE_ENV` variable set.
160 165
161 $ NODE_ENV=production npm start 166 $ NODE_ENV=production npm start
162 167
168**Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx
169
170**Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd
171
163### Other commands 172### Other commands
164 173
165To print all available command run: 174To print all available command run: