Skip to main content

Keep your passwords behind the firewall

Project description

TeamVault

TeamVault is an open-source web-based shared password manager for behind-the-firewall installation. It requires Python 3.10+ and PostgreSQL (with the unaccent extension).

Installation

apt-get install libffi-dev libldap2-dev libpq-dev libsasl2-dev python3.X-dev postgresql-contrib
pip install teamvault
teamvault setup
vim /etc/teamvault.conf
# note that the teamvault database user will need SUPERUSER privileges
# during this step in order to activate the unaccent extension
teamvault upgrade
teamvault plumbing createsuperuser
teamvault run

Update

pip install --upgrade teamvault
teamvault upgrade

Development

Start a PostgreSQL database

Create a database and superuser for TeamVault to use, for example by starting a Docker container:

docker run --rm --detach --publish=5432:5432 --name teamvault-postgres -e POSTGRES_USER=teamvault -e POSTGRES_PASSWORD=teamvault postgres:latest

Run Webpack to serve static files

To compile all JS & SCSS files, you'll need to install all required packages via bun (or yarn/npm) with node >= v18.

Use bun/yarn/npm run serve to start a dev server.

Note: Some MacOS users have reported errors when running the dev server via bun. In this case feel free to switch to NPM.

Configure your Virtualenv via uv

uv sync

Setup TeamVault

export TEAMVAULT_CONFIG_FILE=teamvault.cfg
teamvault setup
vim teamvault.cfg  # base_url = http://localhost:8000
                   # session_cookie_secure = False
                   # database config as needed
teamvault upgrade
teamvault plumbing createsuperuser

Start the development server

teamvault run

Now open http://localhost:8000

Scheduled background jobs

We use huey to run background jobs. This requires you to run a second process, in parallel to TeamVault itself. You can launch it via manage.py:

teamvault run_huey

Release process

  1. Bump the version in teamvault/__version__.py and pyproject.toml
  2. Update CHANGELOG.md with the new version and current date
  3. Make a release commit with the changes made above
  4. Push the commit
  5. Run ./build.sh to create a new package
  6. Sign and push the artifacts to PyPI via uv publish
  7. Test that the package can be installed: uv run --isolated --no-cache --prerelease allow --with teamvault --no-project -- teamvault --version
  8. Add a new GitHub release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

teamvault-0.10.0.tar.gz (13.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

teamvault-0.10.0-py3-none-any.whl (13.7 MB view details)

Uploaded Python 3

File details

Details for the file teamvault-0.10.0.tar.gz.

File metadata

  • Download URL: teamvault-0.10.0.tar.gz
  • Upload date:
  • Size: 13.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.6

File hashes

Hashes for teamvault-0.10.0.tar.gz
Algorithm Hash digest
SHA256 c536e3ee425d538795f53817ab6ed149ea2ca7c8e19703b89f1fc22c8af214bd
MD5 a746a2006afa4045538ca18fa14a98f7
BLAKE2b-256 7329aa5868770ad4bcd13b7dc17a3268857521ed39703efb130e48d4c98d80b7

See more details on using hashes here.

File details

Details for the file teamvault-0.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for teamvault-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 675d5f00a87eb72fca0c19641509c236d53a7fb29264611cc60142b6763ea402
MD5 095d45dcd1386b1e18949e411e2f42ce
BLAKE2b-256 b93d43889e528a188f99db996330a95334cb21a47f3d4997b1bf47af19620cc5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page