5.16.2

Note

Version 5.0 brings some breaking changes. See the upgrading to 5.x page for help on upgrading from a 4.x version.

Documentation Overview

Welcome to Fine Uploader's documentation. This documentation is divided into different parts. It's recommended that you first check out the quickstart for Fine Uploader. If you’d rather dive into the internals of Fine Uploader, check out the exhaustive Features reference or API documentation (see the navigation menu bar at the top). For assistance in getting your upload server set up, check out the docs in the Servers section (also available via the navigation menu).

Getting Started

This area of the documentation is mostly prose and examples. It is meant to be human-readable and accessible to those looking to get started with Fine Uploader. For experts, or developers looking to view more technical documentation, refer to the API documentation section.

Quick-start

Traditional / Generic Endpoint Uploader

  1. Getting Started with Fine Uploader
  2. Setting Fine Uploader options
  3. Creating an upload server

Amazon S3 Uploader

  1. Getting Started with Fine Uploader
  2. Setting Fine Uploader options
  3. Creating an upload server

Azure Blob Storage Uploader

  1. Getting Started with Fine Uploader
  2. Setting Fine Uploader options
  3. Creating an upload server

Fine Uploader Modes

  • Core - Most API methods and options available, build your own UI from scratch
  • UI - Inherits from core, provides additional UI-specific options and API methods. Default customizable UI.

Plug-ins

  • jQuery - Not required to use any feature of Fine Uploader. Simply wraps the library as a jQuery plug-in.

Endpoint Handlers (server-side guidelines)

  • Traditional Server - For upload servers that you control and build.
  • Amazon S3 - For uploads directly to S3 from the browser.
  • Azure Blob Storage - For uploads directly to Azure from the browser.
  • Examples - GitHub repo of server-side examples to handle all types of Fine Uploader requests.

Additional Information

  • Browser Support - Matrix of support for all major features. Also contains information on how to determine features support via JavaScript at runtime using Fine Uploader's API.
  • Contributing - Guidelines and options for contributing back to this free open source library.
  • Changelog - High-level summary of all releases.
  • FAQ