aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 13 insertions, 13 deletions
diff --git a/README.md b/README.md
index 7554b37..d210eaa 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,25 @@
-# A mkosi-template for Bitwarden_RS
+# A mkosi-template for Vaultwarden
This is a mkosi-template for
-[Bitwarden_RS](https://github.com/dani-garcia/bitwarden_rs). In order to set
+[Vaultwarden](https://github.com/dani-garcia/vaultwarden). 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
+`/var/lib/machines` called `vaultwarden`. Next you should symlink the
`.nspawn`-config to `/etc/systemd/nspawn` using `sudo ln -s
-/var/lib/machines/bitwarden-rs.nspawn /etc/systemd/nspawn/`.
+/var/lib/machines/vaultwarden.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
+`/etc/vaultwarden` and `/var/local/vaultwarden`. 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
+Then you need to copy `etc/vaultwarden/vaultwarden.env` to
+`/etc/vaultwarden/`, 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).
+[vaultwarden wiki](https://github.com/dani-garcia/vaultwarden/wiki) for
+[examples](https://github.com/dani-garcia/vaultwarden/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.
+Now all you need to do is to run it - `machinectl start vaultwarden`. You can
+drop into the container to troubleshoot using `machinectl shell vaultwarden`,
+and you can view logs using `journalctl -M vaultwarden` from the host, or
+`journalctl -u vaultwarden` from inside the container.