docs(libsql-server): fix LIBSQL_BOTTOMLESS_AWS_DEFAULT_REGION env var name#2229
Open
Booki-Brain wants to merge 1 commit intotursodatabase:mainfrom
Open
docs(libsql-server): fix LIBSQL_BOTTOMLESS_AWS_DEFAULT_REGION env var name#2229Booki-Brain wants to merge 1 commit intotursodatabase:mainfrom
Booki-Brain wants to merge 1 commit intotursodatabase:mainfrom
Conversation
… 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The
libsql-server/README.mddocuments the bottomless region environment variable asLIBSQL_BOTTOMLESS_AWS_REGION, but the actual implementation inbottomless/src/replicator.rsreadsLIBSQL_BOTTOMLESS_AWS_DEFAULT_REGION:https://github.com/tursodatabase/libsql/blob/main/bottomless/src/replicator.rs#L139
https://github.com/tursodatabase/libsql/blob/main/bottomless/src/replicator.rs#L201
Users following the README will set the wrong variable and see
sqldfail with:Changes
libsql-server/README.mdto matchreplicator.rsLIBSQL_BOTTOMLESS_AWS_SESSION_TOKEN(also supported inreplicator.rs:200but previously undocumented)Verification
Verified by:
bottomless/src/replicator.rslines 139, 198-201 (env_var calls)Impact
Docs-only change, no code or behaviour changes. Should reduce time-to-first-success for new self-hosters using bottomless replication, particularly those using MinIO, Cloudflare R2, Wasabi, or other S3-compatible providers in local / EU-only deployments.