caddyv2-upload

APPPORT

The Port on which Caddyserver should listen. The format depends which Configuration file format you use. See the official Caddyserver documentation for the format Network addresses

SKIP_LOG

With this variable can you control if the health check will be logged or not. This feature was implemented as part of the vars handler.

dest_dir

The directory in which the files will be uploaded

root_dir

The root directory for this module. When not set will the root directory be evaluated at runtime from this variable http.vars.root.

file_field_name

The field name for the multi-part form upload

fixed_file_name

When set, all uploaded files will be renamed to the provided file name.

response_template

The response template after a upload was successfully

max_form_buffer

The maximum buffer size for ParseMultipartForm. It accepts all size values supported by go-humanize. Here can also be used a Placeholder
JSON: "{env.MAXBUFFSIZE}"
Caddyfile: {$MAXBUFFSIZE}

The default size is 1G.

max_form_buffer_int

The maximum buffer size for ParseMultipartForm.
The default size is 1G.

max_filesize

is the maximum size in bytes allowed for the upload. It accepts all size values supported by go-humanize. Reads of more bytes will return an error with HTTP status 413. Here can also be used a Placeholder
JSON: "{env.MAXFILESIZE}"
Caddyfile: {$MAXFILESIZE}

The default size is 1G.

max_filesize_int

is the maximum size in bytes allowed for the upload. Reads of more bytes will return an error with HTTP status 413.
The default size is 1G.

notify_url

After a successful upload will this URL be called. The only supported schema is https.

notify_method

The default method is GET. If you need to make a POST request please open a feature issue as for now is a request body handling not implemented

insecure

This boolean flag configure the InsecureSkipVerify in the tls-config . Default is false which implies that a valid CA must be used

capath

This is the Parameter where you can define the CA filename for the notify_url.

create_uuid_dir

If set to true, each file will get a unique directory with a UUID as its name. The value is optional and defaults to false; create_uuid_dir alone is the same as create_uuid_dir true.

dest_dir_field_name

If set, the dest_dir will be set from the specified form value.

pass_thru

If set to true, enables pass-thru mode, which continues to the next HTTP handler in the route instead of responding directly. The value is optional and defaults to false.

allowed_extensions

List of allowed file extensions, e.g. .jpg .png .pdf. The check is case-insensitive and the leading dot is optional. Only the last extension of the file name sent by the client is checked (report.tar.gz → .gz), also when fixed_file_name is set. Uploads with other extensions are rejected with HTTP status 415.
Note: the extension is chosen by the client and is easy to fake. Use allowed_mime_types to check the real content.

allowed_mime_types

List of allowed MIME types, e.g. image/* application/pdf. A wildcard subtype like image/ is supported. The type is detected from the file content with mimetype, the Content-Type sent by the client is ignored. Uploads with other types are rejected with HTTP status 415.
Parent types are matched too, see the supported MIME types and their hierarchy. For example application/zip also allows docx, xlsx and jar files, and text/plain also allows HTML, CSV and JSON files.
*Warning: allowing text/plain also allows HTML. If the upload directory is served by a web server this can lead to XSS.

on_abort

What to do when an event handler aborts the upload_finished event, see Events. ignore (default) keeps the file and responds as usual. abort deletes the file (with create_uuid_dir the whole UUID directory) and responds with HTTP status 422.

http.upload.filename

The uploaded filename

http.upload.filesize

The uploaded filesize

http.upload.directory

The directory where the file is uploaded

http.upload.uuiddir

The name of the random directory created if create_uuid_dir is enabled

{event.data.filename}

The file name (sent by the client, or fixed_file_name)

{event.data.filesize}

The file size in bytes

{event.data.directory}

The directory where the file is stored

{event.data.filepath}

The path of the stored file (directory + filename). It is relative when root/root_dir is relative.

{event.data.uuiddir}

The name of the UUID directory, empty without create_uuid_dir

{event.data.requuid}

The http.request.uuid of the upload request