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 readme to indicate the port binding #2486

Merged
merged 10 commits into from
Aug 30, 2024

Conversation

felipementel
Copy link
Contributor

In order to make it easier for developers who want to run SonarQube in a container, I think it is worth indicating the port binding when running the docker run command.

Our exemple are using the tag 10.6.0-community

@andreracz
Copy link

Super useful information.

Copy link
Contributor

@whalelines whalelines left a comment

Choose a reason for hiding this comment

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

Minor suggestion

@@ -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.

@tianon
Copy link
Member

tianon commented Aug 29, 2024

A few notes:

  • this should be in content.md, not README.md (the latter is autogenerated, per the comment at the top of it)
  • it should use %%IMAGE%% for image references
  • 10.6.0 is a really specific image reference that should probably be somewhat relaxed (either 10.6 or 10)
  • cc sonarqube image maintainers: @carminevassallo @jCOTINEAU @davividal

@felipementel
Copy link
Contributor Author

felipementel commented Aug 30, 2024

@tianon, @whalelines and @alvdavi
Can you verify my updates?

@jCOTINEAU
Copy link
Contributor

all good on our side; thanks a lot for taking the time to improve our documentation.

sonarqube/content.md Outdated Show resolved Hide resolved
sonarqube/content.md Outdated Show resolved Hide resolved
sonarqube/content.md Outdated Show resolved Hide resolved
sonarqube/content.md Outdated Show resolved Hide resolved
sonarqube/content.md Outdated Show resolved Hide resolved
felipementel and others added 5 commits August 30, 2024 17:42
Co-authored-by: Tianon Gravi <[email protected]>
Co-authored-by: Tianon Gravi <[email protected]>
Co-authored-by: Tianon Gravi <[email protected]>
Co-authored-by: Tianon Gravi <[email protected]>
Co-authored-by: Tianon Gravi <[email protected]>
@tianon tianon merged commit f2cdd56 into docker-library:master Aug 30, 2024
6 checks passed
@felipementel
Copy link
Contributor Author

@tianon @jCOTINEAU @alvdavi

thank you so much!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants