docs: link OpenAI API security guide on website

Surface the OpenAI API security guide from homepage, agent, use-case, and deployment matrix pages.

Author: LauraGPT

agent.html

@@ -54,7 +54,7 @@ <h1>Agent Integration</h1>
   -F model=sensevoice \
   -F response_format=verbose_json</code></pre>
 </section>
-<section id="workflows"><h2>Dify, n8n, and workflow engines</h2><p>For low-code tools that call HTTP nodes or webhook workers, use the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/WORKFLOWS.md">workflow recipes</a>. They cover multipart upload settings, Dify custom tools, n8n binary file fields, audio URL workers, timeouts, and production guardrails. For Node.js, TypeScript, or Next.js services, start from the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/JAVASCRIPT.md">JavaScript/TypeScript recipes</a>. For GUI smoke tests, import the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/POSTMAN.md">Postman collection</a>; for CLI checks on Windows, Linux, or macOS, run the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/smoke_test.py">Python smoke test</a>; for browser upload and microphone checks, launch the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/GRADIO.md">Gradio demo</a>; for schema-driven imports, use the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/OPENAPI.md">OpenAPI spec</a>.</p><p><a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/WORKFLOWS.md">Open workflow recipes</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/JAVASCRIPT.md">JS/TS recipes</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/smoke_test.py">Python smoke test</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/GRADIO.md">Gradio demo</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/POSTMAN.md">Open Postman collection</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/OPENAPI.md">OpenAPI spec</a></p></section>
+<section id="workflows"><h2>Dify, n8n, and workflow engines</h2><p>For low-code tools that call HTTP nodes or webhook workers, use the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/WORKFLOWS.md">workflow recipes</a>. They cover multipart upload settings, Dify custom tools, n8n binary file fields, audio URL workers, timeouts, and production guardrails. For Node.js, TypeScript, or Next.js services, start from the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/JAVASCRIPT.md">JavaScript/TypeScript recipes</a>. For GUI smoke tests, import the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/POSTMAN.md">Postman collection</a>; for CLI checks on Windows, Linux, or macOS, run the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/smoke_test.py">Python smoke test</a>; for browser upload and microphone checks, launch the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/GRADIO.md">Gradio demo</a>; before sharing the service, review the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/SECURITY.md">security and gateway guide</a>; for schema-driven imports, use the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/OPENAPI.md">OpenAPI spec</a>.</p><p><a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/WORKFLOWS.md">Open workflow recipes</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/JAVASCRIPT.md">JS/TS recipes</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/smoke_test.py">Python smoke test</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/GRADIO.md">Gradio demo</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/SECURITY.md">Security guide</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/POSTMAN.md">Open Postman collection</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/OPENAPI.md">OpenAPI spec</a></p></section>
 <section id="mcp"><h2>MCP Server</h2>
 <p>The MCP server gives Claude Code, Claude Desktop, Cursor, Windsurf, and other MCP clients a local <code>transcribe_audio</code> tool.</p>
 <pre><code>pip install funasr

deployment-matrix.html

@@ -27,7 +27,7 @@ <h1>Deployment Matrix</h1>
 <section id="matrix"><h2>Quick decision table</h2>
 <table><tr><th>Path</th><th>Best for</th><th>Start here</th><th>Operational notes</th></tr>
 <tr><td>Python API</td><td>Notebooks, offline jobs, first model evaluation</td><td><a href="tutorial.html">Tutorial</a></td><td>Lowest ceremony; caller owns batching, retries, and files.</td></tr>
