README

TeamPass 3

TeamPass is a Collaborative Passwords Manager solution installed On-Premise.

Copyright © 2009-2026, Nils Laumaillé

• Requirements
  • About PHP versions
• Installation
  • Traditional Installation (Recommended)
  • Docker
• Documentation
• Languages
• Licence Agreement
• Website
• Bugs

Requirements

• MySQL 5.7 or higher
• MariaDB 10.7 or higher
• PHP 8.2 or newer
• PHP extensions (required):
  • openssl
  • mysqli
  • mbstring
  • bcmath
  • iconv
  • xml
  • gd
  • curl
  • gmp
  • ldap (only if LDAP/AD authentication is used)
• PHP extensions (optional but recommended):
  • apcu — in-memory configuration cache, reduces database load on every request
  • redis — Redis-backed session storage for high-availability deployments
  • pcntl + posix — required to run the WebSocket daemon (real-time sync)
  • opcache — improves overall PHP performance

About PHP versions

TeamPass follows active PHP support. The master branch requires at least PHP 8.2 and is tested against PHP 8.3. Using the latest stable PHP release is strongly recommended for both security and performance.

Installation

Traditional Installation (Recommended)

Installing TeamPass directly on a PHP/MySQL server gives the best performance and the most control over your environment. This is the recommended approach for production deployments.

• 📖 Official Installation Guide — step-by-step instructions covering prerequisites, web server configuration, and first-run setup
• 📝 Community article — practical walkthrough for a typical Linux/Apache/MySQL stack
• 🎥 Video tutorial — visual installation walkthrough

Docker

Official images are available for containerized deployments. Docker is convenient for testing and isolated environments but may not deliver the same raw performance as a native installation.

• Docker Hub: teampass/teampass
• GitHub Container Registry: ghcr.io/nilsteampassnet/teampass
• 📖 Docker Installation Guide — configuration options, environment variables, and volumes
• 📖 Migration Guide — upgrading from older Docker setups

Documentation

✍️ Documentation is available.

Key documentation:

• Docker Installation - Complete Docker deployment guide
• Docker Migration - Upgrade from older versions
• Official Documentation - Full user and admin guides
• API Documentation - REST API reference

Languages

TeamPass is currently available in 20 languages:

• CATALAN
• CHINESE
• CZECH
• DUTCH
• ENGLISH
• ESTONIAN
• FRENCH
• GERMAN
• HUNGARIAN
• ITALIAN
• JAPANESE
• NORWEGIAN
• PORTUGUESE
• PORTUGUESE (BR)
• ROMANIAN
• RUSSIAN
• SPANISH
• TURKISH
• UKRAINIAN
• VIETNAMESE

Languages strings are managed at POEditor.com. Please participate to improving its translation by joining Teampass POEditor project.

Licence Agreement

For detailed information on the licenses of our dependencies and our licence policy, please see Detailed Licence Information.

Website

Visit Teampass.net

Bugs

If you discover bugs, please report them in Github Issues.

Support & Community

• 💬 Reddit Community
• 📧 Email
• 🐛 Issue Tracker
• 📖 Documentation