Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Server Configuration

The gRPC server is configured by a single TOML file passed with --config. The starting point is examples/server.toml.

infrastore-server --config my_server.toml

File Structure

[server]
host = "0.0.0.0"
port = 50051

[data]
file = "./store.h5"

[authentication]
# "none" or "api_key". For api_key, populate `keys`; clients must send the
# value in the `x-api-key` request header.
method = "none"
# keys = ["replace-me-with-a-secret-1", "replace-me-with-a-secret-2"]

Sections

[server]

KeyTypeRequiredDescription
hoststringyesBind address (e.g. 0.0.0.0, 127.0.0.1)
portintegeryesTCP port

[data]

KeyTypeRequiredDescription
filestringyesHDF5 file path to serve read-only

The matching <path>.sqlite catalog must sit beside the HDF5 file. The server opens the store read-only.

[authentication]

The whole section is optional; omitting it defaults to method = "none".

KeyTypeDefaultDescription
methodstring"none""none" or "api_key" (oauth reserved)
keysarray of string[]Accepted API keys; required when method = "api_key"

Validation runs at startup, so a bad [authentication] section fails loudly rather than at the first request:

  • method = "api_key" with an empty keys list is rejected.

  • An unknown method value is rejected.

  • An unknown key or section is rejected, in every section. A misspelled [authenticaton] (sic) fails the parse instead of silently falling back to method = "none". The cost is that a config carrying a key from a newer version is refused rather than partly honored.

When method = "api_key", each request must carry a matching value in the x-api-key metadata header. Keys are compared without early-exit — every configured key of the same length as the supplied one is checked, so timing does not reveal which key matched or how far a wrong key got. The supplied key's length is not blinded: keys of a different length are rejected before the byte-wise compare, treating length as non-secret.

Startup Behavior

On launch the server:

  1. Loads and parses the TOML file.
  2. Validates the [authentication] section.
  3. Opens [data].file as a read-only store.
  4. Binds host:port and serves the CatalogStore gRPC service.

Logging honors the RUST_LOG environment variable (default info):

RUST_LOG=debug infrastore-server --config my_server.toml

See the gRPC Server guide for the end-to-end workflow and the gRPC API reference for the served methods.