From 0e1fc89728efc201972985f4dea34c87ea6bf4a9 Mon Sep 17 00:00:00 2001 From: Obinna Ekwuno Date: Fri, 16 Aug 2024 09:55:38 +0100 Subject: [PATCH] DOC-238 : Update SurrealDB CLI documentation with `--no-identification-headers` (#772) --- .../version-latest/cli/start.mdx | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc-surrealdb_versioned_docs/version-latest/cli/start.mdx b/doc-surrealdb_versioned_docs/version-latest/cli/start.mdx index 9c98c2bae..cd9824156 100644 --- a/doc-surrealdb_versioned_docs/version-latest/cli/start.mdx +++ b/doc-surrealdb_versioned_docs/version-latest/cli/start.mdx @@ -69,6 +69,15 @@ __BEFORE YOU START :__ Make sure you’ve [installed SurrealDB](/docs/surrealdb/ Whether to allow unauthenticated access + + + --no-identification-headers + OPTIONAL + + + Whether to suppress the server name and version headers + + -s / --strict @@ -150,6 +159,17 @@ To start a SurrealDB instance in unauthenticated mode, run the following command surreal start --unauthenticated ``` +## Identification headers + + + +By default, SurrealDB includes headers in the HTTP response that identify the server name and version. You can suppress these headers by using the `--no-identification-headers` flag. + +```bash +surreal start --no-identification-headers +``` + + ## Command help To see the help information and usage instructions, in a terminal run the `surreal start --help` command without any further arguments. This command gives general information on the arguments, inputs, and additional options for the `start` command. @@ -216,6 +236,8 @@ HTTP SERVER: -b, --bind The hostname or IP address to listen for connections on [env: SURREAL_BIND=] [default:127.0.0.1:8000] +--no-identification-headers Whether to suppress the server name and version headers [env: SURREAL_NO_IDENTIFICATION_HEADERS=] + CAPABILITIES: -A, --allow-all [...] Allow all capabilities [env: SURREAL_CAPS_ALLOW_ALL=] [possible values:true, false]