aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7554b37
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# A mkosi-template for Bitwarden_RS
+
+This is a mkosi-template for
+[Bitwarden_RS](https://github.com/dani-garcia/bitwarden_rs). In order to set
+this up you need Mkosi >=5.
+
+To build this, run `sudo mkosi`. This will create a new container in
+`/var/lib/machines` called `bitwarden-rs`. Next you should symlink the
+`.nspawn`-config to `/etc/systemd/nspawn` using `sudo ln -s
+/var/lib/machines/bitwarden-rs.nspawn /etc/systemd/nspawn/`.
+
+After that you need to create the folders we mount into the image. This is
+`/etc/bitwarden_rs` and `/var/local/bitwarden_rs`. These should be owned by
+root, and have `700` set as permissions.
+
+Then you need to copy `etc/bitwarden_rs/bitwarden_rs.env` to
+`/etc/bitwarden_rs/`, and set all your variables. You also need to create a
+database (using PostgreSQL). Lastly you need to set up a web-proxy - see the
+[Bitwarden_RS wiki](https://github.com/dani-garcia/bitwarden_rs/wiki) for
+[examples](https://github.com/dani-garcia/bitwarden_rs/wiki/Proxy-examples).
+
+Now all you need to do is to run it - `machinectl start bitwarden-rs`. You can
+drop into the container to troubleshoot using `machinectl shell bitwarden-rs`,
+and you can view logs using `journalctl -M bitwarden-rs` from the host, or
+`journalctl -u bitwarden_rs` from inside the container.