Keycyte PAM 3.2 · Deployment Guide
About This Guide
This guide describes how to plan, install and configure Keycyte PAM, and how to upgrade and back it up.
The guide applies to Keycyte PAM 3.2. Keycyte PAM runs as a set of Docker containers that are started with Docker Compose on a Linux host.
Intended Audience
The guide is intended for system administrators and IT engineers who deploy and maintain Keycyte PAM. You should be familiar with Linux administration, Docker, TLS certificates and your network environment.
Contents
| Section | Description |
|---|---|
| Architecture | Keycyte PAM components and the paths that user connections take. |
| Planning and Preparation | System requirements, network ports, certificates and licensing. |
| Installation | Preparing the installation package, running the installer and signing in for the first time. |
| Initial Configuration | Licence, Web TLS certificate, notifications, directory services and service access keys. |
| High Availability | Running several Keycyte PAM nodes with one master node. |
| Backup and Restore | Backing up the configuration database and restoring it. |
| Configuration Reference | config.yaml settings and KEYCYTE_* environment variables. |
| Troubleshooting | Service logs, certificate reset and common issues. |
Document Conventions
Note
Notes give additional information about the topic.
Important
Important notes describe conditions that must be met before you continue; ignoring them can cause data loss or service interruption.
Tip
Tips describe an easier or better way of doing something.
Warning
Warnings describe actions that can cause data loss or a security risk.