Passwork documentation

This documentation is for system administrators, DevOps engineers, and developers working with Passwork — an enterprise password manager with Zero-Knowledge encryption.

Here you'll find guides on installation, configuration, API integration, and using Passwork as a secrets manager for your infrastructure and CI/CD pipelines.

Before installing Passwork, review the system requirements and choose the deployment method that fits your environment.

System requirements

Passwork is lightweight and runs efficiently on modest hardware. The exact configuration depends on your user count, data volume, and availability needs.

• Installation options — single-server, clustered, and high-availability setups
• Backup and log storage — recommendations for data retention and recovery

---

Installation

Choose between standard (automated) or manual installation depending on your requirements.

Standard installation

The fastest way to get Passwork running. Uses Docker on Linux or PowerShell on Windows Server for automated setup and simplified maintenance.

• Linux (Docker) — recommended for most deployments
• Windows Server (PowerShell) — automated installation via scripts

Manual installation

For environments requiring fine-grained control or custom configurations. Does not rely on Docker or PowerShell.

• Ubuntu
• Debian
• Alma / Rocky / CentOS
• Windows Server

---

Administration

Day-to-day management, troubleshooting, and advanced configuration.

• Troubleshooting — common issues and how to resolve them
• Background tasks — scheduled jobs and maintenance operations
• Email notifications — SMTP configuration and templates
• LDAP / Active Directory — directory integration for user sync
• Single Sign-On (SSO) — SAML, OAuth, and other identity providers
• Mobile applications — iOS and Android setup
• Audit logs — Syslog, Windows Event Viewer, and SIEM integration

---

API and integrations

Programmatic access to Passwork for automation, CI/CD, and third-party integrations.

• API overview — endpoints, authentication, and encryption
• Python connector — library for Python-based automation
• CLI utility — command-line tool for scripts and pipelines
• Docker image for CLI — containerized CLI for CI/CD
• Health check endpoint — monitoring and load balancer probes

---

Secret management

Using Passwork as a secrets manager for infrastructure and DevOps workflows.

• Introduction — Passwork as a secrets manager
• Core concepts — organizing and classifying secrets
• CLI for secrets — retrieving and rotating secrets via command line
• Python SDK — programmatic secret management
• Rotation practices — automating credential rotation
• CI/CD integrations — GitLab CI, GitHub Actions, Kubernetes
• Zero-Knowledge model — security architecture and implications
• Examples — ready-to-use scripts and templates
• FAQ — common questions and best practices

LLM version