Skip to content

Commit

Permalink
DOC-238 : Update SurrealDB CLI documentation with `--no-identificatio…
Browse files Browse the repository at this point in the history
…n-headers` (#772)
  • Loading branch information
Ekwuno authored Aug 16, 2024
1 parent 0895ead commit 0e1fc89
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions doc-surrealdb_versioned_docs/version-latest/cli/start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,15 @@ __BEFORE YOU START :__ Make sure you’ve [installed SurrealDB](/docs/surrealdb/
Whether to allow unauthenticated access
</td>
</tr>
<tr>
<td colspan="2">
<code>--no-identification-headers</code>
<l className='grey'>OPTIONAL</l>
</td>
<td>
Whether to suppress the server name and version headers
</td>
</tr>
<tr>
<td colspan="2">
<code>-s</code> / <code>--strict</code>
Expand Down Expand Up @@ -150,6 +159,17 @@ To start a SurrealDB instance in unauthenticated mode, run the following command
surreal start --unauthenticated
```

## Identification headers

<Since v="v2.0.0" />

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.
Expand Down Expand Up @@ -216,6 +236,8 @@ HTTP SERVER:
-b, --bind <LISTEN_ADDRESSES> 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>...] Allow all capabilities [env: SURREAL_CAPS_ALLOW_ALL=] [possible values:true, false]
Expand Down

0 comments on commit 0e1fc89

Please sign in to comment.