path: root/README.rst
diff options
authorLars-Dominik Braun <>2018-12-07 18:04:22 +0100
committerLars-Dominik Braun <>2018-12-07 18:04:22 +0100
commitaec7a8c583c8228e9538c923d39ef80862bafdde (patch)
tree6ee62fabcc8765eca1933412c08fd693c159184a /README.rst
parent57afd5ccf82f08ab19de4f9ee49ea0a5d34e41a1 (diff)
README: Add note about browser config/fonts
Diffstat (limited to 'README.rst')
1 files changed, 27 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 459f201..c604d81 100644
--- a/README.rst
+++ b/README.rst
@@ -168,6 +168,33 @@ s <uuid>
r <uuid>
Revoke or abort running job with <uuid>
+Browser configuration
+Generally crocoite provides reasonable defaults for Google Chrome via its
+`devtools module`_. When debugging this software it might be necessary to open
+a non-headless instance of the browser by running
+.. code:: bash
+ google-chrome-stable --remote-debugging-port=9222 --auto-open-devtools-for-tabs
+and then passing the option ``--browser=http://localhost:9222`` to
+``crocoite-grab``. This allows human intervention through the browser’s builtin
+Another issue that might arise is related to fonts. Headless servers usually
+don’t have them installed by default and thus rendered screenshots may contain
+replacement characters (□) instead of the actual text. This affects mostly
+non-latin character sets. It is therefore recommended to install at least
+Micrsoft’s Corefonts_ as well as DejaVu_, Liberation_ or a similar font family
+covering a wide range of character sets.
+.. _devtools module: crocoite/
+.. _Corefonts:
+.. _DejaVu:
+.. _Liberation:
Related projects