# VaultWarden •

Cross-platform password management and secure document storage.

# Overview

[![Capture.PNG](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/capture.PNG)](https://hub.subspace.services/uploads/images/gallery/2025-03/capture.PNG)

[BitWarden](https://bitwarden.com) is a password manager that can securely store your sensitive data. Create a family vault for passwords and securely share access private documents.

- Sync your passwords and secure data across all of your devices and browsers.
- Handle two factor authentication for your websites using the built-in TOTP feature.
- Generate strong passwords and passphrases on-the-fly and save them later.

# Media

## Screenshots

<p class="callout info">VaultWarden v2024.6.2</p>

<table border="1" id="bkmrk-" style="border-collapse: collapse; width: 100%; border-width: 1px; height: 59.6px; border-color: rgb(88, 110, 117);"><colgroup><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col></colgroup><tbody><tr style="height: 29.8px;"><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Capture.PNG](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/capture.PNG)](https://hub.subspace.services/uploads/images/gallery/2025-03/capture.PNG)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Capture1.PNG](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/capture1.PNG)](https://hub.subspace.services/uploads/images/gallery/2025-03/capture1.PNG)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Capture2.PNG](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/capture2.PNG)](https://hub.subspace.services/uploads/images/gallery/2025-03/capture2.PNG)</td></tr><tr style="height: 29.8px;"><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Capture3.PNG](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/capture3.PNG)](https://hub.subspace.services/uploads/images/gallery/2025-03/capture3.PNG)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Capture4.PNG](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/capture4.PNG)](https://hub.subspace.services/uploads/images/gallery/2025-03/capture4.PNG)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">  
</td></tr></tbody></table>

# Setup & Configuration

We need to install the service through Portainer and configure any necessary settings.

# Preparation

There are some things we need to do in preparation to install this service.

## Volumes

<details id="bkmrk-media-folders-radarr"><summary>Persistent Data</summary>

This is where the service will store its own application data and ensures we can quickly update the service image.

<p class="callout warning">Ensure your user has permissions to access the folder.</p>

</details>## Environment

<details id="bkmrk-tz-this-is-the-curre"><summary>TZ</summary>

This is the current time zone formatted using the [tz database.](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)

<p class="callout info">*For example:* America/Vancouver</p>

</details><details id="bkmrk-signups_allowed-we-n"><summary>SIGNUPS\_ALLOWED</summary>

We need to temporarily enable this setting to allow us to create a new account with the service.

</details>

# Installation

The service can be installed through the Portainer web interface.

<p class="callout info">Learn about [creating a new stack](https://hub.subspace.services/books/portainer/page/creating-a-new-stack "Creating a New Stack").</p>

## Docker Compose

Use the following code to install the service:

```yaml
---
services:
  vaultwarden:
    image: vaultwarden/server:latest
    container_name: vaultwarden
    network_mode: bridge
    environment:
      - TZ=America/Vancouver
      - SIGNUPS_ALLOWED=true
    ports:
      - 2546:80
    volumes:
      - /srv/vaultwarden:/data
    restart: unless-stopped
```

# Updating

<p class="callout warning">Backup and Re-Deploy the Stack</p>

VaultWarden has been optimized for [running in Docker](https://github.com/dani-garcia/vaultwarden/wiki/Updating-the-vaultwarden-image). This allows you to [re-deploy the stack through Portainer](https://hub.subspace.services/books/portainer/page/updating-a-stack "Updating a Stack") to download the latest updates.

Due to the important nature of this data, it is always crucial to perform a full backup before upgrading.

# User Manual

# Development

<p class="callout info">This software is released under the [AGPL 3.0 license](https://opensource.org/license/agpl-3-0).</p>

The software is an open-source implementation of the BitWarden API, making it compatible with all BitWarden official apps. An active [VaultWarden developers is an employee of BitWarden](https://github.com/dani-garcia/vaultwarden#disclaimer) and contributes in their free time. BitWarden is itself [open-source](https://bitwarden.com/open-source/) and involved in the community.

You can learn more about how to contribute to VaultWarden through their [documentation](https://github.com/dani-garcia/vaultwarden?tab=readme-ov-file#get-in-touch).

The lead developer also accepts [sponsorships](https://github.com/dani-garcia).

# Resources

## VaultWarden

- [Official Documentation](https://github.com/dani-garcia/vaultwarden/wiki)
- [Official Matrix Chat](https://matrix.to/#/#vaultwarden:matrix.org)
- [Official Forum](https://vaultwarden.discourse.group/)
- [Official GitHub Repository](https://github.com/dani-garcia/vaultwarden)
- [Installation Guide](https://github.com/dani-garcia/vaultwarden#usage)
- [Frequently Asked Questions](https://github.com/dani-garcia/vaultwarden/wiki/FAQs)

## BitWarden

- [Official Documentation](https://bitwarden.com/help/)
- [Official Forum](https://community.bitwarden.com/)
- [Official GitHub Repository](https://github.com/bitwarden)
- [Official Website](https://bitwarden.com/)
- [Wikipedia Entry](https://en.m.wikipedia.org/wiki/Bitwarden)
- [Frequently Asked Questions](https://bitwarden.com/help/product-faqs/)