From eaa62176339aca5c653990331a0d47d7aced37a9 Mon Sep 17 00:00:00 2001 From: Scott Howe Date: Tue, 15 Oct 2024 10:01:47 -0500 Subject: [PATCH] doc: fix docker doc command variable name --- docs/DOCKER.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/DOCKER.md b/docs/DOCKER.md index ed7d129..ae06ae6 100644 --- a/docs/DOCKER.md +++ b/docs/DOCKER.md @@ -17,7 +17,7 @@ If desired, the user can add `:vX.X.X` to the end of the command to obtain an ol To enable the webui launching during cfm-service startup, the user must provide the `-webui` flag in the command below. ```bash -docker run --restart unless-stopped --network=host --name --detach ghcr.io/seagate/cfm -webui -verbosity 4 +docker run --restart unless-stopped --network=host --name --detach ghcr.io/seagate/cfm -webui -verbosity 4 ``` By default, the cfm-service will be hosted at port 8080 and the webui will be hosted at port 3000. The user could change the port by input argument -Port and/or -webuiPort. The webui only works with --network=host mode. @@ -27,13 +27,13 @@ By default, the cfm-service will be hosted at port 8080 and the webui will be ho The cfm-service runtime logs can be viewed using ```bash -docker logs --follow +docker logs --follow ``` ## Stop and restart cfm-service ```bash -docker restart +docker restart ``` ## Excute CLI tool @@ -41,7 +41,7 @@ docker restart The user can interact with the running cfm docker container (running cfm-service) to utilize the cli tool. ```bash -docker exec -it ./cfm-cli +docker exec -it ./cfm-cli ``` NOTE: cfm-cli \ usage examples: @@ -53,8 +53,15 @@ docker exec -it cfm-container ./cfm-cli list appliances ## Customization -The developer could use the [DockerFile](../docker/Dockerfile) as a reference to build a new docker image with local changes +The developer could use the [DockerFile](../docker/Dockerfile) as a reference to build a new docker image using a local [cfm](https://github.com/Seagate/cfm) clone... ```bash -docker build --no-cache -t -f docker/Dockerfile . +cd /path/to/local/cfm +docker build --no-cache -t -f docker/Dockerfile . +``` + +...and then run those changes + +```bash +docker run --restart unless-stopped --network=host --name --detach -webui -verbosity 4 ```