Documentation
Guides for building workflows and running deployments.
Getting Started
- Joining an OrganizationAccept an invitation, join with a code, or create your own organization in Coldsea Deploy.
- Signing InSign in to Coldsea Deploy, set up two-factor authentication and your account, and get back in if you lose your authenticator app.
- First DeploymentBuild a workflow in the Coldsea Deploy web app, publish it for your devices, and watch the run come back.
- Sign-in ProblemsWhat each sign-in error means, why some messages are deliberately vague, and what to do about each one.
- Key TermsWhat the words used across Coldsea Deploy mean, including client, desktop agent, and host.
- Getting HelpHow to reach support from inside Coldsea Deploy, what each request type is for, what a problem report sends, and what to do if you cannot sign in.
Task Library
- Templates, Tasks, and GroupsWhat the three kinds of building block are, why a template cannot go straight into a workflow, and how they relate.
- Installing from the MarketplaceFind a component in the Marketplace, install it into your organization, keep it up to date, and customize it.
- First-Party ComponentsThe ready-to-use components Coldsea publishes, and how to configure them.
- Writing a Custom ComponentAuthor your own component with a PowerShell script and parameters.
- Building Parameter FormsUse the visual builder to turn script variables into a configuration form.
- Driver and Firmware StepsConfigure the Install Driver Pack and Install BIOS Update components, and store a BIOS admin password for your organization.
Workflows
Deployments
- How Coldsea Deploy WorksWhy the web app has no run button, what the desktop agent does, and the two ways it reaches a machine.
- Deployment StatesWhat each deployment status means, which of them are normal, and what the Deployments view shows about a run.
- The DashboardWhat each panel on the Dashboard shows, how the time window changes the numbers, and which figure ignores it.
- Hosts and the Desktop AgentHow a machine becomes a host, what desktop agent enrollment means, and how to revoke a machine's agent credential.
Storage
Organization
- Managing Your TeamInvite people to your organization, handle join requests, change what someone can do, and remove access.
- Roles and PermissionsWhat each organization role can do, how to create your own custom roles, and which actions stay reserved for administrators and the owner.
- Single sign-on (SSO)Let your team sign in to Coldsea through your own identity provider, with access controlled from your IdP.
- Partner ProgramResell Coldsea Deploy to the organizations you manage at negotiated wholesale rates.
- Managing Client OrganizationsAdd client organizations, choose their tiers, work inside them on their behalf, and enable or disable them as a partner.
- Pushing Workflows and Components to ClientsPush a workflow or component from your partner organization to the client organizations you manage, preview what changes for each client, and follow the results.
- Updates From Your PartnerRecognize workflows and components your partner pushed to your organization, check whether your copy still matches theirs, and revert an update.
- Your PartnerSee which partner manages your organization, contact them, and end the partnership by subscribing to a plan of your own.
- API keysGive an integration read access to your workflows and runs, limited to the scopes it needs.
Billing
- Managing Your SubscriptionOpen your billing page, move to a higher plan, update payment details, and recover when a plan change does not appear.
- Plan Limits and UsageWhich resources your plan meters, how to read the usage meters, and what happens when you reach a limit.
- The Partner ProgramHow your billing changes when you join the Partner Program, how client changes affect your bill, and how to read your partner billing statement.