Deployer
User guide

Create a workspace

The creation dialog, the choice of mode, the three-step wizard and the welcome checklist, up to a workspace ready to use.

Checked in the application on September 5, 2026

A workspace is created in a minute, then made usable in three steps of which only one is required: connecting GitLab. The rest is finished in the wizard, or later in the configuration.

Create the workspace

Who can ViewerProduct ownerDeveloperManagerAdministrator

Any signed-in user can create a workspace: they become its administrator, and gain no right anywhere else.

The creation dialog. The right panel explains the selected mode, trait by trait.
The creation dialog. The right panel explains the selected mode, trait by trait.
The New workspace dialog: the form on the left, the deployment mode explanation on the right

Drag to pan the screenshot

  1. Open the dialog

    On the home page, click the dashed “Create a workspace” card at the end of the grid. With no workspace at all, a central button replaces it.

    The dashed Create a workspace card
  2. Name the workspace

    The Name is required, the Description free. Both can be changed later in the configuration.

    The Name and Description fields
  3. Choose the deployment mode

    Branch-based or Tag-based. The right panel says, for the selected mode, what deployment, build, environment, versions and hotfix become, and reminds you in grey what the other mode would do. If you hesitate, the section The two deployment modes of the previous page compares them.

    The two cards Branch-based and Tag-based
  4. Name the main branch

    master is suggested. Case matters, and the branch does not need to exist in your repositories yet: it is declarative. Then “Create”.

    The Main branch field
The same dialog in tag mode. The right panel changes with the selected mode.
The same dialog in tag mode. The right panel changes with the selected mode.
The same dialog with the Tag-based mode selected: the right panel describes the build on the tag and the separate rollout

Drag to pan the screenshot

On creation, Deployer builds three things at once: the workspace, its main branch as the first tracked branch, and your membership as an administrator. You are then sent into the workspace, where the wizard is waiting.

The wizard: three steps, one required

Who can Administrator

The wizard opens on the first step not yet completed. A bar at the top shows the three steps and their badge, “Required” for the connection, “Optional” for the other two. “Skip this step” skips an optional step; “Back” returns to the previous one.

Step 1 of the wizard. The help on the right says which token to create.
Step 1 of the wizard. The help on the right says which token to create.
The Initialise the workspace wizard, on the GitLab connection step, with the Which token should I create? help on the right

Drag to pan the screenshot

Step 1: GitLab connection

  1. Create the token on the GitLab side

    Deployer acts on GitLab with a token that must have the api scope. If all your projects are in a single GitLab group, create a Group Access Token on that group. If they are spread across several groups, create a service account (a bot user, member of each group) and its personal token. Avoid a real person’s personal token: it breaks the workspace the day they leave.

    The Which token should I create? panel
  2. Fill in the instance and the token

    Instance URL over HTTPS, without credentials or query parameters. Access token as GitLab generated it. The token is never shown again afterwards.

    The Instance URL and Access token fields
  3. Test and connect

    “Test and connect” checks the URL and the token against GitLab before saving them. On refusal, a red panel says which of the two is at fault: token refused, insufficient rights, unreachable instance, quota reached. Once the connection is established, the same button becomes “Continue”, and coming back to this step does not query GitLab again.

    The Test and connect button

Step 2: Linked projects

The catalogue lists the GitLab projects the token can see, with a search and pages of twenty. GitLab returns no total: you browse page by page. Tick the repositories the workspace should drive, then “Link N projects”.

Step 2. The projects the token can see, to tick.
Step 2. The projects the token can see, to tick.
The Linked projects step of the wizard: the search, the list of GitLab projects with their checkboxes

Drag to pan the screenshot

A linked project is a repository Deployer writes to: it pushes branches, creates tags and opens merge requests there. The project carrying your tickets usually has no reason to be one; it is declared elsewhere, as an issue source (see Configure a workspace).

Step 3: Environments

The step declares the deployment targets, in promotion order. Its shape depends on the mode.

Step 3. The presets only show on a still-empty workspace.
Step 3. The presets only show on a still-empty workspace.
The Environments step of the wizard, with the presets and the list of stages

Drag to pan the screenshot

Drag the rows to change the promotion order. The main branch is shown but cannot be changed here. Every action is sent immediately: there is no “Save” button in the wizard.

  1. Finish

    “Finish and open the workspace” is enabled as soon as GitLab is connected. It takes you to the workspace home: the checklist if something remains to do, the Deployments screen otherwise.

    The Finish and open the workspace button

The welcome checklist

As long as the workspace is connected but incomplete, its home shows “Finish the configuration”: three rows with their badge, a progress bar, and one button per row.

The checklist. A completed item carries “View”, an item still to do carries “Configure”.
The checklist. A completed item carries “View”, an item still to do carries “Configure”.
The welcome checklist, with the three items GitLab connection, Link projects, Declare environments

Drag to pan the screenshot

ItemBadge while not doneWhat completes it
GitLab connectionREQUIREDThe saved connection. The card then shows the URL, the bot and the token prefix.
Link projectsRECOMMENDEDAt least one linked project.
Declare environmentsOPTIONALAt least one environment. A tracked branch alone does not count.

“Configure” reopens the wizard at the right step; “View” opens the matching configuration section. “Explore the workspace without finishing the setup” leads to Deployments: without that exit, an optional step never done would bring you back to the checklist on every arrival.

As soon as the workspace has a connection and at least one project, the checklist disappears: arriving in the workspace opens Deployments directly.

What comes next

The workspace is created, connected and linked. What remains is what the wizard does not do, and which is set in the configuration: the allowed source branches and the variables of each environment, the naming patterns for tags and hotfix branches, the issue sources, the OAuth application. And the team, invited from the Members screen.

A workspace created by mistake is deleted from the danger zone of the configuration, by retyping its name, or from its card menu on the home page.