1. Sitecore Module Explorer

Configure environments

Version:

You use environments to configure connections to Sitecore instances including authentication and authorization credentials. Environments are stored in the .sitecore/user.json file under the project root.

Create an environment

To create an environment:

  1. In Sitecore Module Explorer, right-click Environments and click New Environment.

    Illustration showing the Sitecore instance environment configuration form.

  2. In the environment window, enter the following:

    FieldContent
    NameThe name of the environment.
    Note

    If you name the environment

    default, the Sitecore Command Line Interface uses this environment unless another is specified.
    Allow writeAllow writing to the Sitecore instance.
    HostThe URL of the Sitecore instance.
    AuthorityThe URL of the Sitecore Identity Server or other identity service.
    Use client credentialsLog in using OAuth2 client credentials.
    Client IDThe client ID.

    See the Sitecore Command Line Interface login documentation for more details.

  3. Save the environment.

Edit an environment

To edit an environment:

  1. In Sitecore Module Explorer, double-click the environment.

  2. In the environment window, edit the following:

    FieldContent
    NameThe name of the environment.
    Note

    If you name the environment

    default, the Sitecore Command Line Interface uses this environment unless another is specified.
    Allow writeAllow writing to the Sitecore instance.
    HostThe URL of the Sitecore instance.
    AuthorityThe URL of the Sitecore Identity Server or other identity service.
    Use client credentialsLog in using OAuth2 client credentials.
    Client IDThe client ID.

    See the Sitecore Command Line Interface login documentation for more details.

Remove an environment

To remove an environment:

  1. In Sitecore Module Explorer, right-click the environment and click Remove Environment.
  2. In the dialog box, click Yes to remove the environment.
If you have suggestions for improving this article, let us know!