From eebbc1d2793a3b155098bb1631d8683c80974410 Mon Sep 17 00:00:00 2001 From: Karl-Rainer Blumenthal Date: Thu, 28 Jun 2018 12:59:22 -0400 Subject: [PATCH] Copy edits --- readme.rst | 44 ++++++++++---------------------------------- 1 file changed, 10 insertions(+), 34 deletions(-) diff --git a/readme.rst b/readme.rst index 6aeb5e9..9496508 100644 --- a/readme.rst +++ b/readme.rst @@ -8,14 +8,7 @@ =============== "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 also -uses `youtube-dl `_ to enhance media -capture capabilities. - -Brozzler is designed to work in conjunction with -`warcprox `_ for web -archiving. +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 ------------ @@ -24,20 +17,12 @@ Requirements - RethinkDB deployment - Chromium or Google Chrome >= version 64 -Worth noting is that the browser requires a graphical environment to run. You -already have this on your laptop, but on a server it will probably require -deploying some additional infrastructure (typically X11; note that Xvfb does -not support screenshots; 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, -`pywb `_, 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: @@ -60,8 +45,7 @@ Mac instructions: # start brozzler-easy brozzler-easy -At this point brozzler-easy will start brozzling 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.* @@ -88,9 +72,7 @@ Submit sites not tied to a job:: Job Configuration ----------------- -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, -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 ``_. :: @@ -127,14 +109,14 @@ To start the app, run brozzler-dashboard +At this point Brozzler Dashboard will be accessible at http://localhost:8000/. + 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. @@ -172,9 +154,7 @@ 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 at all. +`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: @@ -191,11 +171,7 @@ 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 a number of -`unresolved issues. `_ -You may experience hangs or crashes with some types of content. Brozzler -has not had much testing with it. 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 -------