summaryrefslogtreecommitdiff
path: root/examples/server/README.md
diff options
context:
space:
mode:
authorMichael Coppola <m18coppola@gmail.com>2024-01-11 12:51:17 -0500
committerGitHub <noreply@github.com>2024-01-11 19:51:17 +0200
commit27379455c38cb13f24de92dbd6fcdd04eeb1b9d9 (patch)
tree150a38b7780600f8c7494357c0b174df338ee71c /examples/server/README.md
parenteab67950068e4b125007d027232c47d2a5831cd0 (diff)
server : support for multiple api keys (#4864)
* server: added support for multiple api keys, added loading api keys from file * minor: fix whitespace * added file error handling to --api-key-file, changed code to better reflect current style * server: update README.md for --api-key-file --------- Co-authored-by: Michael Coppola <info@michaeljcoppola.com>
Diffstat (limited to 'examples/server/README.md')
-rw-r--r--examples/server/README.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/examples/server/README.md b/examples/server/README.md
index dc27e72b..fd3034b9 100644
--- a/examples/server/README.md
+++ b/examples/server/README.md
@@ -23,7 +23,8 @@ 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.
+- `--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. May be used multiple times to enable multiple valid keys.
+- `--api-key-file`: path to file containing api keys delimited by new lines. If set, requests must include one of the keys for access. May be used in conjunction with `--api-key`'s.
- `--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)