summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorsanine <sanine.not@pm.me>2023-05-15 00:28:26 -0500
committersanine <sanine.not@pm.me>2023-05-15 00:28:26 -0500
commitd63d171f17f24706d2952d1b705f4c2e41fd3318 (patch)
tree5896357a7945e60aed9688949c5128b5a3e28852 /README.md
parent9a88b91c8ac9098597d516c8064604075ece2213 (diff)
add usage to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 498cfbc..e0b95b7 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,17 @@ this is intended for simple use cases, like if you have a weird little web app t
security concerns that you'd still like to be able to access on the public internet.
+usage
+-----
+
+phlox supports the following command-line flags:
+
+ * `-c CONFIG_FILE` - set the config file to use
+ * `--passwd` - generate a json object with the argon2id hash of the given password
+ * this will cause phlox to output json and exit without running the server
+ * `--user` - optionally set the username to use with the --passwd option
+
+
configuration
-------------