Skip to content

Commit b4b5c83

Browse files
261 - update README with note on folder creation (#262)
1 parent 145ed6c commit b4b5c83

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,8 @@ Explanation:
158158
* `-v /path/to/job_json_files:/job_json_files`: Mounts a local folder containing your OTel data in JSON format to the Docker container's /job_json_files directory. Note `/job_json_files` should then be added to the `dirpath` field in the `config.yaml` file.
159159
* `-v /path/to/config.yaml:/config.yaml`: Mounts the configuration file for `otel2puml` to the Docker container's /config.yaml.
160160
* `-v /path/to/puml_output:/puml_output`: Mounts a local folder where the output PlantUML diagrams will be saved.
161+
162+
**NOTE**: If this folder does not exist, docker will likely create it with root permissions and an error will occur when saving output files. Ensure the folder exists before running the command.
161163
* `ghcr.io/xtuml/otel2puml`:latest: Specifies the Docker image to run.
162164
* `-o /puml_output`: Tells `otel2puml` where to save the generated PlantUML files inside the container (linked to the local `puml_output` folder).
163165
* `otel2puml -c /config.yaml`: Runs the `otel2puml` command using the provided configuration file.

0 commit comments

Comments
 (0)