OLD | NEW |
(Empty) | |
| 1 # Headless Chromium |
| 2 |
| 3 Headless Chromium is a library for running Chromium in a headless/server |
| 4 environment. Expected use cases include loading web pages, extracting metadata |
| 5 (e.g., the DOM) and generating bitmaps from page contents -- using all the |
| 6 modern web platform features provided by Chromium and Blink. |
| 7 |
| 8 ## Headless shell |
| 9 |
| 10 The headless shell is a sample application which demonstrates the use of the |
| 11 headless API. To run it, first open the build configuration editor: |
| 12 |
| 13 ``` |
| 14 $ gn args out/Release |
| 15 ``` |
| 16 |
| 17 and enable headless mode with `is_headless = true`. |
| 18 |
| 19 Then build the shell: |
| 20 |
| 21 ``` |
| 22 $ ninja -C out/Release headless_shell |
| 23 ``` |
| 24 |
| 25 After the build completes, the headless shell can be run with the following |
| 26 command: |
| 27 |
| 28 ``` |
| 29 $ out/Release/headless_shell https://www.google.com |
| 30 ``` |
| 31 |
| 32 To attach a [DevTools](https://developer.chrome.com/devtools) debugger to the |
| 33 shell, start it with an argument specifying the debugging port: |
| 34 |
| 35 ``` |
| 36 $ out/Release/headless_shell --remote-debugging-port=1234 |
| 37 ``` |
| 38 |
| 39 Then navigate to `http://127.0.0.1:1234` with your browser. |
| 40 |
| 41 ## Embedder API |
| 42 |
| 43 The embedder API allows developers to integrate the headless library into their |
| 44 application. The API provides default implementations for low level adaptation |
| 45 points such as networking and the run loop. |
| 46 |
| 47 The main embedder API classes are: |
| 48 |
| 49 - `HeadlessBrowser::Options::Builder` - Defines the embedding options, e.g.: |
| 50 - `SetURLRequestContextGetter` - Allows custom network API integration. See |
| 51 `HeadlessNetwork::CreateURLRequestContextGetterUsingSocketFactory` for |
| 52 socket oriented APIs and |
| 53 `HeadlessNetwork::CreateURLRequestContextGetterUsingHttpTransactionFactory` |
| 54 for HTTP transaction oriented ones. |
| 55 - `SetMessagePump` - Replaces the default base message pump. See |
| 56 `base::MessagePump`. |
| 57 |
| 58 ## Headless API |
| 59 |
| 60 The headless API is used to drive the browser and interact with the loaded web |
| 61 pages. Its main classes are: |
| 62 |
| 63 - `HeadlessBrowser` - Represents the global headless browser instance. |
| 64 - `HeadlessWebContents` - Represents a single "tab" within the browser. |
OLD | NEW |