synced/vaultwarden-bw_web_builds
1
0
Fork 0
mirror of https://github.com/dani-garcia/bw_web_builds.git synced 2025-03-14 10:16:34 +00:00
Code Issues Packages Projects Releases Wiki Activity
vaultwarden-bw_web_builds/README.md

96 lines
6.4 KiB
Markdown
Raw Permalink Normal View History

Update README.md
2021-04-30 21:00:37 +02:00
# Web Vault builds for Vaultwarden
Initial commit
2018-12-13 14:09:59 +01:00
Update Readme Update the readme to match the main Vaultwarden repo.
2024-11-04 23:20:44 +01:00
![Vaultwarden Logo](https://raw.githubusercontent.com/dani-garcia/vaultwarden/refs/heads/main/resources/vaultwarden-logo-auto.svg)
Initial commit
2018-12-13 14:09:59 +01:00
Update Readme Update the readme to match the main Vaultwarden repo.
2024-11-04 23:20:44 +01:00
Scripts and CI to patch (including branding) and build the [Bitwarden web client](https://github.com/bitwarden/clients/tree/main/apps/web) [[disclaimer](#disclaimer)], to make it compatible with [Vaultwarden](https://github.com/dani-garcia/vaultwarden).
Update web-vault to v2022.05.0 and misc changes - Updated web-vault to v2022.05.0 - Made several changes to the build scripts for ease of building/patching etc... You can now run `make checkout` to pull/update the repo to the wanted version There is also a `make patch-web-vault` to patch the repo A `make generate-patch` to create a patch file from the current changes And many more changes
2022-06-02 20:26:42 +02:00
---
Update Readme Update the readme to match the main Vaultwarden repo.
2024-11-04 23:20:44 +01:00
[![GitHub Release](https://img.shields.io/github/release/dani-garcia/bw_web_builds.svg?style=for-the-badge&logo=vaultwarden&color=005AA4)](https://github.com/dani-garcia/bw_web_builds/releases/latest)
[![ghcr.io Pulls](https://img.shields.io/badge/dynamic/json?style=for-the-badge&logo=github&logoColor=fff&color=005AA4&url=https%3A%2F%2Fipitio.github.io%2Fbackage%2Fdani-garcia%2Fbw_web_builds%2Fbw_web_builds.json&query=%24.downloads&label=ghcr.io%20pulls&cacheSeconds=14400)](https://github.com/dani-garcia/bw_web_builds/pkgs/container/bw_web_builds)
[![Docker Pulls](https://img.shields.io/docker/pulls/vaultwarden/web-vault.svg?style=for-the-badge&logo=docker&logoColor=fff&color=005AA4&label=docker.io%20pulls)](https://hub.docker.com/r/vaultwarden/web-vault) <br>
[![GHA Release](https://img.shields.io/github/actions/workflow/status/dani-garcia/bw_web_builds/release.yml?style=flat-square&logo=github&logoColor=fff&label=Build%20Workflow)](https://github.com/dani-garcia/bw_web_builds/actions/workflows/release.yml)
[![Contributors](https://img.shields.io/github/contributors-anon/dani-garcia/bw_web_builds.svg?style=flat-square&logo=vaultwarden&color=005AA4)](https://github.com/dani-garcia/bw_web_builds/graphs/contributors)
[![Forks](https://img.shields.io/github/forks/dani-garcia/bw_web_builds.svg?style=flat-square&logo=github&logoColor=fff&color=005AA4)](https://github.com/dani-garcia/bw_web_builds/network/members)
[![Stars](https://img.shields.io/github/stars/dani-garcia/bw_web_builds.svg?style=flat-square&logo=github&logoColor=fff&color=005AA4)](https://github.com/dani-garcia/bw_web_builds/stargazers)
[![Issues Open](https://img.shields.io/github/issues/dani-garcia/bw_web_builds.svg?style=flat-square&logo=github&logoColor=fff&color=005AA4&cacheSeconds=300)](https://github.com/dani-garcia/bw_web_builds/issues)
[![Issues Closed](https://img.shields.io/github/issues-closed/dani-garcia/bw_web_builds.svg?style=flat-square&logo=github&logoColor=fff&color=005AA4&cacheSeconds=300)](https://github.com/dani-garcia/bw_web_builds/issues?q=is%3Aissue+is%3Aclosed) <br>
[![Matrix Chat](https://img.shields.io/matrix/vaultwarden:matrix.org.svg?style=flat-square&logo=matrix&logoColor=fff&color=953B00&cacheSeconds=14400)](https://matrix.to/#/#vaultwarden:matrix.org)
[![GitHub Discussions](https://img.shields.io/github/discussions/dani-garcia/vaultwarden?style=flat-square&logo=github&logoColor=fff&color=953B00&cacheSeconds=300)](https://github.com/dani-garcia/vaultwarden/discussions)
[![Discourse Discussions](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fvaultwarden.discourse.group%2F&style=flat-square&logo=discourse&color=953B00)](https://vaultwarden.discourse.group/)
[![GPL-3.0 Licensed](https://img.shields.io/github/license/dani-garcia/bw_web_builds.svg?style=flat-square&logo=vaultwarden&color=944000&cacheSeconds=14400)](https://github.com/dani-garcia/bw_web_builds/blob/main/LICENSE.txt)
Update web-vault to v2022.05.0 and misc changes - Updated web-vault to v2022.05.0 - Made several changes to the build scripts for ease of building/patching etc... You can now run `make checkout` to pull/update the repo to the wanted version There is also a `make patch-web-vault` to patch the repo A `make generate-patch` to create a patch file from the current changes And many more changes
2022-06-02 20:26:42 +02:00
Initial commit
2018-12-13 14:09:59 +01:00
Update Readme Update the readme to match the main Vaultwarden repo.
2024-11-04 23:20:44 +01:00
> [!IMPORTANT]
> **When using this web-vault, please report any bugs or suggestions directly to us (see [Get in touch](#get-in-touch)), regardless of whatever other clients you are using (mobile, desktop, browser...). DO NOT use the official Bitwarden support channels.**
Added warning when no HTTPS during register. We already had a patch to warn users they need HTTPS when they login. This was not working for the register form. - Added a warning during the submit of the register form. - Changed the check to see if `crypto.subtle` is defined or not. - Removed the `webpack.config.js` patch, since this now is in upstream. - Updated README.md shields and small comment regarding how to create the patch because of changes to the submodule.
2021-02-20 13:59:07 +01:00
Update Readme Update the readme to match the main Vaultwarden repo.
2024-11-04 23:20:44 +01:00
---
Added warning when no HTTPS during register. We already had a patch to warn users they need HTTPS when they login. This was not working for the register form. - Added a warning during the submit of the register form. - Changed the check to see if `crypto.subtle` is defined or not. - Removed the `webpack.config.js` patch, since this now is in upstream. - Updated README.md shields and small comment regarding how to create the patch because of changes to the submodule.
2021-02-20 13:59:07 +01:00
Update web-vault to v2022.05.0 and misc changes - Updated web-vault to v2022.05.0 - Made several changes to the build scripts for ease of building/patching etc... You can now run `make checkout` to pull/update the repo to the wanted version There is also a `make patch-web-vault` to patch the repo A `make generate-patch` to create a patch file from the current changes And many more changes
2022-06-02 20:26:42 +02:00
## Building the web-vault
Update Readme Update the readme to match the main Vaultwarden repo.
2024-11-04 23:20:44 +01:00
Update web-vault to v2022.05.0 and misc changes - Updated web-vault to v2022.05.0 - Made several changes to the build scripts for ease of building/patching etc... You can now run `make checkout` to pull/update the repo to the wanted version There is also a `make patch-web-vault` to patch the repo A `make generate-patch` to create a patch file from the current changes And many more changes
2022-06-02 20:26:42 +02:00
To build the web-vault you need either node and npm installed or use Docker.
### Using node and npm
Update Readme Update the readme to match the main Vaultwarden repo.
2024-11-04 23:20:44 +01:00
Update web-vault to v2022.05.0 and misc changes - Updated web-vault to v2022.05.0 - Made several changes to the build scripts for ease of building/patching etc... You can now run `make checkout` to pull/update the repo to the wanted version There is also a `make patch-web-vault` to patch the repo A `make generate-patch` to create a patch file from the current changes And many more changes
2022-06-02 20:26:42 +02:00
For a quick and easy local build you could run:
```bash
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.
Misc changes Some misc changes. - Moved old patch files to a `legacy` sub-folder - If a legacy patch is used, show a warning and pause for 10 seconds - Updated the checkout and Dockerfile so both use the same way of cloning the Bitwarden/client repo - Updated the `patch_web_vault.sh` script to try and detect the vault version - Added two new make commands to prepare and release a new version - Added a `.env` feature for the `Makefile` to set some defaults Mainly used for using either `docker` or `podman` and for the GitHub Release script to have a predefined GPG user/key
2023-12-18 17:09:47 +01:00
### Using a container
Update Readme Update the readme to match the main Vaultwarden repo.
2024-11-04 23:20:44 +01:00
Misc changes Some misc changes. - Moved old patch files to a `legacy` sub-folder - If a legacy patch is used, show a warning and pause for 10 seconds - Updated the checkout and Dockerfile so both use the same way of cloning the Bitwarden/client repo - Updated the `patch_web_vault.sh` script to try and detect the vault version - Added two new make commands to prepare and release a new version - Added a `.env` feature for the `Makefile` to set some defaults Mainly used for using either `docker` or `podman` and for the GitHub Release script to have a predefined GPG user/key
2023-12-18 17:09:47 +01:00
Or via the usage of building via a container:
```bash
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
Update Readme Update the readme to match the main Vaultwarden repo.
2024-11-04 23:20:44 +01:00
Misc changes Some misc changes. - Moved old patch files to a `legacy` sub-folder - If a legacy patch is used, show a warning and pause for 10 seconds - Updated the checkout and Dockerfile so both use the same way of cloning the Bitwarden/client repo - Updated the `patch_web_vault.sh` script to try and detect the vault version - Added two new make commands to prepare and release a new version - Added a `.env` feature for the `Makefile` to set some defaults Mainly used for using either `docker` or `podman` and for the GitHub Release script to have a predefined GPG user/key
2023-12-18 17:09:47 +01:00
The default is to use `docker`, but `podman` works too.
You can force them by replacing `container` with either `docker` or `podman`, like:
Update web-vault to v2022.05.0 and misc changes - Updated web-vault to v2022.05.0 - Made several changes to the build scripts for ease of building/patching etc... You can now run `make checkout` to pull/update the repo to the wanted version There is also a `make patch-web-vault` to patch the repo A `make generate-patch` to create a patch file from the current changes And many more changes
2022-06-02 20:26:42 +02:00
```bash
make docker-extract
Misc changes Some misc changes. - Moved old patch files to a `legacy` sub-folder - If a legacy patch is used, show a warning and pause for 10 seconds - Updated the checkout and Dockerfile so both use the same way of cloning the Bitwarden/client repo - Updated the `patch_web_vault.sh` script to try and detect the vault version - Added two new make commands to prepare and release a new version - Added a `.env` feature for the `Makefile` to set some defaults Mainly used for using either `docker` or `podman` and for the GitHub Release script to have a predefined GPG user/key
2023-12-18 17:09:47 +01:00
# Or
make podman-extract
```
You can configure the default via a `.env` file. See the `.env.template`.<br>
Or you can set it as a make argument with the make command:
```bash
make CONTAINER_CMD=podman container-extract
Update web-vault to v2022.05.0 and misc changes - Updated web-vault to v2022.05.0 - Made several changes to the build scripts for ease of building/patching etc... You can now run `make checkout` to pull/update the repo to the wanted version There is also a `make patch-web-vault` to patch the repo A `make generate-patch` to create a patch file from the current changes And many more changes
2022-06-02 20:26:42 +02:00
```
### More information
Update Readme Update the readme to match the main Vaultwarden repo.
2024-11-04 23:20:44 +01:00
Update README.md
2021-04-30 21:00:37 +02:00
For more information see: [Install the web-vault](https://github.com/dani-garcia/vaultwarden/wiki/Building-binary#install-the-web-vault)
Added warning when no HTTPS during register. We already had a patch to warn users they need HTTPS when they login. This was not working for the register form. - Added a warning during the submit of the register form. - Changed the check to see if `crypto.subtle` is defined or not. - Removed the `webpack.config.js` patch, since this now is in upstream. - Updated README.md shields and small comment regarding how to create the patch because of changes to the submodule.
2021-02-20 13:59:07 +01:00
Update Readme Update the readme to match the main Vaultwarden repo.
2024-11-04 23:20:44 +01:00
Update web-vault to v2022.05.0 and misc changes - Updated web-vault to v2022.05.0 - Made several changes to the build scripts for ease of building/patching etc... You can now run `make checkout` to pull/update the repo to the wanted version There is also a `make patch-web-vault` to patch the repo A `make generate-patch` to create a patch file from the current changes And many more changes
2022-06-02 20:26:42 +02:00
### Pre-build
Update Readme Update the readme to match the main Vaultwarden repo.
2024-11-04 23:20:44 +01:00
Initial commit
2018-12-13 14:09:59 +01:00
The builds are available in the [releases page](https://github.com/dani-garcia/bw_web_builds/releases), and can be replicated with the scripts in this repo.
Update web-vault to v2022.05.0 and misc changes - Updated web-vault to v2022.05.0 - Made several changes to the build scripts for ease of building/patching etc... You can now run `make checkout` to pull/update the repo to the wanted version There is also a `make patch-web-vault` to patch the repo A `make generate-patch` to create a patch file from the current changes And many more changes
2022-06-02 20:26:42 +02:00
<br>
## Get in touch
Update Readme Update the readme to match the main Vaultwarden repo.
2024-11-04 23:20:44 +01:00
Have a question, suggestion or need help? Join our community on [Matrix](https://matrix.to/#/#vaultwarden:matrix.org), [GitHub Discussions](https://github.com/dani-garcia/vaultwarden/discussions) or [Discourse Forums](https://vaultwarden.discourse.group/).
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](https://github.com/dani-garcia/vaultwarden/discussions) or [create a new issue](https://github.com/dani-garcia/vaultwarden/issues/). Ensure you're using the latest version of Vaultwarden and there aren't any similar issues open or closed!
<br>
## Disclaimer
**This project is not associated with [Bitwarden](https://bitwarden.com/) 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.
Update web-vault to v2022.05.0 and misc changes - Updated web-vault to v2022.05.0 - Made several changes to the build scripts for ease of building/patching etc... You can now run `make checkout` to pull/update the repo to the wanted version There is also a `make patch-web-vault` to patch the repo A `make generate-patch` to create a patch file from the current changes And many more changes
2022-06-02 20:26:42 +02:00
Update Readme Update the readme to match the main Vaultwarden repo.
2024-11-04 23:20:44 +01:00
**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.
Reference in New Issue Copy Permalink