📖
PixieBrix Documentation
📩

Managing Deployments

Mod Deployments

In PixieBrix, Deployments are the way to automatically provision Mods to Groups of users on your team.

For more information on creating/managing groups, see

Create a Deployment

👁️
For a Mod to be available for deployment, it must be either: 1. Defined under your team’s @scope, or 2. A Marketplace Mod See
🔒
Account Management
 for information setting your team’s scope
  1. On the Admin Console, click Deployments in the left side nav:
    2. image
  2. On the Deployments Listing page, click Create Deployment
    3. image
  3. In the Create Deployment modal, give your Deployment a Name
    4. ⚠️
    The deployment name will be visible to team members that receive the deployment
  4. Select the Mod version
  5. If required for the mod: provide activation options
  6. If required for the mod: select an integration configuration for each integration

Assign a Deployment to a Group(s)

Create a Group with Members

If the Group does not already exist, Create a Group. See

for information on how to create and manage groups.

Assign the Group to the Deployment

  1. On the Admin Console Team page, click Deployments in the left side nav:
    2. image
  2. Click on the Deployment in the list,
  3. On the Deployment detail screen, click on the Groups tab
    4. image
  4. At the top of the table, click the “Add Group"
    5. image
  5. If the Group does not already have access to the mod, integration configurations, and databases used by the deployment, PixieBrix will prompt you to grant permissions to the group.

Team Member Deployment Activation

⏱️
The PixieBrix Browser Extension checks every 5 min. for new/updated Deployments. Team members can also manually open the Extension Console to activate available deployments

Refer to

for Team Member instructions for activating deployments

Deactivating Deployments

⚠️
Deleting a Deployment will also delete its configuration and audit history. To temporarily deactivate a deployment, follow the steps below to pause or remove groups from the deployment.

There are two ways to temporarily deactivate a deployment:

  • Pause the deployment
  • De-provision groups from the deployment

Pausing a Deployment

  1. On the Admin Console Team page, click Deployments to go to the Deployments Listing page
    2. image
  2. Select the Deployment you want to deactivate
  3. To temporarily pause a deployment, toggle the "Active" state on the deployment detail page
    4. image

De-provisioning groups from the deployment

  1. On the Admin Console Team page, click Deployments to go to the Deployments Listing page
    2. image
  2. Select the Deployment you want to deactivate
  3. Click on Groups to view the Groups the Deployment is assigned to
    4. image
  4. Click Remove next to the Groups that you want to deactivate the deployment for.
    5. image
  5. To re-activate a Deployment, follow the "Assign the Group to the Deployment" instructions above

Extension Console: End-User Deployment Deactivation

ℹ️
Restricted members of organizations cannot uninstall deployments
✉️
PixieBrix can be configured to send email alerts when an individual team member de-activates a Deployment. To configure this, contact support@pixiebrix.com

Individual Team Members can de-activate a deployment from the Active Mods screen in the Extension Console

  1. Find the Deployment in the Active Team Deployments section
  2. Click the 3-dot menu
image
  1. Click "Uninstall"
  2. To re-activate the Deployment, click "Activate" in the banner
image

X