README

Teampass 3

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

Copyright © 2009-2025, Nils Laumaillé

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

Requirements

• MySQL 5.7 or higher,
• MariaDB 10.7 or higher
• PHP 8.1 or newer,
• PHP extensions:
  • mcrypt
  • openssl
  • ldap (if used)
  • mbstring
  • bcmath
  • iconv
  • xml
  • gd
  • mysql
  • curl
  • gmp

About PHP versions

Teampass should be installed using the most recent PHP version. The branch master is the living one that is improved and comes with new features. It requires at least PHP 8.1 installed on the server.

Nevertheless, Teampass can be used with PHP 7.4 version. The Github Teampass project has a dedicated branch called PHP_7.4 for this version. Notice that only bug fixing will be performed on this branch.

Installation

Docker (Recommended)

The easiest way to run Teampass is using Docker. We provide official images on Docker Hub with production-ready configurations.

Quick Start:

# Download compose files
curl -O https://raw.githubusercontent.com/nilsteampassnet/TeamPass/master/docker/docker-compose/docker-compose.yml
curl -O https://raw.githubusercontent.com/nilsteampassnet/TeamPass/master/docker/docker-compose/.env.example

# Configure
cp .env.example .env
nano .env  # Set secure passwords

# Start Teampass
docker-compose up -d

Available registries:

• Docker Hub: teampass/teampass
• GitHub Container Registry: ghcr.io/nilsteampassnet/teampass

📚 Complete Docker Documentation:

• Docker Installation Guide - Complete guide with configuration options
• Migration Guide - Upgrade from older Docker versions
• Docker Hub - Official images and tags

Key Features:

• ✅ Optimized Alpine-based image (PHP 8.3-FPM + Nginx)
• ✅ Automatic SSL support with Let's Encrypt
• ✅ Health checks and monitoring
• ✅ Optional automatic installation
• ✅ Persistent volumes for data safety

Traditional Installation

For traditional server installations without Docker:

Resources:

• 📖 Official Documentation
• 📝 Website article: TeamPass Installation Guide
• 🎥 YouTube video: Installation Tutorial

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 19 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