From aec7a8c583c8228e9538c923d39ef80862bafdde Mon Sep 17 00:00:00 2001 From: Lars-Dominik Braun Date: Fri, 7 Dec 2018 18:04:22 +0100 Subject: README: Add note about browser config/fonts --- README.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 459f201..c604d81 100644 --- a/README.rst +++ b/README.rst @@ -168,6 +168,33 @@ s r Revoke or abort running job with +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 +console. + +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/devtools.py +.. _Corefonts: http://corefonts.sourceforge.net/ +.. _DejaVu: https://dejavu-fonts.github.io/ +.. _Liberation: https://pagure.io/liberation-fonts + Related projects ---------------- -- cgit v1.2.3