From 266a3548958e01dbbafcf62ea866a108e1e5d1cf Mon Sep 17 00:00:00 2001 From: mrguymiah Date: Tue, 2 Apr 2024 21:21:46 -0400 Subject: [PATCH] Update readme.md Added a note for Docker environments that utilize their own templating system instead of the docker-compose.yaml file. --- docker/readme.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docker/readme.md b/docker/readme.md index eb5f31e..2284945 100644 --- a/docker/readme.md +++ b/docker/readme.md @@ -5,6 +5,8 @@ *This is assuming you have docker and docker compose installed and running.* 1. Open a terminal and set your current directory to the "docker" directory in your clone of this repo. -2. Adjust the "docker-compose.yml" file to match your needs. The default selection and the selection with all modules are provided as examples. -3. Once ready, run the command "docker compose build" to build the "cohee1207/sillytavern-extras" docker image. +2. Adjust the "docker-compose.yml" file to match your needs. Please see the in file comments for additional information on how to prepare your file. +3. Once ready, run the command "docker-compose build" to build the "cohee1207/sillytavern-extras" docker image. + +If you are running the docker in an environment where you do not utilize the docker-compose.yml file (IE: Windows Docker or Unraid), then you will need to specify enabled modules as an "Extra Parameter". Any flags, including the required "--enable-modules=" flag, will need to be put there.