Explain headless electron requirement in README

master
Torjus 2018-07-31 12:39:53 +02:00
parent 31a0017e70
commit 5ac91a2528
1 changed files with 13 additions and 0 deletions

View File

@ -21,6 +21,19 @@ $ cd server
$ npm install
```
In addition, the server requires a screen to be installed for the server
to be able to seed shared torrent files. This is because the headless
Electron instance used by WebTorrent expects one. This means that in order
to run the project on a server, you need to install a virtual screen
such as `xvfb` by running
```bash
sudo apt install xvfb
```
See [webtorrent-hybrid](https://github.com/webtorrent/webtorrent-hybrid) for
more information about this.
* Copy `config.example.js` as `config.js` and customize it for your scenario:
```bash