README.rst

   1 ************************************
   2 phancap - website screenshot service
   3 ************************************
   4
   5 Software to create screenshots and thumbnails of websites via an API.
   6
   7 Self-hosted and written in PHP. Caching included.
   8
   9
  10 =======================
  11 Technical brainstorming
  12 =======================
  13
  14 Tools to make website screenshots
  15 =================================
  16 - `cutycapt <http://cutycapt.sourceforge.net/>`_
  17 - `khtml2png <http://khtml2png.sourceforge.net/>`_ (outdated)
  18 - `phantomjs <http://phantomjs.org/>`_
  19 - `python-webkit2png <https://github.com/AdamN/python-webkit2png/>`_
  20 - `wkhtmltopdf <http://code.google.com/p/wkhtmltopdf/>`_
  21 - wkhtmltoimage
  22
  23
  24 Possible parameters
  25 ===================
  26
  27 Page request parameters
  28 -----------------------
  29 - url
  30 - bwidth (browser width / resolution)
  31 - bheight (browser height / resolution)
  32 - delay (capture X seconds after page loaded)
  33 - useragent (user agent header string)
  34 - accepted languages (Accept-Language header)
  35 - cookie (set cookie data)
  36 - referer (custom referer header)
  37 - post data (send POST data as if filled out a form)
  38
  39 Screenshot configuration
  40 ------------------------
  41 - width (of thumbnail)
  42 - height (of thumbnail)
  43 - output format (jpg, png, pdf)
  44 - mode: screen or page (full page height or screen size only)
  45   - page aka fullpage
  46 - quality (jpeg image quality)
  47
  48 Misc
  49 ----
  50 - callback URL (to notify when screenshot is ready)
  51 - sync/async (wait for response or just get a 202 accepted)
  52 - cache (to force a fresh screenshot with cache=0,
  53   otherwise seconds the cache may be old)
  54 - api key
  55 - token (md5 hash of query string)
  56
  57 API parameter sources
  58 ---------------------
  59 - http://api1.thumbalizr.com/
  60 - http://url2png.com/docs/
  61 - http://webthumb.bluga.net/apidoc
  62 - http://www.page2images.com/Create-website-screenshot-online-API
  63 - http://browshot.com/api/documentation
  64
  65
  66 Other website screenshot services
  67 =================================
  68 - http://browsershots.org/
  69 - http://browshot.com/
  70 - http://ctrlq.org/screenshots/
  71 - http://grabz.it/
  72 - http://url2png.com/
  73 - http://usersnap.com/
  74 - http://websnapr.com/
  75 - http://webthumb.bluga.net/
  76 - http://www.page2images.com/
  77 - http://www.shrinktheweb.com/
  78 - http://www.thumbalizr.com/
  79 - http://www.url2picture.com/
  80
  81
  82 Other website screenshot software
  83 =================================
  84 - https://github.com/microweber/screen