From 8414779c3d1b903981c3bc67f39c79be8b31af2f Mon Sep 17 00:00:00 2001
From: Nick Fox <njfox@users.noreply.github.com>
Date: Tue, 1 Jan 2019 01:22:26 +0000
Subject: [PATCH] Created Building binary (markdown)

---
 Building-binary.md | 79 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)
 create mode 100644 Building-binary.md

diff --git a/Building-binary.md b/Building-binary.md
new file mode 100644
index 0000000..e2003ca
--- /dev/null
+++ b/Building-binary.md
@@ -0,0 +1,79 @@
+## Dependencies
+- `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))
+- `NodeJS` (only when compiling the web-vault, install through your system's package manager or use the [prebuilt binaries](https://nodejs.org/en/download/))
+
+
+## Run/Compile
+```sh
+# Compile and run
+cargo run --release
+# or just compile (binary located in target/release/bitwarden_rs)
+cargo build --release
+```
+
+When run, the server is accessible in [http://localhost:80](http://localhost:80).
+
+### Install the web-vault
+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:
+
+*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):
+```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)"
+```
+
+- 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
+```
+
+- Then, build the Vault:
+
+```sh
+npm run sub:init
+npm install
+npm run dist
+```
+
+Finally copy the contents of the `build` folder into the `bitwarden_rs/web-vault` folder.
+
+## 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. See the Configuration section of this wiki 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)
+Install diesel-cli with cargo:
+```sh
+cargo install diesel_cli --no-default-features --features sqlite-bundled
+```
+
+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:
+```sh
+diesel migration redo
+
+# This step should be done automatically when using diesel-cli > 1.3.0
+# diesel print-schema > src/db/schema.rs
+```
\ No newline at end of file