Skip to content

Add README guidance for migrating to MXC Sessions #1435

Description

@samanthamsong

Problem

Users with an existing WSL-based OpenClaw Gateway do not have clear README guidance for moving to the native Windows Gateway running inside an MXC Session. The supported migration path, prerequisites, preservation guarantees, and recovery steps need to be explicit before MXC Sessions become the primary local setup model.

Proposed documentation

Add a migration section to the repository README that explains:

  • What an MXC Session is and why the local Gateway runs inside one.
  • Which Windows and MXC capabilities are required.
  • How to determine whether the current PC supports the migration.
  • How to migrate an existing WSL-based Gateway to a local Windows Gateway in an MXC Session.
  • Which Gateway configuration, credentials, identity, sessions, and user data are preserved or moved.
  • How the Companion App detects an existing installation and offers migration.
  • How to verify that the new Gateway and Windows Node are connected and healthy.
  • How to recover, retry, or roll back safely if migration fails.
  • How to continue connecting to an existing remote Gateway instead of migrating.
  • Known limitations and where to find diagnostics or support.

Acceptance criteria

  • The README contains a discoverable, step-by-step migration guide.
  • The guide clearly distinguishes the Gateway Session from per-tool process containment.
  • Prerequisites and unsupported configurations are documented before any destructive step.
  • Data-preservation and rollback behavior are stated explicitly.
  • Commands, UI labels, and paths match the shipping Companion App experience.
  • The guide links to the detailed architecture, setup, testing, and troubleshooting documentation where appropriate.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    P3Low-risk cleanup, docs, polish, ergonomics, or speculative feature.clawsweeper:needs-maintainer-reviewClawSweeper marked this issue as needing maintainer review before automation.clawsweeper:needs-product-decisionClawSweeper marked this issue as needing a product or behavior decision.clawsweeper:no-new-fix-prClawSweeper does not recommend queueing a new automated fix PR for this issue.issue-rating: 🌊 off-meta tidepoolIssue quality rating does not apply to this item.

    Type

    No type

    Fields

    Priority

    None yet

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions