Skip to content

Commit c95f060

Browse files
authored
Add core config parameter to galexie config admin guide (#1799)
1 parent a4e92a3 commit c95f060

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

docs/data/indexers/build-your-own/galexie/admin_guide/configuring.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,31 @@ ledgers_per_file = 1
5252
# Number of files per partition/directory
5353
files_per_partition = 64000
5454
```
55+
56+
##### Use a Custom Core Config (Optional)
57+
58+
You can specify a custom `core.cfg` file in the Galexie `config.toml` to use that will override the default core parameters used with the Stellar Network specified in the `network` parameter.
59+
60+
Copy an existing `core.cfg` file such as the `captive-core-pubnet.cfg` provided [here](https://github.com/stellar/go/blob/master/ingest/ledgerbackend/configs/captive-core-pubnet.cfg) and add the following to your `config.toml`
61+
62+
```toml
63+
captive_core_toml_path = "my-captive-core.cfg"
64+
```
65+
66+
- Please see the [Choosing Your Quorum Set](../../../../../validators/admin-guide/configuring.mdx#choosing-your-quorum-set) for more information about `core.cfg` quorum set configuration
67+
- A list of customizable core parameters can be found [here](https://github.com/stellar/stellar-core/blob/master/src/main/Config.h)
68+
69+
The default `core.cfg` used by Galexie will enable the following core parameters:
70+
71+
- **BACKFILL_RESTORE_META -** ledger metadata will be populated with LedgerEntryChange RESTORE type for protocol versions prior to 23
72+
- **ENABLE_SOROBAN_DIAGNOSTIC_EVENTS -** additional diagnostic Soroban events that are not part of the protocol will be generated while applying Soroban transactions
73+
- **EMIT_SOROBAN_TRANSACTION_META_EXT_V1 -** Soroban extension V1 data will be emitted
74+
- **EMIT_LEDGER_CLOSE_META_EXT_V1 -** ledger metadata extension V1 data will be emitted
75+
- **EMIT_CLASSIC_EVENTS -** classic events will be enabled and emitted for protocol `>= 23`
76+
- **BACKFILL_STELLAR_ASSET_EVENTS -** classic events will be enabled and emitted for protocol `<= 22`. This parameter also requires `EMIT_CLASSIC_EVENTS` to be enabled
77+
78+
:::warning
79+
80+
When you provide a custom core configuration file, it completely replaces the Galexie's default core configuration. This means you must explicitly set any parameters you want to enable, including the ones that are enabled by default in Galexie. Any parameter not listed in your custom config will be set to false.
81+
82+
:::

0 commit comments

Comments
 (0)