Document in readme

agora-org · Sep 22, 2021 · 9b19b64 · 9b19b64
1 parent 5fae6d8
commit 9b19b64
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -68,6 +68,11 @@ This produces a statically linked binary that runs on, e.g., Alpine and CentOS L
 You can configure the network port and address `agora` listens on, and the directory it serves.
 See `agora --help` for details.
 
+### HTTPS Configuration
+
+If you're running `agora` on a public domain it can be configured to automatically request TLS certificates for HTTPS from [Let's Encrypt](https://letsencrypt.org/) via the [ACME](https://datatracker.ietf.org/doc/html/rfc8555) protocol.
+See the `--acme-*` and `--https-*` flags in `agora --help` for details.
+
 ### LND Configuration
 
 By default `agora` serves files for free.

diff --git a/src/tests.rs b/src/tests.rs
@@ -1093,7 +1093,3 @@ fn redirects_requests_from_port_80_to_443() {
     },
   );
 }
-
-#[test]
-#[ignore]
-fn feature_is_documented_in_readme() {}