|
1 | 1 | # Headless [](http://travis-ci.org/leonid-shevtsov/headless) |
2 | 2 |
|
3 | | -Headless is *the* Ruby interface for Xvfb. It allows you to create a headless display straight from Ruby code, hiding some low-level action. |
4 | | -It can also capture images and video from the virtual framebuffer. |
| 3 | +Headless is *the* Ruby interface for Xvfb. It allows you to create a headless display straight from Ruby code, hiding the low-level action. |
| 4 | +It can also capture images and video from the virtual framebuffer. For example, you can record screenshots and screencasts of your failing integration specs. |
5 | 5 |
|
6 | 6 | I created it so I can run Selenium tests in Cucumber without any shell scripting. Even more, you can go headless only when you run tests against Selenium. |
7 | 7 | Other possible uses include pdf generation with `wkhtmltopdf`, or screenshotting. |
8 | 8 |
|
9 | | -Documentation is available at [rdoc.info](http://rdoc.info/projects/leonid-shevtsov/headless) |
| 9 | +Documentation is available at [rubydoc.info](http://www.rubydoc.info/gems/headless) |
10 | 10 |
|
11 | 11 | [Changelog](https://github.com/leonid-shevtsov/headless/blob/master/CHANGELOG) |
12 | 12 |
|
@@ -159,15 +159,19 @@ To install the necessary libraries on ubuntu: |
159 | 159 | `import` - run `sudo apt-get install imagemagick` |
160 | 160 | `xwd` - run `sudo apt-get install X11-apps` and if you are going to use netpbm utilities for image conversion - `sudo apt-get install netpbm` |
161 | 161 |
|
162 | | -## Contributors |
| 162 | +## Troubleshooting |
163 | 163 |
|
164 | | -* [Igor Afonov](http://iafonov.github.com) - video and screenshot capturing functionality. |
| 164 | +### Display socket is taken but lock file is missing |
165 | 165 |
|
166 | | ---- |
| 166 | +This means that there is an X server that is taking up the chosen display number, but its lock file is missing. This is an exceptional situation. Please stop the server process manually (`pkill Xvfb`) and open an issue. |
| 167 | + |
| 168 | +### Video not recording |
167 | 169 |
|
168 | | -© 2011 Leonid Shevtsov, released under the MIT license |
| 170 | +If video is not recording, and there are no visible exceptions, try passing the following option to Headless to figure out the reason: `Headless.new(video: {log_file_path: STDERR})`. In particular, there are some issues with the version of avconv packaged with Ubuntu 12.04 - an outdated release, but still in use on Travis. |
169 | 171 |
|
170 | 172 |
|
| 173 | +##[Contributors](https://github.com/leonid-shevtsov/headless/graphs/contributors) |
171 | 174 |
|
172 | | -[](https://bitdeli.com/free "Bitdeli Badge") |
| 175 | +--- |
173 | 176 |
|
| 177 | +© 2011-2015 Leonid Shevtsov, released under the MIT license |
0 commit comments