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

feat: Document new -d/--dev command-line flag #1040

Merged
merged 1 commit into from
Apr 26, 2023
Merged
Changes from all commits
Commits
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
14 changes: 13 additions & 1 deletion docs_src/microservices/configuration/CommonCommandLineOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,21 @@ Can be overridden with [EDGEX_USE_REGISTRY](./CommonEnvironmentVariables.md#edge

Overwrite configuration in provider with local configuration.

!!! cation "Use with cation"
!!! caution "Use with cation"
This will clobber existing settings in provider, problematic if those settings were edited by hand intentionally. Typically only used during development.

## Developer Mode

!!! edgey "EdgeX 3.0"
New in EdgeX 3.0

`-d/--dev`

Indicates service should run in developer mode. The allows the service running from command-line to properly communicate with other EdgeX services running in Docker (aka hybrid mode). This flag cause all `Host` configuration values pulled from common configuration via the Configuration Provider to be overridden with the value "localhost".

!!! caution "Development Only"
This flag should only be used for development purposes when running from command-line.

## Help

`-h/--help`
Expand Down