bw_web_builds/README.md
BlackDex 726bd1debf
Update Readme
Update the readme to match the main Vaultwarden repo.
2024-11-04 23:20:44 +01:00

6.4 KiB

Web Vault builds for Vaultwarden

Vaultwarden Logo

Scripts and CI to patch (including branding) and build the Bitwarden web client [disclaimer], to make it compatible with Vaultwarden.


GitHub Release ghcr.io Pulls Docker Pulls
GHA Release Contributors Forks Stars Issues Open Issues Closed
Matrix Chat GitHub Discussions Discourse Discussions GPL-3.0 Licensed

Important

When using this web-vault, please report any bugs or suggestions directly to us (see Get in touch), regardless of whatever other clients you are using (mobile, desktop, browser...). DO NOT use the official Bitwarden support channels.


Building the web-vault

To build the web-vault you need either node and npm installed or use Docker.

Using node and npm

For a quick and easy local build you could run:

make full

That will generate a tar.gz file within the builds directory which you can extract and use with the WEB_VAULT_FOLDER environment variable.

Using a container

Or via the usage of building via a container:

make container-extract

That will extract the tar.gz and files generated via Docker into the container_builds directory.

Which container command to use, docker or podman

The default is to use docker, but podman works too.

You can force them by replacing container with either docker or podman, like:

make docker-extract
# Or
make podman-extract

You can configure the default via a .env file. See the .env.template.
Or you can set it as a make argument with the make command:

make CONTAINER_CMD=podman container-extract

More information

For more information see: Install the web-vault

Pre-build

The builds are available in the releases page, and can be replicated with the scripts in this repo.


Get in touch

Have a question, suggestion or need help? Join our community on Matrix, GitHub Discussions or Discourse Forums.

Encountered a bug or crash? Please search our issue tracker and discussions to see if it's already been reported. If not, please start a new discussion or create a new issue. Ensure you're using the latest version of Vaultwarden and there aren't any similar issues open or closed!


Disclaimer

This project is not associated with Bitwarden or Bitwarden, Inc.

However, one of the active maintainers for Vaultwarden is employed by Bitwarden and is allowed to contribute to the project on their own time. These contributions are independent of Bitwarden and are reviewed by other maintainers.

The maintainers work together to set the direction for the project, focusing on serving the self-hosting community, including individuals, families, and small organizations, while ensuring the project's sustainability.

Please note: We cannot be held liable for any data loss that may occur while using Vaultwarden. This includes passwords, attachments, and other information handled by the application. We highly recommend performing regular backups of your files and database. However, should you experience data loss, we encourage you to contact us immediately.