Skip to content

docs: update port example #3391

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

Merged
merged 2 commits into from
Jun 7, 2021
Merged

docs: update port example #3391

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26296c9
docs: update `port` example
snitin315 Jun 6, 2021
a0ae9a8
docs: update `port` example
snitin315 Jun 6, 2021
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
45 changes: 39 additions & 6 deletions examples/cli/host-and-port/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,46 +3,79 @@
You may choose to wish to change the host and port on which `webpack-dev-server`
will run. The `host` and `port` options allow for that.

## IPv4
## host

### IPv4

```console
npx webpack serve --open-target --port 5000 --host 0.0.0.0
```

## IPv6
### IPv6

_This also works with IPv6_

```console
npx webpack serve --open-target --port 5000 --host ::
```

## local-ip
### local-ip

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.

```console
npx webpack serve --open-target --port 5000 --host local-ip
```

## local-ipv4
### local-ipv4

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

```console
npx webpack serve --open-target --port 5000 --host local-ipv4
```

## local-ipv6
### local-ipv6

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

```console
npx webpack serve --open-target --port 5000 --host local-ipv6
```

## What Should Happen
#### What Should Happen

1. The script should open `http://0.0.0.0:5000/` if specifying the IPv4 option,
or `http://[::]:5000/` for IPv6, in your default browser.
2. You should see the text on the page itself change to read `Success!`.

## port

### specific port

Tell the server to connect to a specific port with the following:

```console
npx webpack serve --open-target --port 9000
```

#### What Should Happen

1. The script should open `http://localhost:9000/` in your default browser.
2. You should see the text on the page itself change to read `Success!`.

### auto

Specifying `auto` as `port` will try to connect the server to the default port `8080` and if not available it will automatically search for another free port.

```console
npx webpack serve --open-target --port auto
```

#### What Should Happen

1. The script should open `http://localhost:8080/` in your default browser.
2. You should see the text on the page itself change to read `Success!`.
3. Keep the server open and switch to a new terminal window.
4. Run the script once again.
5. The script should open `http://localhost:8081/` (or any other port if it is not free) in your default browser.