Skip to content

Verify all ports are free #983

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

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

Verify all ports are free #983

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
10 changes: 10 additions & 0 deletions docs/workshops/advanced/bootstrap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,16 @@ COMPOSE_PROFILES=lso docker compose up
This will also enable LSO, so network devices will be actually configured. If you don't want this, just use:

### Local environment

The environment requires several ports to be free.
Use `ss` to check if any are in use—no output means they're available:

```
ss -tulnp|grep -E ':80|:3000|:4000|:5432|:5678|:8000|:8001|:8080'
```
Comment on lines +94 to +99
Copy link
Contributor

Choose a reason for hiding this comment

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

What is ss? It doesn't seem to be a default tool on macos, ubuntu or alpine.

It is a good idea to inform people to check that the ports are free, but the actual numbers written out here are bound to go stale over time. What do you think about rephrasing this to something along the lines off "Make sure you aren't running any software on the ports required by docker-compose.yml" ?

Copy link
Author

Choose a reason for hiding this comment

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

ss is one of the tools in https://en.wikipedia.org/wiki/Iproute2. I reasoned that's a pretty standard tool. I couldn't find something similar that's available on both macos and ubuntu. Anything older you'd prefer, like netstat or lsof maybe?

I thought about including the script mentioned in the commit message, but for an onboarding tutorial, a bit too verbose, although then always current.
I'll apply your rephrase if we can settle on a tool.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, didn't know netstat was considered legacy :) I typically use netstat on OSX, but fine to keep ss in this text, maybe with a link to that iproute2 page


Start the containers:

```
docker compose up -d
```
Expand Down