diff --git a/Usage.md b/Usage.md index 8420383..e91622d 100644 --- a/Usage.md +++ b/Usage.md @@ -35,7 +35,13 @@ put your scripts `data/config/auto/scripts` and restart the container ### Extensions -You can use the UI to install extensions, or, you can put your extensions in `data/config/auto/extensions`, there is also the option to create a script `data/config/auto/startup.sh` which will be called on container startup, in case you want to install any additional dependencies for your extensions or anything else. +You can use the UI to install extensions, or, you can put your extensions in `data/config/auto/extensions`. + +There is also the option to create a script `data/config/auto/startup.sh` which will be called on container startup, in case you want to install any additional dependencies for your extensions or anything else. + +Different extensions require additional dependencies. Some of them might conflict with each other and changing versions of packages could break things. Use the `startup.sh` script to install and guarantee the needed dependencies (`pip`, `apt`, and any others). + +In case something goes wrong with some dependency (as it is usually the case, unfortunately) you can always comment section in `startup.sh` file, remove the extension, and do `docker compose --profile auto down` to clean up messy containers. When run again, you will have a fresh container. An example of your `startup.sh` might looks like this: @@ -46,11 +52,14 @@ list=(./extensions/*/requirements.txt) for req in "${list[@]}"; do pip install -q -r "$req" done -pip install -q --force-reinstall opencv-python-headless 'transformers>=4.24' +# opencv-python-headless to not rely on opengl and drivers. +pip install -q --force-reinstall opencv-python-headless ``` NOTE: dependencies of extensions might get lost when you create a new container, hence the installing them in the startup script is important. +It is not recommended to modify the Dockerfile for the sole purpose of supporting some extension (unless you truly know what you are doing). + ### **DONT OPEN AN ISSUE IF A SCRIPT OR AN EXTENSION IS NOT WORKING** I maintain neither the UI nor the extension, I can't help you.