Deployment Portal

The Deployment Portal is the setup page opened from a deployment link. It shows the platforms and setup methods allowed by that link, collects deployer-provided inputs, and displays the generated commands or templates.

The environment owner performs the environment-owned setup with their own cloud or cluster access. The setup API checks the selected choices again; the browser is not the access-control mechanism.

your backend creates link
          │
          ▼
environment owner opens portal
          │  chooses an allowed platform and setup method
          ▼
generated setup runs with the owner's credentials
          │
          ▼
deployment checks in

What to configure

In the dashboard, configure the portal branding and support or documentation links under the project’s deployment settings. The exact fields shown in the portal come from the current project and release.

Generate a deployment link

Create links from your backend with a server-side Alien Platform API key. The common case needs only the project and your stable ID and name for the environment:

import { Alien } from "@alienplatform/platform-api"

const alien = new Alien({ apiKey: process.env.ALIEN_API_KEY })

const setup = await alien.setupLinks.create({
  project: "my-project",
  externalId: environment.id,
  name: environment.slug,
})

return setup.deploymentLink

Read deploymentLink from the response. Reusing an externalId reuses the same deployment group; each request creates a new revocable link for it.

By default, Alien derives the available platforms from the release and allows its supported setup methods. Add deploymentSetupConfig.policy only to restrict those choices. Add setupItems: "all" when one portal should include the application plus every capability enabled for the project.

Test the handoff

Before sending a link:

1. publish the release;
2. generate a link limited to the platforms and setup items you support;
3. open it in a clean browser profile;
4. complete setup in a test environment;
5. confirm the deployment checks in and one safe operation succeeds.

See Customer setup and Google Cloud setup.