orchardcore-deployment-remote

Orchard Core Remote Deployment

OrchardCore.Deployment.Remote extends the Deployment module with remote import and export. It registers RemoteInstanceService, RemoteClientService, an IDeploymentTargetProvider, HTTP client support, admin navigation, and permissions. Remote deployments should be treated as privileged administrative operations because they can move site configuration and content.

Guidelines

• Enable OrchardCore.Deployment.Remote; its manifest depends on OrchardCore.Deployment.
• Configure a remote client on the destination and a remote instance on the source.
• Use HTTPS remote URLs and unique high-entropy API keys.
• Give remote-deployment permissions only to trusted administrators or service accounts.
• A RemoteInstance stores a remote URL, client name, and API key; protect access to all three.
• RemoteClientService protects client API keys with a time-limited data protector before persistence.
• RemoteInstanceService stores remote instance data through its document manager.
• Never copy an API key into public recipes, theme files, or application logs.
• Test with a non-production tenant before exchanging a production deployment plan.

Enable Remote Deployment

{
  "steps": [
    {
      "name": "Feature",
      "enable": [
        "OrchardCore.Deployment",
        "OrchardCore.Deployment.Remote"
      ],
      "disable": []
    }
  ]
}

Remote Clients and Instances

A destination remote client is represented by RemoteClient:

Property	Meaning
Id	Generated identifier.
ClientName	Name selected by a remote instance.
ProtectedApiKey	Data-protected API-key bytes.

A source remote instance is represented by RemoteInstance:

Property	Meaning
Name	Admin-facing instance name.
Url	Remote Orchard base URL.
ClientName	Destination client identity.
ApiKey	Credential used against the remote client.

Create matching credentials at both ends through the remote deployment admin screens. The client name and API key must match. Do not assume a remote instance record itself grants access; the remote site must have a client that accepts its credentials.