Skip to content

Commit d3b0a80

Browse files
committed
docs(libsql-server): fix LIBSQL_BOTTOMLESS_AWS_DEFAULT_REGION env var name
The README documented the bottomless region environment variable as LIBSQL_BOTTOMLESS_AWS_REGION, but the replicator source code (bottomless/src/replicator.rs:139,201) actually reads LIBSQL_BOTTOMLESS_AWS_DEFAULT_REGION. Setting the documented name results in sqld failing with: Error: Internal Error: LIBSQL_BOTTOMLESS_AWS_DEFAULT_REGION was not set This corrects the README to match the actual implementation, adds LIBSQL_BOTTOMLESS_AWS_SESSION_TOKEN (also supported by the replicator but undocumented), improves the comment descriptions, and adds a note with the exact error message users will encounter so they can search for it. Verified against bottomless/src/replicator.rs env_var calls.
1 parent e4beaca commit d3b0a80

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

libsql-server/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,16 @@ environment variables can be used to configure the replication:
8989
```bash
9090
LIBSQL_BOTTOMLESS_BUCKET=my-bucket # Default bucket name: bottomless
9191
LIBSQL_BOTTOMLESS_ENDPOINT='http://localhost:9000' # address can be overridden for local testing, e.g. with Minio
92-
LIBSQL_BOTTOMLESS_AWS_SECRET_ACCESS_KEY= # regular AWS variables are used
93-
LIBSQL_BOTTOMLESS_AWS_ACCESS_KEY_ID= # ... to set up auth, regions, etc.
94-
LIBSQL_BOTTOMLESS_AWS_REGION= # .
92+
LIBSQL_BOTTOMLESS_AWS_ACCESS_KEY_ID= # AWS access key ID (or S3-compatible provider)
93+
LIBSQL_BOTTOMLESS_AWS_SECRET_ACCESS_KEY= # AWS secret access key (or S3-compatible provider)
94+
LIBSQL_BOTTOMLESS_AWS_DEFAULT_REGION=us-east-1 # AWS region (required; use us-east-1 for MinIO/local dev)
95+
LIBSQL_BOTTOMLESS_AWS_SESSION_TOKEN= # Optional, for temporary AWS credentials
9596
```
9697

98+
> **Note:** The region variable is `LIBSQL_BOTTOMLESS_AWS_DEFAULT_REGION`, not `LIBSQL_BOTTOMLESS_AWS_REGION`.
99+
> If unset, `sqld` will fail to start with the error:
100+
> `Error: Internal Error: LIBSQL_BOTTOMLESS_AWS_DEFAULT_REGION was not set`
101+
97102
### bottomless-cli
98103

99104
Replicated snapshots can be inspected and managed with the official command-line

0 commit comments

Comments
 (0)