Upload README.md

README.md

@@ -1,60 +1,69 @@
 ---
-title: SillyTavern (Zip Deploy) with Data Sync
-emoji: 📦 # Changed emoji to reflect zip deployment
-colorFrom: indigo
+title: SillyTavern (via Dockerfile)
+emoji: 🐳
+colorFrom: blue
 colorTo: green
 sdk: docker
 pinned: false
 app_port: 8000 # SillyTavern default port
-# Add secret for config.yaml
+# Runtime secret for config.yaml
 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
 ---
 
-# SillyTavern with Data Sync Plugin (Zip Deployment)
+# SillyTavern Docker Deployment for Hugging Face Spaces
 
-This Space runs SillyTavern using a zipped deployment method to accommodate Hugging Face file limits. It includes the custom `data-sync` plugin.
+This Space runs SillyTavern using a custom `Dockerfile`. It clones the SillyTavern `staging` branch and allows dynamic installation of plugins during the build process.
 
-**IMPORTANT:** This setup requires you to upload your SillyTavern installation (including the plugin) as a single `sillytavern.zip` file and provide your `config.yaml` content as a Hugging Face Secret.
+## 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.
 
 ## Setup and Deployment Steps
 
-1.  **Prepare Locally:**
-    *   Have a working local installation of SillyTavern.
-    *   Ensure the `data-sync` plugin (`https://github.com/fuwei99/data-sync.git`) is cloned into the `plugins/data-sync` directory within your local SillyTavern folder.
-    *   **Crucially: Delete the `config.yaml` file from your local SillyTavern directory before proceeding.** Its contents will be added as a secret.
-
-2.  **Create `sillytavern.zip`:**
-    *   Navigate **inside** your local SillyTavern directory (the one containing `server.js`, `public`, `plugins`, etc.).
-    *   Select **all files and folders** within this directory.
-    *   Create a zip archive named exactly `sillytavern.zip` from these selected contents.
-    *   **DO NOT** zip the parent SillyTavern folder itself; the zip file's root should contain `server.js`, etc.
-    *   *(Optional but Recommended)*: Exclude unnecessary files/folders like `.git`, `node_modules`, `chats/logs`, large backups, etc., to reduce the zip size.
-
-3.  **Upload 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.
-        *   The `sillytavern.zip` file you created in step 2.
-    *   Commit and push the changes.
-
-4.  **Configure Secret:**
+1.  **Fork or Create Space:**
+    *   Create a new Hugging Face Space, selecting "Docker" as the SDK.
+    *   Alternatively, fork this repository.
+
+2.  **Add Files:**
+    *   Ensure the `Dockerfile` from this repository is present in the root of your Space.
+    *   This `README.md` provides basic instructions.
+
+3.  **Configure `CONFIG_YAML` Secret:**
     *   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 original (now deleted locally) `config.yaml` file into the **Secret value** field.
+    *   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.
+
 5.  **Build and Launch:**
-    *   Hugging Face should automatically start building the Docker image based on the `Dockerfile` and your uploaded files.
+    *   Commit any changes to your Space repository.
+    *   Hugging Face should automatically start building the Docker image based on the `Dockerfile`.
+    *   The build process will clone SillyTavern and any specified plugins.
     *   Once the build is complete, the Space should launch SillyTavern.
 
-## Accessing SillyTavern and Data Sync
+## Accessing SillyTavern
 
 *   Access the main SillyTavern interface via the public URL of your Space.
-*   Access the data-sync plugin UI at `/api/plugins/data-sync/ui` relative to your Space's URL.
-*   Remember to configure the data-sync plugin within its UI (repo URL, auth token if needed) and use its features to push/pull your data.
+*   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`).