Upload README.md

README.md

@@ -1,69 +1,64 @@
 ---
-title: SillyTavern (via Dockerfile)
-emoji: 🐳
+title: SillyTavern (Git Deploy) with Dynamic Plugins
+emoji: 🚀
 colorFrom: blue
-colorTo: green
+colorTo: purple
 sdk: docker
 pinned: false
 app_port: 8000 # SillyTavern default port
-# Runtime secret for config.yaml
+# Add secrets
 secrets:
   - name: CONFIG_YAML
     description: "Contents of your config.yaml file"
-    required: true
-# Build argument for plugins
-# Note: How to set build args might vary in HF UI.
-# Look for 'Build variables' or similar in Space settings.
-build:
-  args:
-    PLUGINS: "https://github.com/fuwei99/data-sync.git,https://github.com/fuwei99/plugin-manager.git" # Example default plugins
+    required: true # Keep config required
+  - name: PLUGINS
+    description: "Comma-separated list of Git URLs for plugins to install"
+    required: false # Make plugins optional
 ---
 
-# SillyTavern Docker Deployment for Hugging Face Spaces
+# SillyTavern with Dynamic Plugins (Git Deployment)
 
-This Space runs SillyTavern using a custom `Dockerfile`. It clones the SillyTavern `staging` branch and allows dynamic installation of plugins during the build process.
+This Space runs SillyTavern by cloning the core repository directly from GitHub and dynamically installing plugins specified via Hugging Face Secrets.
 
-## Key Features
-
-*   Clones SillyTavern directly from GitHub (`staging` branch).
-*   Dynamically installs plugins specified via a build argument.
-*   Uses a runtime secret (`CONFIG_YAML`) to configure SillyTavern, keeping your configuration private.
+**IMPORTANT:** This setup requires you to provide your `config.yaml` content as a Hugging Face Secret named `CONFIG_YAML`. Optionally, you can specify plugins to install via a secret named `PLUGINS`.
 
 ## Setup and Deployment Steps
 
-1.  **Fork or Create Space:**
-    *   Create a new Hugging Face Space, selecting "Docker" as the SDK.
-    *   Alternatively, fork this repository.
+1.  **Prepare `config.yaml`:**
+    *   Ensure you have a valid `config.yaml` file for SillyTavern.
+    *   **Remove any comments** from the file, as they might interfere with environment variable parsing.
 
-2.  **Add Files:**
-    *   Ensure the `Dockerfile` from this repository is present in the root of your Space.
-    *   This `README.md` provides basic instructions.
+2.  **Upload Files to Hugging Face:**
+    *   Clone your Hugging Face Space repository locally or use the web UI.
+    *   Add/replace the following files in the root of your Space repository:
+        *   This `README.md` file.
+        *   The `Dockerfile` provided in our conversation.
+    *   Commit and push the changes. **You no longer need to upload `sillytavern.zip`.**
 
-3.  **Configure `CONFIG_YAML` Secret:**
+3.  **Configure Secrets:**
     *   Go to your Space's **Settings** tab on Hugging Face.
     *   Navigate to the **Secrets** section.
-    *   Click **New secret**.
-    *   Enter the name exactly as `CONFIG_YAML`.
-    *   Paste the **entire content** of your desired `config.yaml` file into the **Secret value** field. **Do not include comments in the YAML content.** (See Dockerfile `ENTRYPOINT` for how this is used).
-    *   Save the secret.
-
-4.  **(Optional) Configure `PLUGINS` Build Argument:**
-    *   This `Dockerfile` uses a build argument named `PLUGINS` to specify which plugins to install.
-    *   **How to set Build Arguments in Hugging Face Spaces:** The exact method might change, but look in your Space **Settings** for sections like "Build variables", "Docker build arguments", or similar configuration options related to the Docker build process.
-    *   You need to set the build argument `PLUGINS`.
-    *   The **value** should be a comma-separated list of the Git URLs for the plugins you want to install. Example:
-        ```
-        https://github.com/user1/plugin-a.git,https://github.com/user2/plugin-b.git
-        ```
-    *   **Default:** If you don't set this build argument, the default specified in the `README.md` header metadata (`build.args.PLUGINS`) might be used, or it might default to empty depending on Hugging Face's handling. Check the Dockerfile `ARG PLUGINS=""` line for the ultimate default if none is provided elsewhere.
+    *   **Add `CONFIG_YAML` Secret:**
+        *   Click **New secret**.
+        *   Enter the name exactly as `CONFIG_YAML`.
+        *   Paste the **entire content** of your prepared (comment-free) `config.yaml` file into the **Secret value** field.
+        *   Save the secret.
+    *   **(Optional) Add `PLUGINS` Secret:**
+        *   Click **New secret** again.
+        *   Enter the name exactly as `PLUGINS`.
+        *   Paste a **comma-separated list** of the Git URLs for the plugins you want to install into the **Secret value** field. **Ensure there are no spaces around the commas.** Example:
+          ```
+          https://github.com/fuwei99/plugin-manager.git,https://github.com/fuwei99/cloud-saves.git,https://github.com/fuwei99/data-sync.git
+          ```
+        *   Save the secret. If you leave this secret empty or don't create it, no extra plugins will be installed.
 
-5.  **Build and Launch:**
-    *   Commit any changes to your Space repository.
+4.  **Build and Launch:**
     *   Hugging Face should automatically start building the Docker image based on the `Dockerfile`.
-    *   The build process will clone SillyTavern and any specified plugins.
+    *   The build process will clone the SillyTavern core (`staging` branch) and then clone/install dependencies for the plugins listed in the `PLUGINS` secret.
     *   Once the build is complete, the Space should launch SillyTavern.
 
-## Accessing SillyTavern
+## Accessing SillyTavern and Plugins
 
 *   Access the main SillyTavern interface via the public URL of your Space.
-*   If you installed plugins with UIs (like `data-sync` or `plugin-manager`), access them via their respective paths (e.g., `/api/plugins/data-sync/ui`).
+*   If you installed plugins, access their UIs as needed (e.g., `/api/plugins/plugin-manager/ui`, `/api/plugins/data-sync/ui`, `/api/plugins/cloud-saves/ui`). Check each plugin's documentation for its specific path.
+*   Remember to configure plugins like `data-sync` or `cloud-saves` within their respective UIs (repo URL, auth tokens, etc.).