-<tr><td>OpenAI-compatible API</td><td>Private speech API, agents, Dify/LangChain/AutoGen/n8n-style clients</td><td><a href="agent.html#server">OpenAI API</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/smoke_test.py">Python smoke test</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/JAVASCRIPT.md">JS/TS recipes</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/WORKFLOWS.md">Workflow recipes</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/GRADIO.md">Gradio demo</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/POSTMAN.md">Postman collection</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/OPENAPI.md">OpenAPI spec</a></td><td>Easiest integration for apps and workflow engines that already support OpenAI audio APIs or multipart HTTP nodes.</td></tr>
+<tr><td>OpenAI-compatible API</td><td>Private speech API, agents, Dify/LangChain/AutoGen/n8n-style clients</td><td><a href="agent.html#server">OpenAI API</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/smoke_test.py">Python smoke test</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/JAVASCRIPT.md">JS/TS recipes</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/WORKFLOWS.md">Workflow recipes</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/GRADIO.md">Gradio demo</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/SECURITY.md">Security guide</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/POSTMAN.md">Postman collection</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/OPENAPI.md">OpenAPI spec</a></td><td>Easiest integration for apps and workflow engines that already support OpenAI audio APIs or multipart HTTP nodes.</td></tr>
 <tr><td>Docker Compose API</td><td>Reproducible local smoke test or small internal service</td><td><a href="https://github.com/modelscope/FunASR/tree/main/examples/openai_api#docker-deployment">OpenAI API Docker docs</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/smoke_test.py">Python smoke test</a></td><td>CPU by default; adapt the image before using CUDA in containers.</td></tr>
 <tr><td>Kubernetes API</td><td>Internal speech API for cluster services</td><td><a href="https://github.com/modelscope/FunASR/tree/main/examples/openai_api/kubernetes">Kubernetes template</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/smoke_test.py">Python smoke test</a></td><td>Private <code>ClusterIP</code> by default; add auth, TLS, network policy, and GPU scheduling before broader exposure.</td></tr>
 <tr><td>Runtime WebSocket service</td><td>Live captions, meetings, call-center streams</td><td><a href="https://github.com/modelscope/FunASR/tree/main/runtime">Runtime docs</a></td><td>Use when partial results, endpointing, or long-lived audio streams matter.</td></tr>
@@ -39,14 +39,14 @@ <h1>Deployment Matrix</h1>
 </section>
 <section id="choices"><h2>Common choices</h2>
 <div class="grid-2"><div class="card"><h3>Try FunASR in five minutes</h3><p>Use the Python API from the tutorial. It is the shortest route for validating installation, model download, device selection, and output shape. If you are unsure which model to start with, use the <a href="model-selection.html">model selection guide</a>.</p></div>
-<div class="card"><h3>Replace cloud transcription locally</h3><p>Use the OpenAI-compatible API. Start with <code>sensevoice</code>, run the bash smoke test or <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/smoke_test.py">Python smoke test</a>, then connect existing SDK or HTTP clients using the client recipes or <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/JAVASCRIPT.md">JavaScript/TypeScript recipes</a>. For cluster rollout, use the <a href="https://github.com/modelscope/FunASR/tree/main/examples/openai_api/kubernetes">Kubernetes template</a>. For Dify, n8n, or webhook workers, use the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/WORKFLOWS.md">workflow recipes</a>. For GUI API checks, import the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/POSTMAN.md">Postman collection</a> or launch the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/GRADIO.md">Gradio demo</a>; for gateways and developer portals, use the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/OPENAPI.md">OpenAPI spec</a>.</p></div></div>
+<div class="card"><h3>Replace cloud transcription locally</h3><p>Use the OpenAI-compatible API. Start with <code>sensevoice</code>, run the bash smoke test or <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/smoke_test.py">Python smoke test</a>, then connect existing SDK or HTTP clients using the client recipes or <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/JAVASCRIPT.md">JavaScript/TypeScript recipes</a>. For cluster rollout, use the <a href="https://github.com/modelscope/FunASR/tree/main/examples/openai_api/kubernetes">Kubernetes template</a>. For Dify, n8n, or webhook workers, use the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/WORKFLOWS.md">workflow recipes</a>. For GUI API checks, import the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/POSTMAN.md">Postman collection</a> or launch the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/GRADIO.md">Gradio demo</a>; for gateways and developer portals, use the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/OPENAPI.md">OpenAPI spec</a> and the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/SECURITY.md">security guide</a>.</p></div></div>
 <div class="grid-2"><div class="card"><h3>Run a repeatable container demo</h3><pre><code>cd examples/openai_api
 cp .env.example .env
 docker compose up --build</code></pre><p>Keep CPU mode until you have a CUDA-capable PyTorch/FunASR image.</p></div>
 <div class="card"><h3>Serve live audio</h3><p>Use the runtime WebSocket service. Validate chunk size, VAD, endpointing, punctuation, speaker diarization, reconnect behavior, and client backpressure with real audio.</p></div></div>
 </section>
 <section id="checklist"><h2>Readiness checklist</h2>
