Skip to content

Commit 3359732

Browse files
snitin315snitin315
authored
docs: add https example (#3307)
1 parent 4d251b5 commit 3359732

File tree

18 files changed

+140
-18
lines changed

18 files changed

+140
-18
lines changed

‎examples/cli/compression/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ It is enabled by default.
1010
To run this example, run this command in your console or terminal:
1111

1212
```console
13-
npm run webpack-dev-server -- --open --compress
13+
npm run webpack-dev-server -- --open-target --compress
1414
```
1515

1616
### What should happen

‎examples/cli/default/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
This example demonstrates how to use `webpack-dev-server`.
44

55
```console
6-
npm run webpack-dev-server -- --open
6+
npm run webpack-dev-server -- --open-target
77
```
88

99
To run your app using an alternative config, use:
1010

1111
```console
12-
npm run webpack-dev-server -- --open --config alternative.config.js
12+
npm run webpack-dev-server -- --open-target --config alternative.config.js
1313
```
1414

1515
## What Should Happen

‎examples/cli/history-api-fallback/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ support in `webpack-dev-server`, effectively asking the server to fallback to
55
`index.html` in the event that a requested resource cannot be found.
66

77
```shell
8-
npm run webpack-dev-server -- --open --history-api-fallback
8+
npm run webpack-dev-server -- --open-target --history-api-fallback
99
```
1010

1111
_Note: some URLs don't work by default. For example; if the url contains a dot.

‎examples/cli/hmr/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ application is running, without a full reload of the page.
66
To run this example, run this command in your console or terminal:
77

88
```console
9-
npm run webpack-dev-server -- --open --hot
9+
npm run webpack-dev-server -- --open-target --hot
1010
```
1111

1212
## What Should Happen

‎examples/cli/host-and-port/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,39 +6,39 @@ will run. The `host` and `port` options allow for that.
66
## IPv4
77

88
```console
9-
npm run webpack-dev-server -- --open --port 5000 --host 0.0.0.0
9+
npm run webpack-dev-server -- --open-target --port 5000 --host 0.0.0.0
1010
```
1111

1212
## IPv6
1313

1414
_This also works with IPv6_
1515

1616
```console
17-
npm run webpack-dev-server -- --open --port 5000 --host ::
17+
npm run webpack-dev-server -- --open-target --port 5000 --host ::
1818
```
1919

2020
## local-ip
2121

2222
Specifying `local-ip` as `host` will try to resolve the `host` option as your local `IPv4` address if available, if `IPv4` is not available it will try to resolve your local `IPv6` address.
2323

2424
```console
25-
npm run webpack-dev-server -- --open --port 5000 --host local-ip
25+
npm run webpack-dev-server -- --open-target --port 5000 --host local-ip
2626
```
2727

2828
## local-ipv4
2929

3030
Specifying `local-ipv4` as `host` will try to resolve the `host` option as your local `IPv4` address.
3131

3232
```console
33-
npm run webpack-dev-server -- --open --port 5000 --host local-ipv4
33+
npm run webpack-dev-server -- --open-target --port 5000 --host local-ipv4
3434
```
3535

3636
## local-ipv6
3737

3838
Specifying `local-ipv6` as `host` will try to resolve the `host` option as your local `IPv6` address.
3939

4040
```console
41-
npm run webpack-dev-server -- --open --port 5000 --host local-ipv6
41+
npm run webpack-dev-server -- --open-target --port 5000 --host local-ipv6
4242
```
4343

4444
## What Should Happen

‎examples/cli/https/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# CLI: https
2+
3+
You may choose to wish to run `webpack-dev-server` on `https`.
4+
5+
## https
6+
7+
Use HTTPS protocol.
8+
9+
```console
10+
npx webpack serve --open-target --https
11+
```
12+
13+
## https options
14+
15+
Customize `https` configuration with the following options:
16+
17+
- `--https-key`: Path to an SSL key.
18+
- `--https-pfx`: Path to an SSL pfx file.
19+
- `--https-cert`: Path to an SSL certificate.
20+
- `--https-cacert`: Path to an SSL CA certificate.
21+
- `--https-passphrase`: Passphrase for a pfx file.
22+
23+
```console
24+
npx webpack serve --open-target --https-key ./ssl/server.key --https-pfx ./ssl/server.pfx --https-cert ./ssl/server.crt --https-cacert ./ssl/ca.pem --https-passphrase webpack-dev-server
25+
```
26+
27+
## What Should Happen
28+
29+
1. The script should open `https://localhost:8080/` in your default browser.
30+
2. You should see the text on the page itself change to read `Success!`.

‎examples/cli/https/app.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
'use strict';
2+
3+
const target = document.querySelector('#target');
4+
5+
target.classList.add('pass');
6+
target.innerHTML = 'Success!';

‎examples/cli/https/ssl/ca.pem

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
-----BEGIN RSA PRIVATE KEY-----
2+
MIIEpQIBAAKCAQEAxAUVLFM+K3XDLQkBi7xt0s1Ip7JoHYDskzUDQNHjjMkUq5kv
3+
C/hf5Ei1J6qruJs3Xqg86Nl4+ed4ynUajAkRRibhp0P1SG1tgPssIK6iC7g8heYu
4+
Dy9WkFuMie0513zjSn6bMEAK5TegxYAWCbaCZX/Fw9bDniabL/zuOv4sf8J4EPhs
5+
EENnH6sUE9HxPUgQmNt1Tbd0j1Cd5PXrSTLyfVPRh0m9QhXTUHuxsse8XSn9U2sw
6+
duxJTWRINmhffYn+O7kbJGI77xYr8u58Rsf3HCMI8DTKZNvQLChvvtLJ9ckyu7Q+
7+
T8emgklStASm3V2UtnriaK/IQEhgSdxqVRib3QIDAQABAoIBAGqWKPE1QnT3T+3J
8+
G+ITz9P0dDFbvWltlTZmeSJh/s2q+WZloUNtBxdmwbqT/1QecnkyGgyzVCjvSKsu
9+
CgVjWNVAhysgtNtxRT4BVflffBXLVH2qsBjpsLRGU6EcMXuPGTiEp3YRHNuO6Aj8
10+
oP8fEsCGPc9DlJMGgxQRAKlrVF8TN/0j6Qk+YpS4MZ0YFQfBY+WdKu04Z8TVTplQ
11+
tTkiGpBI+Oj85jF59aQiizglJgADkAZ6zmbrctm/G9jPxh7JLS2cKI0ECZgK5yAc
12+
pk10E1YWhoCksjr9arxy6fS9TiX9P15vv06k+s7c4c5X7XDm3X0GWeSbqBMJb8q7
13+
BhZQNzECgYEA4kAtymDBvFYiZFq7+lzQBRKAI1RCq7YqxlieumH0PSkie2bba3dW
14+
NVdTi7at8+GDB9/cHUPKzg/skfJllek57MZmusiVwB/Lmp/IlW8YyGShdYZ7zQsV
15+
KMWJljpky3BEDM5sb08wIkfrOkelI/S4Bqqabd9JzOMJzoTiVOlMam8CgYEA3ctN
16+
yonWz2bsnCUstQvQCLdI5a8Q7GJvlH2awephxGXIKGUuRmyyop0AnRnIBEWtOQV7
17+
yZjW32bU+Wt+2BJ247EyJiIQ4gT+T51t+v/Wt1YNbL3dSj9ttOvwYd4H2W4E7EIO
18+
GKIF4I39FM7r8NfG7YE7S1aVcnrqs01N3nhd9HMCgYEAjepbzpmqbAxLPk97oase
19+
AFB+d6qetz5ozklAJwDSRprKukTmVR5hwMup5/UKX/OQURwl4WVojKCIb3NwLPxC
20+
DTbVsUuoQv6uo6qeEr3A+dHFRQa6GP9eolhl2Ql/t+wPg0jn01oEgzxBXCkceNVD
21+
qUrR2yE4FYBD4nqPzVsZR5kCgYEA1yTi7NkQeldIpZ6Z43T18753A/Xx4JsLyWqd
22+
uAT3mV9x7V1Yqg++qGbLtZjQoPRFt85N6ZxMsqA5b0iK3mXq1auJDdx1rAlT9z6q
23+
9JM/YNAkbZsvEVq9vIYxw31w98T1GYhpzBM+yDhzir+9tv5YhQKa1dXDWi1JhWwz
24+
YN45pWkCgYEAxuVsJ4D4Th5o050ppWpnxM/WuMhIUKqaoFTVucMKFzn+g24y9pv5
25+
miYdNYIk4Y+4pzHG6ZGZSHJcQ9BLui6H/nLQnqkgCb2lT5nfp7/GKdus7BdcjPGs
26+
fcV46yL7/X0m8nDb3hkwwrDTU4mKFkMrzKpjdZBsttEmW0Aw/3y36gU=
27+
-----END RSA PRIVATE KEY-----

‎examples/cli/https/ssl/server.crt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
-----BEGIN CERTIFICATE-----
2+
MIIDXTCCAkWgAwIBAgIJALz8gD/gAt0OMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV
3+
BAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBX
4+
aWRnaXRzIFB0eSBMdGQwHhcNMTgxMDIzMTgyMTQ5WhcNMTkxMDIzMTgyMTQ5WjBF
5+
MQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50
6+
ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB
7+
CgKCAQEAxAUVLFM+K3XDLQkBi7xt0s1Ip7JoHYDskzUDQNHjjMkUq5kvC/hf5Ei1
8+
J6qruJs3Xqg86Nl4+ed4ynUajAkRRibhp0P1SG1tgPssIK6iC7g8heYuDy9WkFuM
9+
ie0513zjSn6bMEAK5TegxYAWCbaCZX/Fw9bDniabL/zuOv4sf8J4EPhsEENnH6sU
10+
E9HxPUgQmNt1Tbd0j1Cd5PXrSTLyfVPRh0m9QhXTUHuxsse8XSn9U2swduxJTWRI
11+
NmhffYn+O7kbJGI77xYr8u58Rsf3HCMI8DTKZNvQLChvvtLJ9ckyu7Q+T8emgklS
12+
tASm3V2UtnriaK/IQEhgSdxqVRib3QIDAQABo1AwTjAdBgNVHQ4EFgQUDZBhVKdb
13+
3BRhLIhuuE522Vsul0IwHwYDVR0jBBgwFoAUDZBhVKdb3BRhLIhuuE522Vsul0Iw
14+
DAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEABh9WWZwWLgb9/DcTxL72
15+
6pI96t4jiF79Q+pPefkaIIi0mE6yodWrTAsBQu9I6bNRaEcCSoiXkP2bqskD/UGg
16+
LwUFgSrDOAA3UjdHw3QU5g2NocduG7mcFwA40TB98sOsxsUyYlzSyWzoiQWwPYwb
17+
hek1djuWkqPXsTjlj54PTPN/SjTFmo4p5Ip6nbRf2nOREl7v0rJpGbJvXiCMYyd+
18+
Zv+j4mRjCGo8ysMR2HjCUGkYReLAgKyyz3M7i8vevJhKslyOmy6Txn4F0nPVumaU
19+
DDIy4xXPW1STWfsmSYJfYW3wa0wk+pJQ3j2cTzkPQQ8gwpvM3U9DJl43uwb37v6I
20+
7Q==
21+
-----END CERTIFICATE-----

‎examples/cli/https/ssl/server.key

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
-----BEGIN PRIVATE KEY-----
2+
MIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDEBRUsUz4rdcMt
3+
CQGLvG3SzUinsmgdgOyTNQNA0eOMyRSrmS8L+F/kSLUnqqu4mzdeqDzo2Xj553jK
4+
dRqMCRFGJuGnQ/VIbW2A+ywgrqILuDyF5i4PL1aQW4yJ7TnXfONKfpswQArlN6DF
5+
gBYJtoJlf8XD1sOeJpsv/O46/ix/wngQ+GwQQ2cfqxQT0fE9SBCY23VNt3SPUJ3k
6+
9etJMvJ9U9GHSb1CFdNQe7Gyx7xdKf1TazB27ElNZEg2aF99if47uRskYjvvFivy
7+
7nxGx/ccIwjwNMpk29AsKG++0sn1yTK7tD5Px6aCSVK0BKbdXZS2euJor8hASGBJ
8+
3GpVGJvdAgMBAAECggEAapYo8TVCdPdP7ckb4hPP0/R0MVu9aW2VNmZ5ImH+zar5
9+
ZmWhQ20HF2bBupP/VB5yeTIaDLNUKO9Iqy4KBWNY1UCHKyC023FFPgFV+V98FctU
10+
faqwGOmwtEZToRwxe48ZOISndhEc247oCPyg/x8SwIY9z0OUkwaDFBEAqWtUXxM3
11+
/SPpCT5ilLgxnRgVB8Fj5Z0q7ThnxNVOmVC1OSIakEj46PzmMXn1pCKLOCUmAAOQ
12+
BnrOZuty2b8b2M/GHsktLZwojQQJmArnIBymTXQTVhaGgKSyOv1qvHLp9L1OJf0/
13+
Xm+/TqT6ztzhzlftcObdfQZZ5JuoEwlvyrsGFlA3MQKBgQDiQC3KYMG8ViJkWrv6
14+
XNAFEoAjVEKrtirGWJ66YfQ9KSJ7Zttrd1Y1V1OLtq3z4YMH39wdQ8rOD+yR8mWV
15+
6Tnsxma6yJXAH8uan8iVbxjIZKF1hnvNCxUoxYmWOmTLcEQMzmxvTzAiR+s6R6Uj
16+
9LgGqppt30nM4wnOhOJU6UxqbwKBgQDdy03KidbPZuycJSy1C9AIt0jlrxDsYm+U
17+
fZrB6mHEZcgoZS5GbLKinQCdGcgERa05BXvJmNbfZtT5a37YEnbjsTImIhDiBP5P
18+
nW36/9a3Vg1svd1KP2206/Bh3gfZbgTsQg4YogXgjf0Uzuvw18btgTtLVpVyeuqz
19+
TU3eeF30cwKBgQCN6lvOmapsDEs+T3uhqx4AUH53qp63PmjOSUAnANJGmsq6ROZV
20+
HmHAy6nn9Qpf85BRHCXhZWiMoIhvc3As/EINNtWxS6hC/q6jqp4SvcD50cVFBroY
21+
/16iWGXZCX+37A+DSOfTWgSDPEFcKRx41UOpStHbITgVgEPieo/NWxlHmQKBgQDX
22+
JOLs2RB6V0ilnpnjdPXzvncD9fHgmwvJap24BPeZX3HtXViqD76oZsu1mNCg9EW3
23+
zk3pnEyyoDlvSIreZerVq4kN3HWsCVP3Pqr0kz9g0CRtmy8RWr28hjHDfXD3xPUZ
24+
iGnMEz7IOHOKv722/liFAprV1cNaLUmFbDNg3jmlaQKBgQDG5WwngPhOHmjTnSml
25+
amfEz9a4yEhQqpqgVNW5wwoXOf6DbjL2m/maJh01giThj7inMcbpkZlIclxD0Eu6
26+
Lof+ctCeqSAJvaVPmd+nv8Yp26zsF1yM8ax9xXjrIvv9fSbycNveGTDCsNNTiYoW
27+
QyvMqmN1kGy20SZbQDD/fLfqBQ==
28+
-----END PRIVATE KEY-----

‎examples/cli/https/ssl/server.pfx

2.41 KB
Binary file not shown.

‎examples/cli/https/webpack.config.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
'use strict';
2+
3+
// our setup function adds behind-the-scenes bits to the config that all of our
4+
// examples need
5+
const { setup } = require('../../util');
6+
7+
module.exports = setup({
8+
context: __dirname,
9+
entry: './app.js',
10+
});

‎examples/cli/multi-compiler/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
`webpack-dev-server` should be able to compile multiple webpack configs.
44

55
```shell
6-
npm run webpack-dev-server -- --open
6+
npm run webpack-dev-server -- --open-target
77
```
88

99
## What Should Happen

‎examples/cli/node-false/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# CLI: Webpack `node` Option
22

33
```shell
4-
npm run webpack-dev-server -- --open
4+
npm run webpack-dev-server -- --open-target
55
```
66

77
## What should happen

‎examples/cli/overlay/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# CLI: --client-overlay option
22

33
```shell
4-
npm run webpack-dev-server -- --open --client-overlay
4+
npm run webpack-dev-server -- --open-target --client-overlay
55
```
66

77
## What Should Happen

‎examples/cli/progress/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# CLI: Progress Option
22

33
```shell
4-
npm run webpack-dev-server -- --open --client-progress
4+
npm run webpack-dev-server -- --open-target --client-progress
55
```
66

77
## What Should Happen

‎examples/cli/public/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# CLI: Public Option
22

33
```console
4-
npm run webpack-dev-server -- --open --host 0.0.0.0 --public <insert local ip>:8080
4+
npm run webpack-dev-server -- --open-target --host 0.0.0.0 --public <insert local ip>:8080
55
```
66

77
_NOTE: replace `<insert local ip>` with your local IP Address._

‎examples/cli/watch-static/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Watching a single directory
44

55
```console
6-
npm run webpack-dev-server -- --static assets --open
6+
npm run webpack-dev-server -- --static assets --open-target
77
```
88

99
### What Should Happen
@@ -26,13 +26,13 @@ module.exports = {
2626
```
2727

2828
```console
29-
npm run webpack-dev-server -- --open
29+
npm run webpack-dev-server -- --open-target
3030
```
3131

3232
or via CLI only:
3333

3434
```console
35-
npm run webpack-dev-server -- --static assets --static css --open
35+
npm run webpack-dev-server -- --static assets --static css --open-target
3636
```
3737

3838
### What Should Happen

0 commit comments

Comments
 (0)