summaryrefslogtreecommitdiffstats
path: root/docs/reference/plugins/validation/http
diff options
context:
space:
mode:
authorWouterTinus <wouter.tinus@gmail.com>2019-08-25 13:42:13 +0200
committerWouterTinus <wouter.tinus@gmail.com>2019-08-25 13:42:13 +0200
commit13a0fbf3870fa3686abc8a1ff435f66e503bb03f (patch)
tree636340db52d1179de3e98397ccc4069ac956edba /docs/reference/plugins/validation/http
parent9f42509dcc27c70dc4df4fce1c310a0f575ae0a7 (diff)
downloadletsencrypt-win-simple-13a0fbf3870fa3686abc8a1ff435f66e503bb03f.zip
letsencrypt-win-simple-13a0fbf3870fa3686abc8a1ff435f66e503bb03f.tar.gz
letsencrypt-win-simple-13a0fbf3870fa3686abc8a1ff435f66e503bb03f.tar.bz2
test include
Diffstat (limited to 'docs/reference/plugins/validation/http')
-rw-r--r--docs/reference/plugins/validation/http/filesystem.md10
-rw-r--r--docs/reference/plugins/validation/http/ftps.md10
-rw-r--r--docs/reference/plugins/validation/http/index.md16
-rw-r--r--docs/reference/plugins/validation/http/selfhosting.md13
-rw-r--r--docs/reference/plugins/validation/http/sftp.md10
-rw-r--r--docs/reference/plugins/validation/http/webdav.md10
6 files changed, 63 insertions, 6 deletions
diff --git a/docs/reference/plugins/validation/http/filesystem.md b/docs/reference/plugins/validation/http/filesystem.md
index 9cbb12c..b5d61ca 100644
--- a/docs/reference/plugins/validation/http/filesystem.md
+++ b/docs/reference/plugins/validation/http/filesystem.md
@@ -1,3 +1,11 @@
---
sidebar: reference
---- \ No newline at end of file
+---
+
+# Filesystem
+This plugin saves the validation challenge to a local path, which may of course also be a network path.
+
+{% include webconfig.md %}
+
+## Unattended
+`--validation filesystem [--validationsiteid x] [--webroot c:\httpdocs\]` \ No newline at end of file
diff --git a/docs/reference/plugins/validation/http/ftps.md b/docs/reference/plugins/validation/http/ftps.md
index 9cbb12c..4e2e430 100644
--- a/docs/reference/plugins/validation/http/ftps.md
+++ b/docs/reference/plugins/validation/http/ftps.md
@@ -1,3 +1,11 @@
---
sidebar: reference
---- \ No newline at end of file
+---
+
+# FTP(S)
+This plugin uploads the validation challenge to a (secure) FTP server.
+
+{% include webconfig.md %}
+
+## Unattended
+`--validation ftp --webroot ftps://x/ --username admin --password ******` \ No newline at end of file
diff --git a/docs/reference/plugins/validation/http/index.md b/docs/reference/plugins/validation/http/index.md
index 9cbb12c..71a67b9 100644
--- a/docs/reference/plugins/validation/http/index.md
+++ b/docs/reference/plugins/validation/http/index.md
@@ -1,3 +1,17 @@
---
sidebar: reference
---- \ No newline at end of file
+---
+
+# HTTP validation
+HTTP validation works as follows:
+- For each domain, e.g. `sub.example.com`, the ACME server provides a
+challenge consisting of an `x` and `y` value (it's a little more complicated than that,
+but for the sake of this explanation it will suffice).
+- The client has to make sure that when the ACME server makes a request
+to `http://sub.example.com/.well-known/acme-challenge/x`, the answer will be exactly `y`.
+- The validation request is *always* made to port 80, that cannot be changed.
+- There may be more than one validation request for the same token, e.g. from
+different locations or different protocols (IPv4/IPv6).
+- Let's Encrypt does *not* disclose the source locations of these requests, which
+effectively means that the domain has to be accessible for the public,
+at least for the duration of the validation. \ No newline at end of file
diff --git a/docs/reference/plugins/validation/http/selfhosting.md b/docs/reference/plugins/validation/http/selfhosting.md
index 9cbb12c..649c248 100644
--- a/docs/reference/plugins/validation/http/selfhosting.md
+++ b/docs/reference/plugins/validation/http/selfhosting.md
@@ -1,3 +1,14 @@
---
sidebar: reference
---- \ No newline at end of file
+---
+
+# Self-hosting
+This plugin launches a temporary built-in web listener that stores the
+validation response in memory. It can share port 80 with IIS and
+other (Microsoft) software so this doesn't interfere with regular traffic.
+Not all software supports this port sharing feature though. If you get errors
+telling you that the listener cannot be started, please look for another
+validation method.
+
+## Unattended
+`[--validation selfhosting]` \ No newline at end of file
diff --git a/docs/reference/plugins/validation/http/sftp.md b/docs/reference/plugins/validation/http/sftp.md
index 9cbb12c..bb5e74a 100644
--- a/docs/reference/plugins/validation/http/sftp.md
+++ b/docs/reference/plugins/validation/http/sftp.md
@@ -1,3 +1,11 @@
---
sidebar: reference
---- \ No newline at end of file
+---
+
+# SFTP
+This plugin uploads the validation challenge to a SSH FTP / SFTP server.
+
+{% include webconfig.md %}
+
+## Unattended
+`--validation sftp --webroot ftps://x/ --username admin --password ******` \ No newline at end of file
diff --git a/docs/reference/plugins/validation/http/webdav.md b/docs/reference/plugins/validation/http/webdav.md
index 9cbb12c..a317635 100644
--- a/docs/reference/plugins/validation/http/webdav.md
+++ b/docs/reference/plugins/validation/http/webdav.md
@@ -1,3 +1,11 @@
---
sidebar: reference
---- \ No newline at end of file
+---
+
+# SFTP
+This plugin pushes the validation challenge to a WebDav path.
+
+{% include webconfig.md %}
+
+## Unattended
+`--validation webdav --webroot ftps://x/ --username admin --password ******` \ No newline at end of file