Skip to content

fix(docs): update README for running iggy-server with defaults - #2277

Merged
numinnex merged 1 commit into
apache:masterfrom
varunu28:iggy-server-readme-patch
Oct 17, 2025
Merged

numinnex merged 1 commit into
apache:masterfrom
varunu28:iggy-server-readme-patch

Conversation

@varunu28

Copy link
Copy Markdown
Contributor

Running iggy-server as per the current README.md leads to following error while passing with-default-root-credentials.

cargo run --bin iggy-server --with-default-root-credentials
error: unexpected argument '--with-default-root-credentials' found

  tip: a similar argument exists: '--no-default-features'
  tip: to pass '--with-default-root-credentials' as a value, use '-- --with-default-root-credentials'

Usage: cargo run --bin [<NAME>] --no-default-features [ARGS]...

For more information, try '--help'.
Screenshot 2025-10-17 at 8 55 45 AM

This PR fixes the command in README.md

@hubcio

hubcio commented Oct 17, 2025

Copy link
Copy Markdown
Contributor

Good catch, thanks for PR.

@numinnex numinnex changed the title Fix README for running iggy-server with defaults fix(docs): update README for running iggy-server with defaults Oct 17, 2025
@varunu28

Copy link
Copy Markdown
Contributor Author

@numinnex Thanks for fixing the PR title. Is there a way I can re-trigger the failed actions or does it needs an empty commit to trigger the pipeline?

@numinnex

Copy link
Copy Markdown
Contributor

I've triggered it again, lets see.

@numinnex
numinnex merged commit f7390ae into apache:master Oct 17, 2025
39 of 42 checks passed
hageshiame pushed a commit to hageshiame/iggy that referenced this pull request Nov 7, 2025
…e#2277)

Running `iggy-server` as per the current README.md leads to following
error while passing `with-default-root-credentials`.
```
cargo run --bin iggy-server --with-default-root-credentials
error: unexpected argument '--with-default-root-credentials' found

  tip: a similar argument exists: '--no-default-features'
  tip: to pass '--with-default-root-credentials' as a value, use '-- --with-default-root-credentials'

Usage: cargo run --bin [<NAME>] --no-default-features [ARGS]...

For more information, try '--help'.
```
<img width="951" height="123" alt="Screenshot 2025-10-17 at 8 55 45 AM"
src="https://github.com/user-attachments/assets/8e9d0cd8-4887-40e5-ba27-48c40fafe9bd"
/>

This PR fixes the command in README.md
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.

3 participants