Skip to content

Commit 6bae80a

Browse files
committed
Add notify parameters to the Documentation
1 parent b0f7278 commit 6bae80a

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.adoc

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,20 @@ In this handler are the following modules in use.
3131
|is the maximum size in bytes allowed for the upload.
3232
It accepts all size values supported by https://pkg.go.dev/github.com/dustin/go-humanize#pkg-constants[go-humanize]. Reads of
3333
more bytes will return an error with HTTP status 413.
34+
35+
|**notify_url**
36+
|After a successful upload will this URL be called. The only supported schema is **https**.
37+
38+
|**notify_method**
39+
|The default method is `GET`. If you need to make a `POST` request please open a feature issue
40+
as for now is a request body handling not implemented
41+
42+
|**insecure**
43+
|This boolean flag configure the `InsecureSkipVerify` in the https://pkg.go.dev/crypto/tls#Config[tls-config] .
44+
Default is false which implies that a valid CA must be used
45+
46+
|**capath**
47+
|This is the Parameter where you can define the CA for the **notify_url**.
3448
|===
3549

3650
### JSON
@@ -50,15 +64,15 @@ will I write here the config in JSON Syntax.
5064
----
5165
<1> Destination Directory on the Server site
5266
<2> Maximal possible upload size
53-
<3> the response template which will be used for respose after upload
67+
<3> the response template which will be used for response after upload
5468

5569
A full working example is in
5670
`docker-files/opt/webroot/config/Caddyfile-upload.json`
5771

5872
### Caddyfile
5973

60-
Here a example Caddyfile which expected that he environment variable
61-
`APPORT` is set.
74+
Here a example Caddyfile which expects that the environment variable
75+
`APPPORT` is set.
6276

6377
[source]
6478
----

0 commit comments

Comments
 (0)