-<ul><li>Pick a model alias and pin it in deployment notes.</li><li>Record FunASR version, model version, device, CUDA/PyTorch version, Docker image tag, and command line.</li><li>Run a short public smoke sample with the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/smoke_test.py">Python smoke test</a> and at least one realistic private sample; for Kubernetes, verify first through <code>kubectl port-forward</code> using the <a href="https://github.com/modelscope/FunASR/tree/main/examples/openai_api/kubernetes">deployment template</a>.</li><li>Log audio duration, model, device, latency, response format, and error type for every request.</li><li>Add upload-size limits, authentication, TLS, and rate limits before exposing an API outside a trusted network.</li><li>For streaming, test silence, noise, overlapping speakers, long sessions, reconnects, and slow clients.</li></ul>
+<ul><li>Pick a model alias and pin it in deployment notes.</li><li>Record FunASR version, model version, device, CUDA/PyTorch version, Docker image tag, and command line.</li><li>Run a short public smoke sample with the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/smoke_test.py">Python smoke test</a> and at least one realistic private sample; for Kubernetes, verify first through <code>kubectl port-forward</code> using the <a href="https://github.com/modelscope/FunASR/tree/main/examples/openai_api/kubernetes">deployment template</a>.</li><li>Log audio duration, model, device, latency, response format, and error type for every request.</li><li>Add upload-size limits, authentication, TLS, and rate limits before exposing an API outside a trusted network; use the <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/SECURITY.md">security guide</a> to plan the boundary.</li><li>For streaming, test silence, noise, overlapping speakers, long sessions, reconnects, and slow clients.</li></ul>
 </section>
 <section id="help"><h2>When to open an issue</h2>
 <p>Use <a href="https://github.com/modelscope/FunASR/issues/new?template=deployment_help.md">Deployment Help</a> for runtime, Docker, vLLM, Triton, Android, browser, or agent integration problems. Include your deployment path, exact command/config, logs, model, device, and audio characteristics.</p>

index.html

@@ -125,6 +125,7 @@ <h3>Verify with curl</h3>
                 <a href="https://github.com/modelscope/FunASR/tree/main/examples/openai_api" class="btn btn-primary">OpenAI API example</a>
                 <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/WORKFLOWS.md" class="btn btn-primary">Workflow recipes</a>
                 <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/GRADIO.md" class="btn btn-primary">Gradio demo</a>
+                <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/SECURITY.md" class="btn btn-primary">Security guide</a>
                 <a href="agent.html" class="btn btn-primary">Agent integration</a>
             </div>
         </div>

use-cases.html

@@ -29,7 +29,7 @@ <h1>Use Cases</h1>
 <tr><td>Transcribe one file locally</td><td><a href="tutorial.html">Tutorial</a> · <a href="model-selection.html">Model selection</a></td><td>Verify install, model choice, and model download in minutes.</td></tr>
 <tr><td>Compare accuracy and speed</td><td><a href="benchmark.html">Benchmark report</a></td><td>Review long-audio speed and CER before choosing a model.</td></tr>
 <tr><td>Migrate from Whisper/cloud ASR</td><td><a href="migration.html">Migration guide</a> · <a href="https://github.com/modelscope/FunASR/tree/main/examples/migration">Benchmark example</a></td><td>Map existing pipelines to FunASR, benchmark representative audio, and plan a safe rollout.</td></tr>
-<tr><td>Build a private speech API</td><td><a href="agent.html#server">OpenAI-compatible API</a> · <a href="https://github.com/modelscope/FunASR/tree/main/examples/openai_api/kubernetes">Kubernetes template</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/JAVASCRIPT.md">JS/TS recipes</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/GRADIO.md">Gradio demo</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/WORKFLOWS.md">Workflow recipes</a></td><td>Reuse OpenAI-style clients, Dify, n8n, HTTP workflow nodes, and a Gradio browser UI without sending audio to a cloud ASR provider.</td></tr>
+<tr><td>Build a private speech API</td><td><a href="agent.html#server">OpenAI-compatible API</a> · <a href="https://github.com/modelscope/FunASR/tree/main/examples/openai_api/kubernetes">Kubernetes template</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/JAVASCRIPT.md">JS/TS recipes</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/GRADIO.md">Gradio demo</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/SECURITY.md">Security guide</a> · <a href="https://github.com/modelscope/FunASR/blob/main/examples/openai_api/WORKFLOWS.md">Workflow recipes</a></td><td>Reuse OpenAI-style clients, Dify, n8n, HTTP workflow nodes, and a Gradio browser UI while planning TLS, auth, upload limits, and logs at the service boundary.</td></tr>
 <tr><td>Add speech input to agents</td><td><a href="agent.html#mcp">MCP server</a></td><td>Connect local ASR to Claude, Cursor, desktop tools, and internal assistants.</td></tr>
 <tr><td>Choose a deployment path</td><td><a href="deployment-matrix.html">Deployment matrix</a></td><td>Compare Python API, OpenAI API, Docker Compose, Kubernetes, WebSocket, vLLM, MCP, subtitles, batch jobs, and Triton.</td></tr>
 <tr><td>Serve streaming ASR</td><td><a href="tutorial.html#streaming">Realtime examples</a></td><td>Handle live captioning, meetings, and call-center style workloads.</td></tr>