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

Jump to bottom

Adding precision on PANTHER_NO_HEADLESS behavior #639

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Adding precision on PANTHER_NO_HEADLESS behavior #639

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d7f70e4
Adding precision on PANTHER_NO_HEADLESS behavior
ktherage Sep 25, 2024
29d6e70
Update README.md
ktherage Sep 25, 2024
9b26444
Update README.md
ktherage Sep 25, 2024
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ Since Panther implements the API of popular libraries, it already has an extensi

The following environment variables can be set to change some Panther's behaviour:

* `PANTHER_NO_HEADLESS`: to disable the browser's headless mode (will display the testing window, useful to debug)
* `PANTHER_NO_HEADLESS`: if defined and true, then it disables Panther's default use of headless mode with a 1200x1100 window (and disable GPU for chrome)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is documenting internal details that might change (see eg #640) so I'm not sure about the benefit of stating this 🤔

Suggested change
* `PANTHER_NO_HEADLESS`: if defined and true, then it disables Panther's default use of headless mode with a 1200x1100 window (and disable GPU for chrome)
* `PANTHER_NO_HEADLESS`: set to `1` to disable Panther's use of headless mode and thus see what happens in a browser window

* `PANTHER_WEB_SERVER_DIR`: to change the project's document root (default to `./public/`, relative paths **must start** by `./`)
* `PANTHER_WEB_SERVER_PORT`: to change the web server's port (default to `9080`)
* `PANTHER_WEB_SERVER_ROUTER`: to use a web server router script which is run at the start of each HTTP request
Expand All @@ -382,12 +382,12 @@ $client = self::createPantherClient([
#### Chrome-specific Environment Variables

* `PANTHER_NO_SANDBOX`: to disable [Chrome's sandboxing](https://chromium.googlesource.com/chromium/src/+/b4730a0c2773d8f6728946013eb812c6d3975bec/docs/design/sandbox.md) (unsafe, but allows to use Panther in containers)
* `PANTHER_CHROME_ARGUMENTS`: to customize Chrome arguments. You need to set `PANTHER_NO_HEADLESS` to fully customize.
* `PANTHER_CHROME_ARGUMENTS`: to customize Chrome arguments. You need to set `PANTHER_NO_HEADLESS` to a true value to have full control of arguments.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(same below)

Suggested change
* `PANTHER_CHROME_ARGUMENTS`: to customize Chrome arguments. You need to set `PANTHER_NO_HEADLESS` to a true value to have full control of arguments.
* `PANTHER_CHROME_ARGUMENTS`: to customize Chrome arguments. You need to set `PANTHER_NO_HEADLESS` to `1` to have full control over arguments.

* `PANTHER_CHROME_BINARY`: to use another `google-chrome` binary

#### Firefox-specific Environment Variables

* `PANTHER_FIREFOX_ARGUMENTS`: to customize Firefox arguments. You need to set `PANTHER_NO_HEADLESS` to fully customize.
* `PANTHER_FIREFOX_ARGUMENTS`: to customize Firefox arguments. You need to set `PANTHER_NO_HEADLESS` to a true value to have full control of arguments.
* `PANTHER_FIREFOX_BINARY`: to use another `firefox` binary

### Accessing To Hidden Text
Expand Down
Loading