Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Readme.md #1570

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Readme.md #1570

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Update Readme.md 
This includes some readme updates to help people dealing with some common porblems get started
  • Loading branch information
@wojons
wojons authored Sep 7, 2019
commit 4bc6e598497760b4a712a022a78d729f4a05b20b
33 changes: 33 additions & 0 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -906,6 +906,39 @@ Only logs

`DEBUG=nightmare:log*`

Debuging Electron (Parent Library for Nightmare)

`DEBUG=electron:*`

##### Debuging Nightmare inside of Docker/VM/headless

###### Virutal Screen (XVFB)
Docker and Headless VM do not have a montor which does not give nightmare/electron anywhere to draw the window

```bash
DEBUG=nightmare xvfb-run --server-args="-screen 0 1024x768x24" node cnn.js
```
https://github.com/segmentio/nightmare/issues/224
https://gist.github.com/lucasbrigida/f9d606a6888cbd1c7874a84607486c3e

###### ALAS Audio Dummy Sound Card
Headless deployments dont have a sound card so if the web page has audio it can cause errors. If you have electron debing enabled you will see `ALSA lib confmisc.c:767:(parse_card) cannot find card '0'`
```bash
docker run --device /dev/snd --group-add $(getent group audio | cut -d: -f3)
```
https://github.com/mviereck/x11docker/wiki/Container-sound:-ALSA-or-Pulseaudio
https://developpaper.com/question/how-to-make-alsa-play-available-in-docker/


###### Shared memory (SHM)
The default amount of shared memory for a docker container is 64MB. You can find the error with this output `nightmare electron child process exited with code null: undefined` You will need to have DEBUG from above enabled. Some other indications where freezing or very slow events/actions, blank screenshots. These are sometimes intermitate and sometimes thought to be resolved by smaller promise blocks but really a SHM issue. Raise the SHM until your happy.
```bash
docker run --shm-size=128m
```
https://bugs.chromium.org/p/chromium/issues/detail?id=522853
https://github.com/segmentio/nightmare/issues/224#issuecomment-267195843
https://github.com/segmentio/nightmare/issues/587

## Additional Resources

* [Ross Hinkley's Nightmare Examples](https://github.com/rosshinkley/nightmare-examples) is a great resource for setting up nightmare, learning about custom actions, and avoiding common pitfalls.
Expand Down