Reformat the readme a little bit
This commit is contained in:
parent
9353449515
commit
94171ec534
1 changed files with 18 additions and 6 deletions
24
README.md
24
README.md
|
@ -50,7 +50,7 @@ Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (t
|
|||
- [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
|
||||
|
||||
|
||||
## Usage
|
||||
## Installation
|
||||
|
||||
### Front compatibility
|
||||
|
||||
|
@ -71,24 +71,36 @@ Install NodeJS 4.2: [https://nodejs.org/en/download/package-manager/#debian-and-
|
|||
# apt-get install mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin
|
||||
# npm install -g electron-prebuilt
|
||||
|
||||
#### Other distribution... (PR welcome)
|
||||
|
||||
### Test It!
|
||||
|
||||
### Sources
|
||||
|
||||
$ git clone https://github.com/Chocobozzz/PeerTube
|
||||
$ cd PeerTube
|
||||
# npm install -g electron-prebuilt
|
||||
$ npm install
|
||||
$ npm run build
|
||||
|
||||
## Usage
|
||||
|
||||
### Run the server
|
||||
|
||||
$ npm start
|
||||
|
||||
### Test with 3 fresh nodes
|
||||
|
||||
$ bin/clean_test.sh
|
||||
$ bin/run_servers.sh
|
||||
$ npm run clean:server:test
|
||||
$ npm run play
|
||||
|
||||
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 :)
|
||||
|
||||
### Dockerfile
|
||||
### Other commands
|
||||
|
||||
To print all available command run:
|
||||
|
||||
$ npm run help
|
||||
|
||||
## Dockerfile
|
||||
|
||||
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.
|
||||
|
||||
|
|
Loading…
Reference in a new issue