|
(→Installation)
|
(→Installation)
|
| Line 65: | |||
| You will be prompted for an install location. You will need to have appropriate permissions to write to the location you select. | You will be prompted for an install location. You will need to have appropriate permissions to write to the location you select. | ||
| + | = Configuration = | ||
| + | Below lists the configurations for various scenarios. | ||
| + | == Client == | ||
| + | When the preflight client is run for the first time, it will ask for the configuration information it needs. This information is store persistently, per user, so that will not need to be reentered. | ||
| + | The preflight client be explicitly configured with the "config" command. Here are some example commands to configure anthill url, user, and password: | ||
| + | <pre> | ||
| + | C:\>preflight config url http://anthill.example.com/ | ||
| + | C:\>preflight config user bob | ||
| + | C:\>preflight config password p@ssw0rd | ||
| + | </pre> | ||
| + | The password option can also prompt for a password for increased security. | ||
| + | == Workflow == | ||
| + | In normal usage, the preflight system depends on steps added to the normal build workflow. These steps are in the Preflight folder: "Transfer Source Step" and "Transfer Artifacts Step". These steps should be added at appropriate points in your build job. | ||
| + | All steps, including preflight steps, have preflight flags in the "Additional Options" section of the step configuration. The first, "Run in Preflight", controls if the step is executed in a preflight build. Most steps will leave this on the default, true. The main exception would be artifact publishing steps. Artifacts from preflight builds are often not preserved on the server. | ||
| + | The second option, "Run in Preflight Only", controls if the step is executed only in a preflight build. Normal builds do not execute steps with set to true. By default, this option is false and most steps will use this setting. The exceptions are the two preflight steps. These should only be used in a preflight a build as the communicate with the preflight client. When configuring these steps, set "Run in Preflight Only" to true. | ||
| + | The preflight flags are not limited to any particular steps. This is useful, for example, for skipping packing steps not useful to a preflight user or publishing preflight artifacts to special artifact sets. | ||
