Installing VibeSec

Installing VibeSec

Before developers can use VibeSec, you must install it on their development machines.

Choose the installation method based on how you plan to deploy VibeSec.

For manual installations on individual developer machines, OAuth is recommended. For centralized MDM or fleet deployments, API token authentication is recommended because it simplifies deployment and does not require developers to authenticate individually.

Installation methods

Method	Recommended for
Single-device installation using OAuth	Manual installations on individual developer machines. This is the recommended method for individual installations.
Single-device installation using API token	Individual installations where OAuth cannot be used or token authentication is required.
Organization-wide deployment	Centralized MDM or fleet deployments, such as deployments using Jamf, Microsoft Intune, Kandji, or another device management solution. API token authentication is recommended for this deployment method.
On-premises	Organizations using a self-hosted OX Security deployment.

Authentication methods

VibeSec supports OAuth and API token authentication. The recommended authentication method depends on how VibeSec is deployed.

Authentication method	Description
OAuth	Developers authenticate through their browser and sign in using their OX account. OAuth is recommended for manual installations on individual developer machines.
API token	VibeSec authenticates using a user-generated API token. API token authentication is recommended for MDM and fleet deployments because it enables centralized deployment without requiring each developer to complete an authentication flow.

For on-premises deployments, OAuth is not supported. VibeSec authenticates using an OX API key.