bitwarden_rs/BUILD.md

82 lines
3.1 KiB
Markdown
Raw Normal View History

2018-07-13 09:48:49 +00:00
# Build instructions
## Dependencies
2018-07-09 13:09:30 +00:00
- `Rust nightly` (strongly recommended to use [rustup](https://rustup.rs/))
- `OpenSSL` (should be available in path, install through your system's package manager or use the [prebuilt binaries](https://wiki.openssl.org/index.php/Binaries))
2018-12-13 16:46:08 +00:00
- `NodeJS` (only when compiling the web-vault, install through your system's package manager or use the [prebuilt binaries](https://nodejs.org/en/download/))
2018-05-25 15:15:31 +00:00
2018-07-09 13:09:30 +00:00
## Run/Compile
2018-05-25 15:15:31 +00:00
```sh
2018-07-09 13:09:30 +00:00
# Compile and run
2018-12-13 16:46:08 +00:00
cargo run --release
2018-07-09 13:09:30 +00:00
# or just compile (binary located in target/release/bitwarden_rs)
cargo build --release
2018-05-25 15:15:31 +00:00
```
2018-07-09 13:09:30 +00:00
When run, the server is accessible in [http://localhost:80](http://localhost:80).
2018-05-25 15:15:31 +00:00
2018-07-09 13:09:30 +00:00
### Install the web-vault
2018-12-13 16:46:08 +00:00
A compiled version of the web vault can be downloaded from [dani-garcia/bw_web_builds](https://github.com/dani-garcia/bw_web_builds/releases).
If you prefer to compile it manually, follow these steps:
2018-12-14 19:32:11 +00:00
*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.*
2018-12-13 16:46:08 +00:00
- Clone the git repository at [bitwarden/web](https://github.com/bitwarden/web) and checkout the latest release tag (e.g. v2.1.1):
```sh
# clone the repository
git clone https://github.com/bitwarden/web.git web-vault
cd web-vault
# switch to the latest tag
git checkout "$(git tag | tail -n1)"
```
2018-05-25 15:15:31 +00:00
- Download the patch file from [dani-garcia/bw_web_builds](https://github.com/dani-garcia/bw_web_builds/tree/master/patches) and copy it to the `web-vault` folder.
To choose the version to use, assuming the web vault is version `vX.Y.Z`:
- If there is a patch with version `vX.Y.Z`, use that one
- Otherwise, pick the one with the largest version that is still smaller than `vX.Y.Z`
- Apply the patch
```sh
# In the 'web-vault' directory
git apply vX.Y.Z.patch
2018-05-25 15:15:31 +00:00
```
2018-12-13 16:46:08 +00:00
- Then, build the Vault:
2018-05-25 15:15:31 +00:00
```sh
npm run sub:init
2018-05-25 15:15:31 +00:00
npm install
npm run dist
2018-05-25 15:15:31 +00:00
```
Finally copy the contents of the `build` folder into the `bitwarden_rs/web-vault` folder.
2018-05-25 15:15:31 +00:00
2018-07-09 13:09:30 +00:00
# Configuration
The available configuration options are documented in the default `.env` file, and they can be modified by uncommenting the desired options in that file or by setting their respective environment variables. Look at the README file for the main configuration options available.
Note: the environment variables override the values set in the `.env` file.
## How to recreate database schemas (for developers)
2018-05-25 15:15:31 +00:00
Install diesel-cli with cargo:
```sh
2018-07-09 13:09:30 +00:00
cargo install diesel_cli --no-default-features --features sqlite-bundled
2018-05-25 15:15:31 +00:00
```
Make sure that the correct path to the database is in the `.env` file.
If you want to modify the schemas, create a new migration with:
```
diesel migration generate <name>
```
Modify the *.sql files, making sure that any changes are reverted in the down.sql file.
Apply the migrations and save the generated schemas as follows:
2018-07-09 13:09:30 +00:00
```sh
2018-05-25 15:15:31 +00:00
diesel migration redo
2018-07-09 13:09:30 +00:00
# This step should be done automatically when using diesel-cli > 1.3.0
# diesel print-schema > src/db/schema.rs
```