An open API service indexing awesome lists of open source software.

https://github.com/vkcom/nginx-http-vkupload-module


https://github.com/vkcom/nginx-http-vkupload-module

Last synced: 8 months ago
JSON representation

Awesome Lists containing this project

README

          

# Nginx Module: nginx-http-vkupload-module

## Description
Parses request body storing all files being uploaded to a directory specified by vkupload_file_path directive.

## Directives

### vkupload_pass

**Syntax:** vkupload_pass location

**Default:** —

**Context:** `location`

Specifies location to pass request body to. File fields will be stripped
and replaced by fields, containing necessary information to handle
uploaded files.

### vkupload_field

**Syntax:** vkupload_field name value

**Default:** —

**Context:** `location`

Specifies a form field(s) to generate for each uploaded file in request body passed to backend.

### vkupload_file_path

**Syntax:** vkupload_file_path directory [level1 [level2]] ...

**Default:** —

**Context:** `location`

Specifies a directory to which output files will be saved to. The directory could be hashed.

### vkupload_file_access

**Syntax:** vkupload_file_access mode

**Default:** user:rw

**Context:** `location`

Specifies access mode which will be used to create output files.

### vkupload_multipart

**Syntax:** vkupload_multipart on | off

**Default:** —

**Context:** `location`

Enables multipart uploads.

### vkupload_multipart_field

**Syntax:** vkupload_multipart_field name

**Default:** —

**Context:** `location`

Fields name with file content in multipart request.

### vkupload_resumable

**Syntax:** vkupload_resumable on | off

**Default:** —

**Context:** `location`

Enables resumable uploads.
Protocol spec: http://www.grid.net.ru/nginx/resumable_uploads.en.html

### vkupload_resumable_session_zone

**Syntax:** vkupload_resumable_session_zone name [size]

**Default:** —

**Context:** `location`

Shared memory zone name and size for resumable states.

## Variables

### $vkupload_file_path

Path to uploaded file

### $vkupload_file_md5

MD5 of uploaded file

### $vkupload_file_size

Size of uploaded file

### $vkupload_file_name

Name of uploaded file, get from "filename" from Content-Disposition header

### $vkupload_file_field

Field of uploaded file, get from "field" from Content-Disposition header