Skip to content

Commit

Permalink
mention --upstream-update
Browse files Browse the repository at this point in the history
  • Loading branch information
niklasf committed Aug 25, 2024
1 parent d27aa3a commit 1d9d6c6
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,11 @@ Webservice to query https://haveibeenpwned.com/ database dumps.
Usage
-----

Download a database dump using [haveibeenpwned-downloader](https://github.com/HaveIBeenPwned/PwnedPasswordsDownloader):
Download a database dump using [haveibeenpwned-downloader](https://github.com/HaveIBeenPwned/PwnedPasswordsDownloader)
and import it:

```
haveibeenpwned-downloader pwned-passwords-sha1-ordered-by-hash-v8 -p 64
```

Import a database dump:

```
cargo run --release -- --source pwned-passwords-sha1-ordered-by-hash-v8.txt --compact
```

Expand All @@ -23,9 +19,12 @@ For local testing, `test.txt` contains the single password `test`.
Serve:

```
cargo run --release -- --bind 127.0.0.1:1337
cargo run --release -- --bind 127.0.0.1:1337 --upstream-update
```

With the `--upstream-update` flag, entries are slowly but continuously updated
from the upstream API (about 1 month for a full update cycle).

HTTP API
--------

Expand Down

0 comments on commit 1d9d6c6

Please sign in to comment.