From 0d8c4d7e8dfe4d31a20bf4eac4bbb2591505a09b Mon Sep 17 00:00:00 2001 From: HandcraftedBits Date: Fri, 3 Mar 2017 16:35:21 -0500 Subject: [PATCH] Add notes about logging and headless usage. --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index de4ef07..36c608c 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,25 @@ Where `` is the directory where screenshots will be saved and ` incoming connections. If not specified, `` will default to `%TEMP%\__netshot` on Windows (or `/tmp/__netshot` on all other platforms) and `` will default to `8000`. +### Headless Usage + +When running netshot in a headless manner, you must also create a virtual framebuffer for Electroshot. The recommended +way to do this is to start netshot with `xvfb-run`: + +```bash +xvfb-run --server-args "-screen 0 1920x1080x24" netshot +``` + +### Logging + +Netshot uses [Bunyan](https://github.com/trentm/node-bunyan) for logging. It is recommended that you +[install Bunyan](https://github.com/trentm/node-bunyan#installation) and pipe netshot through it for pretty logging +output: + +```bash +netshot | bunyan +``` + # REST API * [Retrieve a listing of all screenshots: `GET /`](#get-)