Skip to content

Document RPC BACKFILL flag and refresh sample config #2789

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ElliotFriend merged 4 commits into from
Sep 14, 2026
Merged

Document RPC BACKFILL flag and refresh sample config #2789

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c5d4e7d
Document RPC BACKFILL flag and refresh sample config
kaankacar Aug 24, 2026
7909d67
Match sample config to gen-config-file output
kaankacar Aug 24, 2026
543e70f
Do not promise exact backfill coverage
kaankacar Aug 24, 2026
d12ade0
add hints about datastore configurations
ElliotFriend Sep 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/data/apis/rpc/admin-guide/configuring.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ The resulting configuration should look like this:
# from the Internet and does not use TLS. "" (default) disables the admin server
# ADMIN_ENDPOINT = ""

# Populates database with `history-retention-window` ledgers synchronously on
# startup. This defaults to a week of ledgers if unspecified
BACKFILL = false
Comment thread
Copilot marked this conversation as resolved.
Outdated

# path to additional configuration for the Stellar Core configuration file used
# by captive core. It must, at least, include enough details to define a quorum
# set
Expand Down Expand Up @@ -215,6 +219,9 @@ REQUEST_BACKLOG_SIMULATE_TRANSACTION_QUEUE_LIMIT = 100
# generated
REQUEST_EXECUTION_WARNING_THRESHOLD = "5s"

# Fetch historical ledgers from the datastore if they're not available locally.
Comment thread
ElliotFriend marked this conversation as resolved.
Outdated
SERVE_LEDGERS_FROM_DATASTORE = false

# configures soroban inclusion fee stats retention window expressed in number of
# ledgers
SOROBAN_FEE_STATS_RETENTION_WINDOW = 50
Expand Down Expand Up @@ -259,6 +266,20 @@ Then you would mount that volume using by adding the following parameter: `-v /U

Your running container would mount that volume at the path `/opt/stellar`

## Backfilling History on Startup

Set `BACKFILL = true` to populate the database with a trailing window of history synchronously on startup, before live ingestion begins. This option was added in RPC v25.1.0 and defaults to `false`.

`HISTORY_RETENTION_WINDOW` sets how many ledgers the node populates. The default is `120960` ledgers, which is about 7 days.
Comment thread
Copilot marked this conversation as resolved.
Outdated

`BACKFILL` also requires datastore serving. Set `SERVE_LEDGERS_FROM_DATASTORE = true`. If you enable `BACKFILL` alone, RPC fails to start with this error:

```
Comment thread
Copilot marked this conversation as resolved.
Outdated
backfill requires serving ledgers from datastore to be enabled. See the `--serve-ledgers-from-datastore` flag
```

To set up the datastore, see [Data Lake Integration](./data-lake-integration.mdx). That page also explains which requests the datastore serves directly.

## Next Step

After installation is complete, you are now ready to proceed to [Running RPC](./running.mdx)!