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.

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

[docs] Update HTTPS guide #5366

Merged
merged 5 commits into from Aug 4, 2020
Merged

Conversation

DIRECTcut
Copy link
Contributor

fixes #5358

@testcafe-build-bot
Copy link
Collaborator

✅ Tests for the commit eb7a275 have passed. See details.

@testcafe-build-bot
Copy link
Collaborator

✅ Tests for the commit cc53d27 have passed. See details.

@testcafe-build-bot
Copy link
Collaborator

✅ Tests for the commit 87c9c08 have passed. See details.

@testcafe-build-bot
Copy link
Collaborator

✅ Tests for the commit 3639175 have passed. See details.

@DIRECTcut DIRECTcut self-assigned this Jul 31, 2020
When you use the programming interface, pass the HTTPS server options to the [createTestCafe](../../reference/testcafe-api/global/createtestcafe.md) method.
### Use a Self-Signed Certificate

[Generate a self-signed certificate with `openssl`](#generate-a-certificate-from-the-command-line) if you launch tests from the command line. In the API, you can use the [openssl-self-signed-certificate](https://www.npmjs.com/package/openssl-self-signed-certificate) module to [generate a certificate in code](#generate-a-certificate-in-your-code).
Copy link
Collaborator

Choose a reason for hiding this comment

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

You already mention "In the API", why do you then add "in code"?

Copy link
Contributor Author

@DIRECTcut DIRECTcut Aug 3, 2020

Choose a reason for hiding this comment

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

I want the link text to be descriptive. Is it better if I say:

To generate a certificate in code, you can use the openssl-self-signed-certificate module

Copy link
Collaborator

Choose a reason for hiding this comment

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

To generate a certificate in code, use the openssl-self-signed-certificate module.


The examples below use a previously generated `.pfx` file to establish an HTTPS server.

In ***Chrome*** and ***Chromium-Based*** Browsers, use `--allow-insecure-localhost` flag and [`--hostname`](../../reference/command-line-interface.md#--hostname-name) CLI parameter to make Chrome trust the certificate when tests run on localhost. If you use a different URL, use `--ignore-certificate-errors` flag.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
In ***Chrome*** and ***Chromium-Based*** Browsers, use `--allow-insecure-localhost` flag and [`--hostname`](../../reference/command-line-interface.md#--hostname-name) CLI parameter to make Chrome trust the certificate when tests run on localhost. If you use a different URL, use `--ignore-certificate-errors` flag.
In ***Chrome*** and ***Chromium-Based*** Browsers, use the `--allow-insecure-localhost` flag and [`--hostname`](../../reference/command-line-interface.md#--hostname-name) CLI parameter to make Chrome trust the certificate when tests are run on localhost. If you use a different URL, use the `--ignore-certificate-errors` flag.

@DIRECTcut DIRECTcut added the AREA: docs An issue related to the product documentation. label Aug 3, 2020
When you use the programming interface, pass the HTTPS server options to the [createTestCafe](../../reference/testcafe-api/global/createtestcafe.md) method.
### Use a Self-Signed Certificate

[Generate a self-signed certificate with `openssl`](#generate-a-certificate-from-the-command-line) if you launch tests from the command line. In the API, you can use the [openssl-self-signed-certificate](https://www.npmjs.com/package/openssl-self-signed-certificate) module to [generate a certificate in code](#generate-a-certificate-in-your-code).
Copy link
Collaborator

Choose a reason for hiding this comment

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

To generate a certificate in code, use the openssl-self-signed-certificate module.

@testcafe-build-bot
Copy link
Collaborator

✅ Tests for the commit 83db31f have passed. See details.

@testcafe-build-bot
Copy link
Collaborator

✅ Tests for the commit 34b865c have passed. See details.

@DIRECTcut DIRECTcut merged commit 66e24a1 into DevExpress:master Aug 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
AREA: docs An issue related to the product documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] Rewrite TestCafe HTTPS guide
5 participants