From 01960773a11fe539c286d816a2bc04c0dbc6d3f1 Mon Sep 17 00:00:00 2001
From: mrguymiah <donutmr@hotmail.com>
Date: Tue, 2 Apr 2024 21:09:41 -0400
Subject: [PATCH] Update docker-compose.yml

Added additional documentation for requirements, the different options, how to format the requirements, removed the MODULES argument, added commented lines for additional volume for the RVC module (Known to still be missing some. Experimentation required.), change the final "command" to "entrypoint" and add documentation.
---
 docker/docker-compose.yml | 31 +++++++++++++++++++++++++------
 1 file changed, 25 insertions(+), 6 deletions(-)

diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml
index d6db604..7900540 100644
--- a/docker/docker-compose.yml
+++ b/docker/docker-compose.yml
@@ -17,16 +17,35 @@ services:
       dockerfile: docker/Dockerfile
       args:
         REQUIREMENTS: requirements.txt
-        MODULES: caption,summarize,classify
-#        REQUIREMENTS: "requirements.txt -r requirements-rvc.txt"
-#        MODULES: caption,summarize,classify,rvc
+#       Possible Values:
+#         requirements.txt         - Use when running on Nvidia
+#         requirements-rocm.txt    - Use when running on AMD
+#         requirements-silicon.txt - Use for Apple M1 or M2 chipset.
+#
+#       Add-on Instructions: 
+#         Append the above with " -r " as separator and surround with quotes. 
+#         Example: REQUIREMENTS: "requirements.txt -r requirements-rvc.txt"
+#
+#       Possible Add-ons: 
+#         requirements-coqui.txt   - Required to run the COQUI TTS Module
+#         requirements-rvc.txt     - Required to run the Real-time Voice Cloning module
+#
     volumes:
-      #- "./chromadb:/chromadb"
       - "./cache:/root/.cache"
       - "../api_key.txt:/sillytavern-extras/api_key.txt:rw"
+#     Options Module Volumes - Uncomment the lines for your desired modules before building.
+#
+#     ChromaDB - Utilized by ChromaDB.
+#     - "./chromadb:/chromadb"
+#
+#     Real-time Voice CLoning 
+#     - "./models/rvc:/data/models/rvc"
+#     
     ports:
       - "5100:5100"
     environment:
       - NVIDIA_VISIBLE_DEVICES=all
-    command: python server.py --enable-modules=caption,summarize,classify
-#    command: python server.py --enable-modules=caption,summarize,classify,rvc
+    entrypoint: ["python", "server.py", "--enable-modules=caption,summarize,classify"]
+#   
+#   For a list of possible modules, refer to the "Modules" section on the project's main page.
+#   NOTE - Separate additional modules by commas in the "--enable-modules" list. DO NOT separate them with spaces.