diff options
author | Chocobozzz <florian.bigard@gmail.com> | 2016-04-30 12:56:44 +0200 |
---|---|---|
committer | Chocobozzz <florian.bigard@gmail.com> | 2016-04-30 12:56:44 +0200 |
commit | 94171ec534262bdedeac1b42ce2a6964e88e37e2 (patch) | |
tree | 9b48e21b4bd74cbb6f985956bccdc25c8921c4e6 /README.md | |
parent | 9353449515ff6881a54ce6887297b7eab2855186 (diff) | |
download | PeerTube-94171ec534262bdedeac1b42ce2a6964e88e37e2.tar.gz PeerTube-94171ec534262bdedeac1b42ce2a6964e88e37e2.tar.zst PeerTube-94171ec534262bdedeac1b42ce2a6964e88e37e2.zip |
Reformat the readme a little bit
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 24 |
1 files changed, 18 insertions, 6 deletions
@@ -50,7 +50,7 @@ Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (t | |||
50 | - [ ] Add "DDOS" security (check if a pod don't send too many requests for example) | 50 | - [ ] Add "DDOS" security (check if a pod don't send too many requests for example) |
51 | 51 | ||
52 | 52 | ||
53 | ## Usage | 53 | ## Installation |
54 | 54 | ||
55 | ### Front compatibility | 55 | ### Front compatibility |
56 | 56 | ||
@@ -71,24 +71,36 @@ Install NodeJS 4.2: [https://nodejs.org/en/download/package-manager/#debian-and- | |||
71 | # apt-get install mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin | 71 | # apt-get install mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin |
72 | # npm install -g electron-prebuilt | 72 | # npm install -g electron-prebuilt |
73 | 73 | ||
74 | #### Other distribution... (PR welcome) | ||
75 | |||
74 | 76 | ||
75 | ### Test It! | 77 | ### Sources |
76 | 78 | ||
77 | $ git clone https://github.com/Chocobozzz/PeerTube | 79 | $ git clone https://github.com/Chocobozzz/PeerTube |
78 | $ cd PeerTube | 80 | $ cd PeerTube |
79 | # npm install -g electron-prebuilt | ||
80 | $ npm install | 81 | $ npm install |
81 | $ npm run build | 82 | $ npm run build |
83 | |||
84 | ## Usage | ||
85 | |||
86 | ### Run the server | ||
87 | |||
82 | $ npm start | 88 | $ npm start |
83 | 89 | ||
84 | ### Test with 3 fresh nodes | 90 | ### Test with 3 fresh nodes |
85 | 91 | ||
86 | $ bin/clean_test.sh | 92 | $ npm run clean:server:test |
87 | $ bin/run_servers.sh | 93 | $ npm run play |
88 | 94 | ||
89 | 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 :) | 95 | 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 :) |
90 | 96 | ||
91 | ### Dockerfile | 97 | ### Other commands |
98 | |||
99 | To print all available command run: | ||
100 | |||
101 | $ npm run help | ||
102 | |||
103 | ## Dockerfile | ||
92 | 104 | ||
93 | 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. | 105 | 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. |
94 | 106 | ||