Merge pull request #291 from mqus/patch-1

Add memory usage note to the vault build documentation
This commit is contained in:
Daniel García 2018-12-14 22:56:44 +01:00 committed by GitHub
commit a335bcd682
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -21,6 +21,8 @@ A compiled version of the web vault can be downloaded from [dani-garcia/bw_web_b
If you prefer to compile it manually, follow these steps: If you prefer to compile it manually, follow these steps:
*Note: building the Vault needs ~1.5GB of RAM. On systems like a RaspberryPI with 1GB or less, please [enable swapping](https://www.tecmint.com/create-a-linux-swap-file/) or build it on a more powerful machine and copy the directory from there. This much memory is only needed for building it, running bitwarden_rs with vault needs only about 10MB of RAM.*
- Clone the git repository at [bitwarden/web](https://github.com/bitwarden/web) and checkout the latest release tag (e.g. v2.1.1): - Clone the git repository at [bitwarden/web](https://github.com/bitwarden/web) and checkout the latest release tag (e.g. v2.1.1):
```sh ```sh
# clone the repository # clone the repository
@ -37,6 +39,7 @@ git apply /path/to/bitwarden_rs/docker/set-vault-baseurl.patch
``` ```
- Then, build the Vault: - Then, build the Vault:
```sh ```sh
npm run sub:init npm run sub:init
npm install npm install