This is an automated email from the ASF dual-hosted git repository.
gkoszyk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iggy.git
The following commit(s) were added to refs/heads/master by this push:
new f7390aea4 fix(docs): update README for running iggy-server with
defaults (#2277)
f7390aea4 is described below
commit f7390aea41f9b2569ca44c21041644106c69f89d
Author: Varun Upadhyay <[email protected]>
AuthorDate: Fri Oct 17 09:56:17 2025 -0700
fix(docs): update README for running iggy-server with defaults (#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
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index d2d131974..7dfeddf45 100644
--- a/README.md
+++ b/README.md
@@ -239,7 +239,7 @@ One can use default root credentials with optional
`--with-default-root-credenti
This flag is equivalent to setting `IGGY_ROOT_USERNAME=iggy` and
`IGGY_ROOT_PASSWORD=iggy`, plus
it should only be used for development and testing.
-`cargo run --bin iggy-server --with-default-root-credentials`
+`cargo run --bin iggy-server -- --with-default-root-credentials`
For configuration options and detailed help:
