diff --git a/README.md b/README.md index 40ed87b..39771bd 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ **Table of Contents** - [Hayhooks](#hayhooks) + - [](#) - [Quick start](#quick-start) - [Install the package](#install-the-package) - [Check Hayhooks status](#check-hayhooks-status) @@ -148,6 +149,16 @@ $ docker buildx bake ... ``` +There are 2 special folders in the container you can override using a `mount`: +1. A folder containing pipeline definitions that will be automatically deployed when the container starts +2. A folder containing custom components that Haystack will be able to import if part of a pipeline + +For example, you can mount a local `./pipelines` folder containing pipelines you want to run at start-up like this: + +```console +$ docker run --rm -p 1416:1416 -v $PWD/pipelines:/opt/pipelines "deepset/hayhooks:main" +``` + ## Next steps At this stage Hayhooks is just a prototype, the natural next steps would be: