chromic_pdf

defmodule ChromicPDF do
  @moduledoc """
  ChromicPDF is a fast HTML-to-PDF/A renderer based on Chrome & Ghostscript.

  ## Usage

  ### Boot

  Start ChromicPDF as part of your supervision tree:

      def MyApp.Application do
        def start(_type, _args) do
          children = [
            # other apps...
            {ChromicPDF, chromic_pdf_opts()}
          ]

          Supervisor.start_link(children, strategy: :one_for_one, name: MyApp.Supervisor)
        end

        defp chromic_pdf_opts do
          []
        end
      end

  ### Print a PDF / PDF/A

  Please see `ChromicPDF.print_to_pdf/2` and `ChromicPDF.convert_to_pdfa/2`.

  ### Options

  ChromicPDF spawns two worker pools, the session pool and the ghostscript pool.  By default, it
  will create 5 workers with no overflow. To change these options, you may pass configuration to
  the supervisor.

  Please see https://github.com/devinus/poolboy for available options.

      defp chromic_pdf_opts do
        [
          session_pool: [
            size: 3,
            max_overflow: 0
          ],
          ghostscript_pool: [
            size: 10,
            max_overflow: 2
          ]
        ]
      end

  Please note, that these are only worker pools. If you intend to max them out, you will need a
  job queue as well.

  ## Security

  ### Chrome Sandbox

  By default, ChromicPDF will run Chrome in sandbox mode. If you absolutely must run Chrome as
  root, you can turn of its sandbox by passing the `no_sandbox: true` option.

      defp chromic_pdf_opts do
        [no_sandbox: true]
      end

  ### Running in online mode

  Browser targets spawned by ChromicPDF will be set to "offline" mode using the DevTools'
  `emulateNetworkConditions` command. This is intentional. Users are required to take an extra
  step (basically reading this paragraph) to re-consider whether basing their application's PDF
  printing on remote URL requests. Both because it can lead to unexpected performance
  fluctuation, as well as because it might increase the attack surface of their app.

  To switch on "online" mode, pass the `offline: false` parameter.

      defp chromic_pdf_opts do
        [offline: true]
      end

  ## How it works

  ### PDF Printing

  * ChromicPDF spawns an instance of Chromium/Chrome (an OS process) and connects to its
    "DevTools" channel via file descriptors.
  * The Chrome process is supervised and the connected processes will automatically recover if it
    crashes.
  * A number of "targets" in Chrome are spawned, 1 per worker process in the `SessionPool`. By
    default, ChromicPDF will spawn each session in a new browser context (i.e., a profile).
  * When a PDF print is requested, a session will instruct its assigned "target" to navigate to
    the given URL, then wait until it receives a "frameStoppedLoading" event, and proceed to call
    the `printToPDF` function.
  * The printed PDF will be sent to the session as Base64 encoded chunks.
  """

  use ChromicPDF.Supervisor
end