From: Zsapi <redacted>
Date: Tue, 9 Jan 2024 09:12:43 +0000 (+0100)
Subject: server : add api-key flag to documentation (#4832)
X-Git-Tag: upstream/0.0.4488~2690
X-Git-Url: https://git.djapps.eu/?a=commitdiff_plain;h=8c5833031857c9e9ada61948bae894ab9c785f86;p=pkg%2Fggml%2Fsources%2Fllama.cpp

server : add api-key flag to documentation (#4832)

Document the api-key flag added to server in https://github.com/ggerganov/llama.cpp/pull/4441
---

diff --git a/examples/server/README.md b/examples/server/README.md
index 243e6699..5d982962 100644
--- a/examples/server/README.md
+++ b/examples/server/README.md
@@ -23,6 +23,7 @@ Command line options:
 -   `--host`: Set the hostname or ip address to listen. Default `127.0.0.1`.
 -   `--port`: Set the port to listen. Default: `8080`.
 -   `--path`: path from which to serve static files (default examples/server/public)
+-   `--api-key`: Set an api key for request authorization. By default the server responds to every request. With an api key set, the requests must have the Authorization header set with the api key as Bearer token.
 -   `--embedding`: Enable embedding extraction, Default: disabled.
 -   `-np N`, `--parallel N`: Set the number of slots for process requests (default: 1)
 -   `-cb`, `--cont-batching`: enable continuous batching (a.k.a dynamic batching) (default: disabled)