Skip to content

Latest commit

 

History

History
52 lines (41 loc) · 2.27 KB

deploy-client.md

File metadata and controls

52 lines (41 loc) · 2.27 KB

DeployClient

The DeployClient provides a basic implementation of a client designed to interact with the WebAPI endpoints exposed by PolyDeploy to facilitate remote deployment of DNN modules. It demonstrates how the API key should be passed in the request and how after initiating an installation remotely the status of the install operation can be polled for updates.

Setup

To use the DeployClient the following three parameters are required:

  • TargetUri: the website URI of the DNN install you wish to target
  • APIKey: as the API Key of your API User
  • EncryptionKey: the Encryption Key of your API User

There are two ways to configure your deploy client: Configuration File and Commandline Variables.

Configuration File

Add the above three parameters to the DeployClient.exe.config, found in the same directory as DeployClient.exe.

Here is an example of a filled in DeployClient.Properites.Settings node. API and Encryption Keys have been redacted.

...
<DeployClient.Properties.Settings>
    <setting name="TargetUri" serializeAs="String">
        <value>http://mydevsite.dnndev.me/</value>
    </setting>
    <setting name="APIKey" serializeAs="String">
        <value>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</value>
    </setting>
    <setting name="EncryptionKey" serializeAs="String">
        <value>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</value>
    </setting>
</DeployClient.Properties.Settings>
...

Commandline Variables

When calling the Deploy Client, it is possible to pass in the above variables as arguments:

DeployClient.exe --target-uri http://mydevsite.dnndev.me/ --api-key XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX --encryption-key XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Usage

Out of the box the DeployClient will identify any .zip files in the directory that it is being run from.

  1. Place your module .zip files in the same directory as DeployClient.exe.
  2. Open DeployClient.exe and follow the prompts.

Additional Commandline Options

The DeployClient features a small number of options that can tailor it to different situations, these are detailed below.

  • --silent Don't print any output to stdout, don't prompt.
  • --no-prompt Don't prompt.
  • --help Display commandline help

These options can be used on the command line like so DeployClient.exe --silent.