Skip to content

Commit 528a465

Browse files
jeremybarbethaaawk
authored andcommitted
doc: add authentication section + extra configuration
1 parent bc00d3e commit 528a465

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

docs/DOCKER.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,21 @@ docker run --name some-sqld -ti \
6060
ghcr.io/tursodatabase/libsql-server:latest
6161
```
6262
63+
## Authentication
64+
65+
### `SQLD_HTTP_AUTH`
66+
67+
Specifies legacy HTTP basic authentication. The argument must be in format `basic:$PARAM`,
68+
where `$PARAM` is base64-encoded string `$USERNAME:$PASSWORD`.
69+
70+
### `SQLD_AUTH_JWT_KEY_FILE`
71+
72+
Path to a file with a JWT decoding key used to authenticate clients in the Hrana and HTTP
73+
APIs. The key is either a PKCS#8-encoded Ed25519 public key in PEM, or just plain bytes of
74+
the Ed25519 public key in URL-safe base64.
75+
76+
You can also pass the key directly in the env variable SQLD_AUTH_JWT_KEY.
77+
6378
## Environment variables
6479
6580
### `SQLD_NODE`
@@ -100,7 +115,6 @@ container networking level.
100115
Defines the GRPC listen address and port for sqld. Primarily used for
101116
inter-node communication. Recommended to leave this on default.
102117
103-
104118
## Docker Compose
105119
106120
Simple docker compose for local development:

0 commit comments

Comments
 (0)