> ## Documentation Index
> Fetch the complete documentation index at: https://developer.watson-orchestrate.ibm.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Managing watsonx Orchestrate Developer Edition server

After you install the watsonx Orchestrate server, you manage the local watsonx Orchestrate Developer Edition server using the ADK CLI. With the CLI, you stop or start the server, reset it, view container logs, and manage the VM that hosts the containers. You can attach or release the VM, edit its settings, or log in using SSH.

## Initializing watsonx Orchestrate Developer Edition server

Initialize the server when it is stopped or when you want to start additional resources that you did not enable previously. Run:

```bash BASH theme={null}
orchestrate server start -e <path-.env-file>
```

<Expandable title="command flags">
  <ResponseField name="--env-file / -e" type="string" required={true}>
    Path to your `.env` file.
  </ResponseField>

  <ResponseField name="--with-langfuse / -l" type="boolean" required={false}>
    Enable Langfuse support.
  </ResponseField>

  <ResponseField name="--with-ibm-telemetry / -i" type="boolean" required={false}>
    Enable IBM's native observability framework.
  </ResponseField>

  <ResponseField name="--accept-terms-and-conditions" type="boolean" required={false}>
    Accept the terms and conditions shown in the logs when the server starts.
  </ResponseField>

  <ResponseField name="--with-doc-processing / -d" type="boolean" required={false}>
    Enable IBM Document Processing to extract information from business documents.\
    This activates the Watson Document Understanding service.
  </ResponseField>

  <ResponseField name="--with-voice" type="boolean" required={false}>
    Enable voice support.
  </ResponseField>

  <ResponseField name="--with-langflow" type="boolean" required={false}>
    Enable Langflow support. For more information about Langflow, see [Authoring Langflow tools](../langflow/overview).
  </ResponseField>

  <ResponseField name="--cert-bundle-path" type="string" required={false}>
    Path to a custom certificate bundle file.
  </ResponseField>

  <ResponseField name="--service-username" type="string" required={false}>
    The username you configure for watsonx Orchestrate Developer Edition services. If you do not provide a username, the system generates one by using your OS username. If that attempt fails, the system sets the name orchestrate. This applies to Langfuse, Minio, MCP Gateway, and ClickHouse. The username must contain at least three characters.

    <Note>
      **Note:**

      For users who update from earlier versions to 2.6.0. If you have any server configured by an older version, whether it is running or stopped, your database uses the old default credentials because the database was created before the new configuration. You need to reset and start the environment to ensure the database container uses the newest credentials.

      If you want to keep your existing data after the update, you can override the service credentials for each service by configuring them in the .env file. For more information, see the related documentation section. For more information, see [Configure services credentials for watsonx Orchestrate Developer Edition in the .env file](./wxOde_setup#configure-services-credentials).
    </Note>
  </ResponseField>

  <ResponseField name="--service-password" type="string" required={false}>
    The password you configure for watsonx Orchestrate Developer Edition services. If you do not provide a password, the system prompts you to enter one during the first setup. This applies to PostgreSQL, Langfuse, Minio, MCP Gateway, ElasticSearch, Milvus, and Clickhouse. The password must contain at least eighteen characters.

    <Note>
      **Note:**

      For users who update from earlier versions to 2.6.0. If you have any server configured by an older version, whether it is running or stopped, your database uses the old default credentials because the database was created before the new configuration. You need to reset and start the environment to ensure the database container uses the newest credentials.

      If you want to keep your existing data after the update, you can override the service credentials for each service by configuring them in the .env file. For more information, see the related documentation section. For more information, see [Configure services credentials for watsonx Orchestrate Developer Edition in the .env file](./wxOde_setup#configure-services-credentials).
    </Note>
  </ResponseField>
</Expandable>

## Stopping watsonx Orchestrate Developer Edition server

Stop the server when you finish your work to free resources on your machine. This prevents unnecessary CPU and memory usage. Run:

```bash BASH theme={null}
orchestrate server stop
```

<Expandable title="command flags">
  <ResponseField name="--env-file / -e" type="string">
    Path to your `.env` file.
  </ResponseField>

  <ResponseField name="--keep-vm" type="boolean">
    Keeps the VM running the watsonx Orchestrate Developer Editon server.
  </ResponseField>
</Expandable>

## Resetting watsonx Orchestrate Developer Edition server

Reset the environment instead of uninstalling and reinstalling. This command stops the server, removes all Docker containers, and clears data volumes. Use it when you need a clean environment for development. Run:

```bash BASH theme={null}
orchestrate server reset
```

<Expandable title="command flags">
  <ResponseField name="--env-file / -e" type="string">
    Path to your `.env` file.
  </ResponseField>
</Expandable>

## Editing watsonx Orchestrate Developer Edition VMs

The installation creates a VM named `ibm-watsonx-orchestrate` that hosts the watsonx Orchestrate Developer Edition containers. By default, the VM uses 8 cores and 16 GB RAM. You can change CPU, memory, and disk space to improve performance or fit your hardware limits. Run:

<Note>
  **Note:**

  You cannot edit disks for VMs running in WSL.
</Note>

```bash BASH theme={null}
orchestrate server edit --cpus <cpu-cores> --memory <memory> --disk <disk-space>
```

<Expandable title="command flags">
  <ResponseField name="--cpus" type="Integer">
    Number of CPU cores available to the VM.
  </ResponseField>

  <ResponseField name="--memory" type="Integer" required={false}>
    Memory in GB.
  </ResponseField>

  <ResponseField name="--disk" type="Integer" required={false}>
    Disk space in GB.
  </ResponseField>
</Expandable>

## Using Docker

### Attaching watsonx Orchestrate Developer Edition to a Docker engine

The installation creates a VM named `ibm-watsonx-orchestrate` that hosts the watsonx Orchestrate Developer Edition containers. Attach Docker to this VM context when you need Docker commands to run inside the VM instead of your local machine. This is useful if you want to manage containers that belong to the watsonx Orchestrate environment directly. Run:

```bash BASH theme={null}
orchestrate server attach-docker 
```

### Releasing watsonx Orchestrate Developer Edition from a Docker engine

Switch Docker back to the previous context when you finish working with the VM. Run:

```bash BASH theme={null}
orchestrate server release-docker
```

## Viewing watsonx Orchestrate Developer Edition logs

To view all logs for all containers, run:

```bash BASH  theme={null}
orchestrate server logs
```

To show the logs for a specific service, run:

```bash BASH theme={null}
orchestrate server logs dev-edition-wxo-server-worker-1
```

<Expandable title="command flags">
  <ResponseField name="--id / -i" type="string" required={false}>
    Container ID of the container whose logs you want to view.\
    Do not use this flag together with the `--name` flag.
  </ResponseField>

  <ResponseField name="--name / -n" type="string" required={false}>
    Container Name of the container whose logs you want to view.\
    Do not use this flag together with the `--id` flag.
  </ResponseField>

  <ResponseField name="--env-file / -e" type="string" required={false}>
    Path to your `.env` file.
  </ResponseField>
</Expandable>

## Logging into watsonx Orchestrate Developer Edition VM using SSH

The installation creates a VM named `ibm-watsonx-orchestrate` that hosts the watsonx Orchestrate Developer Edition containers. Access this VM with SSH when you need direct control. Run:

```bash BASH theme={null}
orchestrate server ssh
```

## Cleaning on-premises cache layers

Remove Docker image layers based on your `.env` file to free disk space and refresh cached images. Run:

```bash BASH theme={null}
orchestrate server images prune
```

<Expandable title="command flags">
  <ResponseField name="--all / -a" type="boolean" required={false}>
    Clears all layers in the CPD docker image layer cache.
  </ResponseField>

  <ResponseField name="--env-file / -e" type="string" required={false}>
    Path to your `.env` file. Required when not clearing all layers in the CPD docker image layer cache.
  </ResponseField>
</Expandable>

## Purging the server

To delete the underlying VM and start from scratch, run:

```bash BASH theme={null}
orchestrate server purge
```