env_config

Temporal External Client Configuration Samples

This directory contains Ruby samples that demonstrate how to use the Temporal SDK's external client configuration feature. This feature allows you to configure a Temporalio::Client using a TOML file and/or programmatic overrides, decoupling connection settings from your application code.

Prerequisites

To run, first see README.md for prerequisites.

Configuration File

The config.toml file defines three profiles for different environments:

• [profile.default]: A working configuration for local development.
• [profile.staging]: A configuration with an intentionally incorrect address (localhost:9999) to demonstrate how it can be corrected by an override.
• [profile.prod]: A non-runnable, illustrative-only configuration showing a realistic setup for Temporal Cloud with placeholder credentials. This profile is not used by the samples but serves as a reference.

Samples

The following Ruby scripts demonstrate different ways to load and use these configuration profiles. Each runnable sample highlights a unique feature.

load_from_file.rb

This sample shows the most common use case: loading the default profile from the config.toml file.

To run this sample:

bundle exec ruby load_from_file.rb

load_profile.rb

This sample demonstrates loading the staging profile by name (which has an incorrect address) and then correcting the address programmatically. This highlights the recommended approach for overriding configuration values at runtime.

To run this sample:

bundle exec ruby load_profile.rb

Running the Samples

You can run each sample script directly from the root of the samples-ruby repository. Ensure you have the necessary dependencies installed by running bundle install from the repository root.