Skip to content

Commit

Permalink
chore: update docs and aliases
Browse files Browse the repository at this point in the history
  • Loading branch information
krzko committed May 28, 2023
1 parent f68eef5 commit 478c728
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@ Replace `<registry-url>` with the URL of your desired Docker Registry.

To further enhance your setup, you can also utilise the `--external-network` flag, which enables integration of your own docker-compose configurations with run-o11y-run. This allows you to combine the services of run-o11y-run with your existing infrastructure seamlessly.

For more details on using the `--external-network` flag, refer to the [External Network Guide](docs/external-network.md).

To start run-o11y-run in `detached` mode, use the `--detach` flag. This will start the containers in the background.

For more details on using the `--external-network` flag, refer to the [External Network](docs/external-network.md) guide.

### Stop Command

The `stop` command is used to gracefully stop the run-o11y-run containers. It ensures a clean shutdown of your observability stack. Here's an example of using the `stop` command:
Expand Down
4 changes: 2 additions & 2 deletions internal/cli/start.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ func genStartCommand() *cli.Command {
},
&cli.BoolFlag{
Name: "detach",
Aliases: []string{"detached"},
Usage: "deatched mode",
Aliases: []string{"d", "detached"},
Usage: "detached mode, to run containers in the background",
Value: false,
},
&cli.BoolFlag{
Expand Down

0 comments on commit 478c728

Please sign in to comment.