Installation Guide

Step-by-step guide to installing the OnePAM gateway and agent.

Deploy OnePAM in three steps: configure your onepam.com account, set up a Gateway, and deploy Agents on target hosts. The diagram below shows the deployment sequence and component relationships.

1 Sign Up Create your account on onepam.com. Configure teams, groups, and SSO. Dashboard API SSO then 2 Deploy Gateway Connection proxy handling SSH, RDP, HTTPS, DB. Connects to onepam.com. Session proxy S3 recordings then 3 Install Agents Deploy on each target server. Lightweight binary that reports to onepam.com. Metric export Secret store Agent Deployment Methods Linux curl | bash Docker ghcr.io/onepam Ansible Ansible Galaxy Puppet Puppet Forge Terraform Terraform Registry CloudFormation AWS Stack CLI & Package Managers Homebrew Scoop PowerShell GitHub Action Helm Chart Requirements: Linux kernel 4.9+ • amd64 or arm64 • Root or CAP_BPF capability • Outbound HTTPS to onepam.com

Choose Your Platform

Linux

Native installation on Linux servers with systemd service management.

Recommended
Ubuntu, Debian, RHEL, CentOS, Rocky

Container

Docker and Docker Compose deployments with host kernel access.

GA
Docker, Docker Compose

Infrastructure Automation

Deploy OnePAM agents at scale using your favourite infrastructure automation tools. Each module is available in its own GitHub repository.

Repositories: github.com/onepamcom/onepam-ansible github.com/onepamcom/onepam-puppet github.com/onepamcom/onepam-terraform

Ansible

Playbooks and roles for automated deployment across your fleet.

GA
ansible-galaxy install onepam.agent

Puppet

Puppet module with Hiera integration for enterprise deployments.

GA
puppet module install onepam-onepam

Terraform

Cloud-init scripts and modules for AWS, GCP, and Azure.

GA
registry.terraform.io/onepamcom

CLI & Package Managers

Install the OnePAM CLI on your workstation using your preferred package manager.

Homebrew

macOS and Linux via Homebrew tap.

brew install onepamcom/tap/onepam
onepamcom/homebrew-onepam
Scoop

Windows via Scoop bucket.

scoop bucket add onepam https://github.com/onepamcom/scoop-onepam
scoop install onepam
onepamcom/scoop-onepam
PowerShell Gallery

PowerShell module for Windows, macOS, and Linux.

Install-Module -Name OnePAM -Scope CurrentUser
PowerShell Gallery
GitHub Action

Install OnePAM CLI in CI/CD workflows.

- uses: onepamcom/setup-onepam-action@v1
  with:
    version: latest
GitHub Actions Marketplace
Helm Chart

Deploy the gateway on Kubernetes with Helm.

helm repo add onepam https://onepamcom.github.io/helm-charts
helm install gateway onepam/onepam-gateway
onepamcom/helm-charts
CloudFormation

Deploy the gateway on AWS with CloudFormation.

aws cloudformation deploy \
  --template-file cloudformation-gateway.yaml \
  --stack-name onepam-gateway
AWS CloudFormation Stack

Quick Start

For the fastest agent installation on Linux, run:

curl -sSL https://onepam.com/install/YOUR_ORG_UUID | sudo bash

Allow outbound HTTPS (443) to onepam.com and updates.onepam.com for verified agent downloads and updates.

For Docker deployments:

docker run -d --name onepam-agent --privileged --pid=host --network=host \
  -v /sys:/sys:ro -v /proc:/proc:ro \
  -e AGENT_API_URL=https://onepam.com \
  -e AGENT_TENANT_ID=00000000-0000-0000-0000-000000000000 \
  onepam/agent:latest

Platform Support

PlatformArchitectureMinimum KernelStatus
Linux (Standalone) amd64, arm64 4.9+ GA
Docker amd64, arm64 4.9+ (host) GA

Downloads

Agent binaries and installation scripts are available from the OnePAM update repository:

Linux (amd64)
onepam-agent-linux-amd64
Linux (arm64)
onepam-agent-linux-arm64
Docker Image
onepam/agent:latest
Browse All Downloads