aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2021-10-27 22:30:37 -0400
committerJesse Luehrs <doy@tozt.net>2021-10-27 22:35:30 -0400
commite566ed23bdd494c9f5ed118328f0f38bbd06d441 (patch)
tree7a4d3b348fd969f14dfaae6878bfd092a736bb6f
parenta6df5378b91516aabbb5643e41e688a0dc1aaeb7 (diff)
downloadrbw-e566ed23bdd494c9f5ed118328f0f38bbd06d441.tar.gz
rbw-e566ed23bdd494c9f5ed118328f0f38bbd06d441.zip
add documentation for rbw register
-rw-r--r--README.md8
-rw-r--r--src/bin/rbw/main.rs10
2 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index 5cb74e9..b0879a7 100644
--- a/README.md
+++ b/README.md
@@ -81,6 +81,14 @@ out by running `rbw purge`, and you can explicitly lock the database by running
`rbw help` can be used to get more information about the available
functionality.
+*Note to users of the official Bitwarden server (at bitwarden.com)*: The
+official server has a tendency to detect command line traffic as bot traffic
+(see [this issue](https://github.com/bitwarden/cli/issues/383) for details). In
+order to use `rbw` with the official Bitwarden server, you will need to first
+run `rbw register` to register each device using `rbw` with the Bitwarden
+server. This will prompt you for your personal API key which you can find using
+the instructions [here](https://bitwarden.com/help/article/personal-api-key/).
+
## Related projects
* [rofi-rbw](https://github.com/fdw/rofi-rbw): A rofi frontend for Bitwarden
diff --git a/src/bin/rbw/main.rs b/src/bin/rbw/main.rs
index 0f2d13e..85631c5 100644
--- a/src/bin/rbw/main.rs
+++ b/src/bin/rbw/main.rs
@@ -17,7 +17,15 @@ enum Opt {
config: Config,
},
- #[structopt(about = "Register this device with the Bitwarden server")]
+ #[structopt(
+ about = "Register this device with the Bitwarden server",
+ long_about = "Register this device with the Bitwarden server\n\n\
+ The official Bitwarden server includes bot detection to prevent \
+ brute force attacks. In order to avoid being detected as bot \
+ traffic, you will need to use this command to log in with your \
+ personal API key (instead of your password) first before regular \
+ logins will work."
+ )]
Register,
#[structopt(about = "Log in to the Bitwarden server")]