https://step.dev/knowledgebase/31/categories/configuration/ Recent content in Configuration on Step Documentation Hugo -- gohugo.io en Mon, 19 Oct 2026 00:00:00 +0000 https://step.dev/knowledgebase/31/setup/configuration/identity-management/ Thu, 08 Aug 2024 00:00:00 +0000 https://step.dev/knowledgebase/31/setup/configuration/identity-management/ Ldap setup (optional) You can use LDAP to authenticate to Step by uncommenting the following properties is step.properties: # Authenticator configuration - example for LDAP ui.authenticator=step.core.access.LdapAuthenticator # url of your LDAP server ui.authenticator.ldap.url=<url> # root named context for searching for users ui.authenticator.ldap.base=dc=<>,dc=<> # search filter - {user} will be replaced with the username ui.authenticator.ldap.filter=(cn={user}) # user used for connecting to the LDAP server ui.authenticator.ldap.techuser=cn=<>,dc=<>,dc=<> ui.authenticator.ldap.techpwd=<PWD> # Use following flag to manage users from LDAP (authenticated user will be created automatically in Step) #ui. https://step.dev/knowledgebase/31/setup/configuration/important-settings/ Thu, 08 Aug 2024 00:00:00 +0000 https://step.dev/knowledgebase/31/setup/configuration/important-settings/ Controller settings Main properties The main configuration file of the Controller is step.properties. Installation from archive When installing Step manually from the archives, the file is located in the conf folder of the controller. The main parameters to be updated in order to start the Controller are listed below : port=<port_to_access_controller_gui> grid.port=<port_for_agents_to_access_the_controller> datasource.mongo.properties.host=<mongo_hostname_or_ip> datasource.mongo.properties.port=<mongo_port> datasource.mongo.properties.username=<step_database_username> (if any) datasource.mongo.properties.password=<step_database_password> (if any) For example : port=8080 -> Controller GUI will be accessible on port 8080 grid. https://step.dev/knowledgebase/31/setup/configuration/licensing/ Thu, 08 Aug 2024 00:00:00 +0000 https://step.dev/knowledgebase/31/setup/configuration/licensing/ License (Enterprise version only) For the Step Controller Enterprise version, you will need to put your purchased Step license files in one of the following folders: [installation_path]/licenses/ (recommended) [installation_path]/bin/licenses/ Detailed explanation: The license files consist of a license configuration file (step-enterprise.licenseconfig.json), as well as (usually) one or more actual license files (license*.json). Please contact us to obtain the relevant files for your organization. Do not attempt to modify the content of these files, as they are digitally signed, and any change will render the signature invalid. https://step.dev/knowledgebase/31/setup/configuration/logging/ Thu, 08 Aug 2024 00:00:00 +0000 https://step.dev/knowledgebase/31/setup/configuration/logging/ This page describes how to configure the logging in the different component of Step. To customize the logback configuration using our Helm chart, refer to this documentation Controller logs By default, the controller logs are written to the file log/controller.log. The default logging settings can be changed in the file bin/logback.xml. Verbosity You can easily change the logging verbosity by tweaking the “root” log level present in the file bin/logback.xml. You can also tweak the verbosity for specific features. https://step.dev/knowledgebase/31/setup/configuration/ssl-settings/ Thu, 08 Aug 2024 00:00:00 +0000 https://step.dev/knowledgebase/31/setup/configuration/ssl-settings/ By default, the controller GUI is accessible via HTTP and SSL is disabled. It is highly recommended to secure your controller instance by enabling SSL. Before enabling SSL you will need a valid SSL certificate for your controller domain. You can either use a self-signed certificate or obtain it from a certificate authority (CA). In both cases you’ll get following files: the private key file (.key) the certificate file (.cert) The controller requires the certificate in a Java KeyStore in JKS format. https://step.dev/knowledgebase/31/setup/installation/kubernetes/chart-configuration-samples/ Fri, 19 Apr 2024 14:00:00 +0000 https://step.dev/knowledgebase/31/setup/installation/kubernetes/chart-configuration-samples/ This page provides practical configuration examples for common Step Helm chart deployment scenarios. For a complete reference of all available Helm values and their detailed descriptions, please refer to the Helm Values documentation. Additional Resources: Access enterprise download section - For obtaining access to Step Enterprise artifacts and Docker images Release notes of the Helm Chart - Latest chart versions and changelog Database configuration Step supports two database backends: MongoDB (default) and PostgreSQL. https://step.dev/knowledgebase/31/devops/step-studio/ Mon, 19 Oct 2026 00:00:00 +0000 https://step.dev/knowledgebase/31/devops/step-studio/ Step Studio brings the visual editors of the Step platform to your local machine. It lets you create and maintain Automation Packages, execute Plans locally, and execute or deploy your automation on a remote Step instance. Studio works directly on the Automation Package files in your project, including its YAML descriptor and Plan fragments, alongside the source code and resources used by your Keywords. You can use Studio and your IDE on the same project without maintaining separate copies of the automation. https://step.dev/knowledgebase/31/setup/configuration/timeseries-settings/ Wed, 25 Sep 2024 00:00:00 +0000 https://step.dev/knowledgebase/31/setup/configuration/timeseries-settings/ How Time Series Works Step has its own implementation of time series, designed to efficiently manage and visualize large datasets over extended periods. This feature powers data visualization in the Performance tab of the execution view and the Analytics view. By grouping data into collections with different resolutions, the system optimizes both storage and retrieval for short-term and long-term analysis, ensuring high performance and resource efficiency. By default, Step uses several collections with varying resolutions to store data: https://step.dev/knowledgebase/31/setup/configuration/agent-configuration/ Wed, 01 May 2024 14:00:00 +0000 https://step.dev/knowledgebase/31/setup/configuration/agent-configuration/ Agent endpoint The agent exposes a REST service to the Controller, which is consumed by the controller to execute Keywords. The endpoint of this service is called agent endpoint. The agent endpoint is configured automatically at agent startup and is communicated to the controller at registration. If required, the endpoint can be tweaked as follow: Agent port Per default the agent lets the system find a free port automatically at startup to listen on. https://step.dev/knowledgebase/31/setup/configuration/agent-provisioning-configuration/ Wed, 01 May 2024 14:00:00 +0000 https://step.dev/knowledgebase/31/setup/configuration/agent-provisioning-configuration/ When running in Kubernetes, Step supports automatic provisioning of Agents (i.e. automatic provisioning of the containers responsible for executing Keywords). This page describes how to enable and configure the Agent provisioning. For information on using Agent provisioning, please refer to the Agent Provisioning page. Notes: Agent provisioning is part of Step Enterprise and is supported as of version 25. It has been designed to work with the official Step Helm Chart. https://step.dev/knowledgebase/31/ai/mcp-server/multi-profile-config/ Mon, 29 Jun 2026 00:00:00 +0000 https://step.dev/knowledgebase/31/ai/mcp-server/multi-profile-config/ The Step MCP Server supports a YAML-based configuration file that lets you define multiple profiles — each targeting a different Step instance or project. This is the recommended approach when you work with more than one Step instance, or manage many projects on the same instance. For the simple single-instance setup using environment variables, see Getting Started. Key concepts: profiles and projects A profile is a connection identity: a Step instance URL, an API token, and an optional default project. https://step.dev/knowledgebase/31/saasdocs/agent-configuration/ Thu, 25 Jan 2024 11:08:01 +0100 https://step.dev/knowledgebase/31/saasdocs/agent-configuration/ Automation scripts are executed on Agents. Certain jobs require specific agents: Client-based automation (like browser-based testing) require UI agents. Most plugins require a specific agent type (java for most of them), we list the most relevant tasks here. Configuring this for Step SaaS in the Step Portal is an easy process and can either be done when creating a cluster or by editing an existing one. Agent Types Here all available Agent types are listed, including information about the available resources per running agent. https://step.dev/knowledgebase/31/userdocs/keywords/configuring-keywords/ Sun, 18 Jun 2023 00:00:00 +0000 https://step.dev/knowledgebase/31/userdocs/keywords/configuring-keywords/ Step offers holistic business use cases that lets business and technical users reuse different automation components. To enhance interaction quality and prevent input mismatches, users can specify mandatory information required to execute a specific Keyword. Schema Optional and mandatory input keys can be specified in the form of a JSON schema tied to the Keyword. Schema can be provided manually as part of the Keyword’s generic fields or automatically populated based on the “schema” attribute of the Keyword annotation in Java and . https://step.dev/knowledgebase/31/setup/installation/kubernetes/helmvalues/ Fri, 19 Apr 2024 14:00:00 +0000 https://step.dev/knowledgebase/31/setup/installation/kubernetes/helmvalues/ Helm values Values that could be used are listed below. Note that the listed values applies to the latest Chart version, some of them might not be available in previous versions. Image parameters Name Description Default value image.repository Controller and Agent images repository base name "" image.pullPolicy Controller and Agent images pull policy Always imagePullSecrets Registry secret names as an array [] Commons parameters Name Description Default value commons.version Step version to use 3. https://step.dev/knowledgebase/31/setup/configuration/customization/ Thu, 28 Feb 2019 14:08:01 +0100 https://step.dev/knowledgebase/31/setup/configuration/customization/ Cosmetics Cosmetics customization is only available as part of step enterprise Customization of step’s static resources (images, stylesheets, …) is made possible in a generic way using the two following properties: cosmetics.folder: This property points to a local folder on the controller’s host in which alternate cosmetic resources are stored (conf/cosmetics/ by default). cosmetics.interceptedResourceList: A comma-separated list of resources which are supposed to be replaces with custom resources. Defaults to step-variables. https://step.dev/knowledgebase/31/setup/configuration/maven-artifact-repository/ Sun, 23 Nov 2025 00:00:00 +0000 https://step.dev/knowledgebase/31/setup/configuration/maven-artifact-repository/ Artifact repositories configuration When deploying or executing Automation Packages and their libraries using maven coordinates, the artifacts are retrieved from the configured artifact repositories. The configuration is based on the standard maven settings.xml format and stored as a Step setting. Retrieve current maven settings You can get the current content of the maven settings.xml with following REST call: GET <controller-url>/rest/settings/maven_settings_default Modify maven settings You can invoke following service passing the content of your maven settings. https://step.dev/knowledgebase/31/userdocs/userpreferences/ Sun, 29 Nov 2020 14:08:01 +0100 https://step.dev/knowledgebase/31/userdocs/userpreferences/ User Settings Credentials and preferences can be defined from the User Settings page. Click on your username on the top right box, then on “User Settings”: User Credentials and API keys On the “User Settings”, you can modify your password as well as generate and revoke Api keys. Generate an API Key API keys are used to authenticate with Step when accessing the Step API, whether through direct REST calls, the Step client, or the CLI. https://step.dev/knowledgebase/31/setup/configuration/grid-proxy/ Wed, 10 Sep 2025 00:00:00 +0000 https://step.dev/knowledgebase/31/setup/configuration/grid-proxy/ The Grid Proxy connects secondary Kubernetes clusters or namespaces that host agents (but not the controller or other Step services) to the primary Step grid. It forwards agent registration and execution traffic, and, when enabled, also manages dynamic agent provisioning. What is the Grid Proxy? The Grid Proxy is a Step component deployed in each secondary cluster (or namespace). It has two primary roles: 1. Agent connectivity The Grid Proxy forwards registration requests from the agents in the secondary cluster to the agent grid of the primary cluster (running in the controller). https://step.dev/knowledgebase/31/setup/configuration/ Mon, 29 Jul 2024 00:00:00 +0000 https://step.dev/knowledgebase/31/setup/configuration/ Controller configuration The main configuration file of the Controller is step.properties When installing Step manually from the archive distribution, the file is located in the conf folder of the controller. When installing Step with Helm, the important properties are exposed directly as values (See Helm Values for details). All properties supported by step.properties which are not directly exposed as value can be defined using the value map: controller.config.additionalProperties Configuration placeholders Placeholders can be used in step. https://step.dev/knowledgebase/31/setup/configuration/jkskeystore/ Tue, 06 Apr 2021 00:00:00 +0100 https://step.dev/knowledgebase/31/setup/configuration/jkskeystore/ Both the controller, for its web application, and the agent, for the agent services, support SSL and require a Java KeyStore in JKS format for the certificates and keys. This short tutorial will show you how to generate a KeyStore in JKS format based on .key and .crt files. To generate it, you will need : the private key used to create your certificate request (.key file) the private key password (if any) the certificate generated with the previously transmitted certificate request (the . https://step.dev/knowledgebase/31/setup/configuration/encryption-manager/ Tue, 06 Apr 2021 00:00:00 +0100 https://step.dev/knowledgebase/31/setup/configuration/encryption-manager/ The encryption manager is a central component that provides encryption services for Step components that need to store sensitive values (like credentials for instance). The encryption manager is for instance used by the parameter module to store protected parameters. Enable the encryption manager The encryption manager can be enabled from the step.properties with the following property: plugins.EncryptionManagerControllerPlugin.enabled=true When starting a controller with the encryption manager the first time, a new RSA key pair will be generated and stored under the folder bin/encryptionManager.