From f7407a87c1c0b89b1bc2827ecba4b717a0efb545 Mon Sep 17 00:00:00 2001 From: Noah Levitt Date: Mon, 23 Jul 2018 23:32:56 +0000 Subject: [PATCH] reformat readme to 80 columns --- README.rst | 41 +++++++++++++++++++++++++++++++++-------- 1 file changed, 33 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 491f0b8..27d25e9 100644 --- a/README.rst +++ b/README.rst @@ -8,7 +8,13 @@ =============== "browser" \| "crawler" = "brozzler" -Brozzler is a distributed web crawler (爬虫) that uses a real browser (Chrome or Chromium) to fetch pages and embedded URLs and to extract links. It employs `youtube-dl `_ to enhance media capture capabilities, warcprox to write content to Web ARChive (WARC) files, `rethinkdb `_ to index captured URLs, a native dashboard for crawl job monitoring, and a customized Python Wayback interface for archival replay. +Brozzler is a distributed web crawler (爬虫) that uses a real browser (Chrome +or Chromium) to fetch pages and embedded URLs and to extract links. It employs +`youtube-dl `_ to enhance media capture +capabilities, warcprox to write content to Web ARChive (WARC) files, `rethinkdb +`_ to index captured URLs, a native +dashboard for crawl job monitoring, and a customized Python Wayback interface +for archival replay. Requirements ------------ @@ -17,12 +23,19 @@ Requirements - RethinkDB deployment - Chromium or Google Chrome >= version 64 -Note: The browser requires a graphical environment to run. When brozzler is run on a server, this may require deploying some additional infrastructure (typically X11; Xvfb does not support screenshots, however Xvnc4 from package vnc4server, does). The `vagrant configuration `_ in the brozzler repository (still a work in progress) has an example setup. +Note: The browser requires a graphical environment to run. When brozzler is run +on a server, this may require deploying some additional infrastructure +(typically X11; Xvfb does not support screenshots, however Xvnc4 from package +vnc4server, does). The `vagrant configuration `_ in the brozzler +repository (still a work in progress) has an example setup. Getting Started --------------- -The easiest way to get started with brozzler for web archiving is with ``brozzler-easy``. Brozzler-easy runs brozzler-worker, warcprox, brozzler wayback, and brozzler-dashboard, configured to work with each other in a single process. +The easiest way to get started with brozzler for web archiving is with +``brozzler-easy``. Brozzler-easy runs brozzler-worker, warcprox, brozzler +wayback, and brozzler-dashboard, configured to work with each other in a single +process. Mac instructions: @@ -45,7 +58,8 @@ Mac instructions: # start brozzler-easy brozzler-easy -At this point brozzler-easy will start archiving your site. Results will be immediately available for playback in pywb at http://localhost:8880/brozzler/. +At this point brozzler-easy will start archiving your site. Results will be +immediately available for playback in pywb at http://localhost:8880/brozzler/. *Brozzler-easy demonstrates the full brozzler archival crawling workflow, but does not take advantage of brozzler's distributed nature.* @@ -72,7 +86,9 @@ Submit sites not tied to a job:: Job Configuration ----------------- -Brozzler jobs are defined using YAML files. Options may be specified either at the top-level or on individual seeds. At least one seed URL must be specified, however everything else is optional. For details, see ``_. +Brozzler jobs are defined using YAML files. Options may be specified either at +the top-level or on individual seeds. At least one seed URL must be specified, +however everything else is optional. For details, see ``_. :: @@ -116,7 +132,9 @@ See ``brozzler-dashboard --help`` for configuration options. Brozzler Wayback ---------------- -Brozzler comes with a customized version of `pywb `_, which supports using the rethinkdb "captures" table (populated by warcprox) as its index. +Brozzler comes with a customized version of `pywb +`_, which supports using the rethinkdb +"captures" table (populated by warcprox) as its index. To use, first install dependencies. @@ -154,7 +172,10 @@ Then browse http://localhost:8880/brozzler/. Headless Chrome (experimental) -------------------------------- -`Headless Chromium `_ is now available in stable Chrome releases for 64-bit Linux and may be used to run the browser without a visible window or X11. +`Headless Chromium +`_ +is now available in stable Chrome releases for 64-bit Linux and may be used to +run the browser without a visible window or X11. To try this out, create a wrapper script like ~/bin/chrome-headless.sh: @@ -171,7 +192,11 @@ option: chmod +x ~/bin/chrome-headless.sh brozzler-worker --chrome-exe ~/bin/chrome-headless.sh -Beware: Chrome's headless mode is still very new and has `unresolved issues `_. Its use with brozzler has not yet been extensively tested. You may experience hangs or crashes with some types of content. For the moment we recommend using Chrome's regular mode instead. +Beware: Chrome's headless mode is still very new and has `unresolved issues +`_. +Its use with brozzler has not yet been extensively tested. You may experience +hangs or crashes with some types of content. For the moment we recommend using +Chrome's regular mode instead. License -------