From 5ac91a25281648f7ee3429d6d9a1fb69edd5470c Mon Sep 17 00:00:00 2001 From: Torjus Date: Tue, 31 Jul 2018 12:39:53 +0200 Subject: [PATCH] Explain headless electron requirement in README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 912f30c..45323b0 100644 --- a/README.md +++ b/README.md @@ -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