AllSafeX Documentation
Welcome to the AllSafeX documentation hub. Find architecture guides, step-by-step installation instructions, security policies, and troubleshooting resources.
Getting Started
Understand the core design principles and system components that make AllSafeX a modern, scalable privileged access management solution.
Product Introduction
Learn about AllSafeX core capabilities, credential injection, session isolation, and operational compliance.
System Architecture
Detailed breakdown of AllSafeX Control Plane, Web Console, Web Terminal, SSH Gateway (port 2222), Remote Desktop Gateway, Postgres & Redis.
Installation Guides
Deploy the AllSafeX backend or install native desktop client applications on your workstation.
Server Installation
Deploy AllSafeX using Docker Compose, initialize databases, and start backend services.
Linux Desktop (.deb)
Install the official AllSafeX-1.0.0-x64.deb package on Debian, Ubuntu, and Linux Mint.
Windows Desktop (.exe / .msi)
Install via standard Setup wizard (.exe) or deploy silently across your domain using Group Policy (.msi).
Configuration & Security
Customize system behavior, configure database connections, enforce multi-factor authentication, and harden security.
Application Configuration
Configure config.yml, public URLs, token lifetimes, Redis caches, and SMTP mail alerts.
Authentication & MFA
Set up TOTP authenticator apps, enforce password strength, and manage user credential lifecycles.
Security Model
Zero-trust principles, role-based access control (RBAC), TLS hardening, and least privilege guidelines.
Operations & Support
Perform day-to-day privileged tasks, onboard target servers, review audit trails, or resolve technical issues.
Secure SSH Access
Connect to onboarded Linux servers via the AllSafeX SSH Gateway on port 2222 with interactive menus or direct commands.
Sessions & Auditing
Monitor active administrator sessions, execute live disconnections, and review terminal recordings.
Troubleshooting
Diagnose container health checks, database connection timeouts, and port conflicts.
Dedicated Support
Access verified support channels, report bugs on GitHub, and review escalation procedures.
Quick CLI Reference
Common commands for administrators managing an AllSafeX cluster:
# Check status of all AllSafeX services
docker compose ps
# View real-time logs for the Core backend service
docker compose logs -f core --tail=100
# Connect to target infrastructure via SSH gateway
ssh -p 2222 admin@pam.company.com
# Check version of the Linux desktop client
allsafex-pam --version