Teampass

Collaborative Passwords Manager

Code Quality Rank: L2

Programming language: PHP

License: GNU General Public License v3.0 only

Tags: Manager     Passwords     Collaborative    

Latest version: v3.0.0.7

README

Teampass 3

Teampass is a Collaborative Passwords Manager

Copyright © 2009-2022, [Nils Laumaillé]([email protected])

<!-- MDTOC maxdepth:2 firsth1:0 numbering:0 flatten:0 bullets:1 updateOnSave:1 -->

• Requirements
  
• Usage
  
  • With Docker
    
  • With Docker Compose
    
• Update
  
• Languages
  
• Licence Agreement
  
• Website
  
• Bugs
  
• Requests
  

<!-- /MDTOC -->

Requirements

• MySQL 5.7 or higher,
• Mariadb 10.7 or higher
• PHP 7.4 or higher,
• PHP extensions:
  • mcrypt
  • openssl
  • ldap (if used)
  • mbstring
  • bcmath
  • iconv
  • xml
  • gd
  • openssl
  • curl

Documentation

• Read V3 documentation

With Docker

The Docker image provided will create a Teampass installation in its /var/www/html/ directory, which you should mount as a volume to keep persistent. SSL is not provided if you use this image without a proxy in front of it. See the included [Docker Compose file](docker-compose.yml) for an example setup.

Note: Use /var/www/html/sk as your "Absolute path to saltkey" during installation.

With Docker Compose

The included [docker-compose.yml](docker-compose.yml) file is an example setup, using virtual host-based reverse proxy routing to provide SSL. If you want to use the Compose file as-is, you will need to provide an SSL certificate with a CN matching the teampass service's VIRTUAL_HOST variable. See the documentation for the jwilder/nginx-proxy image for details. In short, you'll need to put your certificate file (with extension .crt, e.g. teampass.domain.local.crt) and the according private key file (with extension .key, e.g. teampass.domain.local.key) into the directory ssl, named exactly after the FQDN you put into the VIRTUAL_HOST variable. Make sure to restart the nginx service after changes to the certificate or at least signal it with the reload command: docker-compose exec nginx nginx -s reload.

Note: As you might have noticed, the docker hub image of teampass is currently sort of unmaintained as of Feb 2022. Therefore the docker-compose example provided here will build the teampass image out of the latest sources of this repository. When the docker hub image is getting built again, you may comment out build: . and remove the comment for image: teampass/teampass. We'll inform you here once that's the case.

Note: The database's hostname is db. You can find the database's credentials in the environment variables of the db service.

Note: Use /var/www/html/sk as your "Absolute path to saltkey" during installation.

Languages

Teampass is currently available in the following languages:

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

Languages strings are managed at POEditor.com.

Licence Agreement

Licence defined as GNU General Public License v3.0 only.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

[Read Licence](license.md)

Website

Visit Teampass.net

Bugs

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