readme.md

Teampass

Teampass is a Collaborative Passwords Manager

Copyright © 2009-2019, Nils Laumaillé

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

Requirements

• MySQL 5.1 or higher,
• PHP 5.5.0 or higher,
• PHP extensions:
  • mcrypt
  • openssl
  • ldap (if used)
  • mbstring
  • bcmath
  • iconv
  • xml
  • gd
  • openssl
  • curl

Usage

• Read installation related pages
• Once uploaded, launch Teampass in a browser and follow instructions.

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. You should also mount /var/php/session, otherwise the installation will freeze during Server checks phase. SSL is not provided if you use this image without a proxy in front of it. See the included Docker Compose file for an example setup.

Sample docker run command:

docker run --name teampass -d --restart always -v /var/teampass-data/www:/var/www/html -v /var/teampass-data/php_session:/var/php/session -p 9501:80 teampass/teampass

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

With Docker Compose

The included 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.

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.

Update

• Read upgrade related pages
• Once uploaded, launch install/upgrade.php and follow instructions.

Languages

Teampass is currently available in the following 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.

Licence Agreement

Before installing and using TeamPass, you must accept its licence defined as GNU AFFERO GPL.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program 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. See the GNU Affero General Public License for more details.

Read Licence

Website

Visit Teampass.net

Bugs

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

Requests

Please report feature requests in UserEcho.