# Orchardcore Deployment Remote > Skill for configuring remote deployment import and export in Orchard Core. Covers RemoteInstance, RemoteClient, RemoteInstanceService, RemoteClientService, deployment targets, API key handling, and remote deployment administration. Use this skill when requests mention Orchard Core Remote Deployment, remote import, remote export, RemoteInstance, RemoteClient, deployment API client, remote deployment target, or closely related Orchard Core implementation setup extension or troubleshooting work. Strong matches include work with OrchardCore.Deployment.Remote, OrchardCore.Deployment, IDeploymentTargetProvider, RemoteInstanceDeploymentTargetProvider, RemoteInstanceService, RemoteClientService, ExportRemoteInstanceController, and ImportRemoteInstanceController. It also helps with secure API keys, tenant configuration, and the source-backed patterns captured in this skill. - Skill: `crestapps/orchardcore-deployment-remote` (Agent Skill) - Install (CLI): `npx skillmds@latest add crestapps/orchardcore-deployment-remote` - Raw SKILL.md: https://api.skillmd.com/api/skills/crestapps/orchardcore-deployment-remote/raw - Safety review: pending - Works with: Claude Code, Claude.ai, OpenAI Codex - Category: Integrations & APIs - License: Apache-2.0 - Author: CrestApps (https://skillmd.com/u/crestapps) - Updated: 2026-09-10 - Page: https://skillmd.com/skills/crestapps/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 ```json { "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. ## Remote Import and Export Flow 1. Enable Deployment and Remote Deployment on both intended sites. 2. Create a remote client on the target site and record its client name and key securely. 3. Create a remote instance on the source with the target URL and matching credentials. 4. Build and validate a deployment plan on the source. 5. Select the remote instance as the deployment target and export. 6. Inspect the target site and deployment results before relying on automation. The module exposes import and export controllers plus the remote instance deployment target provider. Prefer the user interface for normal operations so permissions and validation remain in the intended request path. ## Use the Services in a Module Use the services only for a focused administrative integration: ```csharp using OrchardCore.Deployment.Remote.Services; namespace MyModule; public sealed class RemoteDeploymentLookup { private readonly RemoteInstanceService _remoteInstanceService; public RemoteDeploymentLookup(RemoteInstanceService remoteInstanceService) { _remoteInstanceService = remoteInstanceService; } public Task GetAsync(string id) { return _remoteInstanceService.GetRemoteInstanceAsync(id); } } ``` Use `GetRemoteInstanceAsync` for cached read-only lookup and `LoadRemoteInstanceAsync` when an update is intended. Create and update operations persist changes through the service instead of modifying a document list directly. ## Security and Troubleshooting On failure, verify remote URL reachability, TLS certificates, client name, credential pairing, enabled features, and permissions. Rotate an API key by updating both the remote client and every associated remote instance. Treat a deployment payload as sensitive until its content and target are confirmed. ## Service Responsibilities `RemoteInstanceService` has distinct read and update APIs. Use `GetRemoteInstanceListAsync` and `GetRemoteInstanceAsync` for cached immutable reads. Use `LoadRemoteInstanceListAsync` and `LoadRemoteInstanceAsync` before editing data, then use the service create, update, or delete methods to write through the document manager. `RemoteClientService` loads its persisted client list through YesSql and protects API keys using a data protector scoped to `OrchardCore.Deployment`. Call its create or update methods rather than serializing an API key into a custom content item. This preserves the module's credential-protection design. ## Plan Compatibility Remote deployment transports an Orchard deployment plan; it does not ensure that a target has every required module, feature, content definition, or external dependency. Before export, compare enabled features and package versions. Import foundational definitions first where a plan depends on them, and validate the target in a staging tenant. ## Operational Guardrails - Use a dedicated remote client for each source environment. - Restrict outbound network access to known destination hosts when possible. - Record the plan name and target in deployment audit logs without recording API keys. - Review remote instance URLs after domain migrations or reverse-proxy changes. - Rotate credentials immediately when a source site or administrator is retired. - Avoid bidirectional automatic deployment between two production sites. Remote deployment is appropriate for deliberate administration. It is not a general-purpose replication protocol or a substitute for database backups.