Skip to content

docs: update readme to indicate the port binding #2486

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

Merged
merged 10 commits into from
Aug 30, 2024
10 changes: 9 additions & 1 deletion sonarqube/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,14 @@ To run a cluster with the Data Center Edition, please refer to Installing SonarQ

## Configuration

### Port binding

By default, the image will use port 9000
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps something like "By default, the server running within the container will listen on port 9000. You can expose the container port 9000 to the host port 9000 with the -p 9000:9000 argument to docker run:" would be more clear?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will update the text, like your suggestion.

I also will ajust the pull request like @tianon indicated.


```console
docker container run --name sonarqube-custom -p 9000:9000 sonarqube:10.6.0-community
```

### Database

By default, the image will use an embedded H2 database that is not suited for production.
Expand Down Expand Up @@ -131,7 +139,7 @@ For upgrade instructions, see Upgrading from the Docker Image on the [Upgrade th
In some environments, it may make more sense to prepare a custom image containing your configuration. A `Dockerfile` to achieve this may be as simple as:

```dockerfile
FROM sonarqube:8.9-community
FROM sonarqube:10.6.0-community
COPY sonar-custom-plugin-1.0.jar /opt/sonarqube/extensions/
```

Expand Down
Loading