Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
In this configuration guide, you learn the key configuration parameters and how to use them for most typical usage scenarios. You can use Orleans in various configurations fitting different scenarios, such as local single-node deployment for development and testing, server clustering, multi-instance Azure worker roles, and so on.
This guide provides instructions for the key configuration parameters necessary to run Orleans in one of the target scenarios. Other configuration parameters primarily help you fine-tune Orleans for better performance.
Configure silos and clients programmatically via SiloHostBuilder and ClientBuilder, respectively. You do this using several supplemental option classes. Option classes in Orleans follow the Options pattern in .NET and can be loaded from files, environment variables, or any other valid configuration provider.
If you want to configure a silo and a client for local development, see the Local development configuration section. The Server configuration and Client configuration sections cover configuring silos and clients, respectively.
The section on Typical configurations provides a summary of a few common configurations. You can find a list of important core options that you can configure in List of options classes.
Important
Make sure you properly configure .NET garbage collection as detailed in Configure .NET garbage collection.
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
