This documentation is for the old version. Go to the latest Upload Suite docs

Before You Started

Introducing Image Uploader

Image Uploader is a powerful upload component designed for Web 2.0 projects as well as image-oriented and upload-enabled solutions. It provides rich functionality which allows to solve a lot of specific tasks and makes it possible to meet requirements posed both for the upload workflow and the upload tool.

The most significant Image Uploader features are client-side image processing, including such actions as resizing, rotating, cropping, and watermarking. User-friendly upload is indicated with a progress bar and is provided with an ability to resume broken uploads without resending files which were already uploaded. Moreover, there is a possibility to customize Image Uploader GUI elements as well as the uploaded data format.

Hence, if Image Uploader is the tool you need, let us describe it in a more detailed fashion. To begin with Image Uploader, you need to download Image Uploader SDK from location. Here the SDK is available in the following packages:

  • ImageUploader.exe, Windows-only installer
  •, ZIP archive

The steps to install both packages are listed in the Installation and Deployment Notes topic.

The present article considers the process of embedding Image Uploader into a project. The main advantage of Image Uploader is that it is designed for the integration with both work-in-progress and completed projects.


If your project is already based on a previous version of Image Uploader you can easily upgrade it to the latest one using the upgrading guidelines ASP.NET API Changes between Versions 6 and 7 PHP API Changes between Versions 6 and 7 JavaScript API Changes between Versions 6 and 7 .

Embedding Image Uploader into Project

Image Uploader SDK includes several tools intended to insert Image Uploader into a web page. Each tool has its own pros and cons; this allows you to choose the one which meets your requirements better. Carefully read descriptions of these tools below; it would help you to make the right decision.

Image Uploader ASP.NET

Image Uploader ASP.NET was developed especially for the ASP.NET server platform. It represents a set of ASP.NET server controls which allow to deploy and configure Image Uploader in Microsoft Visual Studio in design mode. Its another advantage is that it significantly simplifies handling uploaded data and saves you the trouble of parsing POST request yourself. This tool is intended most of all for ASP.NET developers; here it enables them to use Image Uploader in a straight-forward way just as the other ASP.NET server controls.

So, if you are going to use Image Uploader in an ASP.NET application, this tool is the best choice. See Quick Start with Image Uploader ASP.NET to get started.

Image Uploader PHP

This tool can be used with PHP platform only. Image Uploader PHP contains a collection of PHP classes intended for deploying and configuring Image Uploader as well as handling uploaded data. Image Uploader PHP has nearly the same functionality as Image Uploader ASP.NET.

Thus, Image Uploader PHP is the best solution for PHP applications. Read the Quick Start with Image Uploader PHP topic and see for yourself.

Image Uploader JavaScript

Contrary to the first two tools, this one is compatible with any HTTP-compliant server platform. It is a base for both Image Uploader ASP.NET and Image Uploader PHP. Image Uploader JavaScript is more complicated in comparison with the ones previously described; it requires configuring Image Uploader parameters manually and does not provide any facility for handling uploaded data. However, it is more flexible and can be used not only with ASP.NET or PHP. See the Quick Start with Image Uploader PHP topic for more information.

Evaluating Image Uploader

After you insert Image Uploader into a page, try to upload some files. Most likely, the upload process will not start and the following message will appear:

No valid license key for current DNS/IP address specified. If you see this message, please contact site administrator.

To get rid of this message and allow Image Uploader to upload files, you should register a license key. This key can be trial or full. Full keys are required for a production purpose and will be considered below.

Trial keys allow to evaluate Image Uploader on any domain during the 30-day period. Another limitation of the evaluation version is the trial message which is shown whenever you start the upload. You can find the detailed instructions on how to obtain and register trial license keys in the Evaluating and Registering Image Uploader topic.

Moreover, there are two alternative ways to evaluate Image Uploader. The first one is to use it on localhost domain where it always works as a full version. The second way is to register development keys which can be used for development purposes only. To obtain development keys just create support case and request them.

Integrating Image Uploader with Project

Image Uploader is designed to be easily integrated with the existing solution, including both look and feel and uploaded data format. It provides rich functionality to replace buttons by your images, customize colors, fonts and other appearance settings. See the Customizing Appearance topic for details. As for the uploaded data, you can adapt the POST request format for comparability with your server-side API. Here you can add your custom fields as well as rename and remove default ones. Find the detailed information about this feature in the Uploading Additional Data Uploading Additional Data in ASP.NET Uploading Additional Data in PHP , Configuring POST Format, and POST Field Reference topics.

Moving Project to Production Server

First of all, before moving Image Uploader-enabled project to your production server you need to obtain and register full license keys. These keys should be associated with the domain name or IP address of your server. Carefully read the Evaluating and Registering Image Uploader topic before purchase keys.

Secondly, you need to copy Image Uploader redistributable files along with your application code to the production server. Depending on the way you have embedded Image Uploader into your project you should use the following files:

  • For Image Uploader ASP.NET use Aurigma.ImageUploader.dll file.
  • For Image Uploader PHP use /ImageUploaderPHP folder.
  • For Image Uploader JavaScript use /Scripts folder.

Probably, you might need to configure your server a bit before publishing your solution. For instance, to grant read and write permissions for folders you are going to upload files to or set the limitation for maximum POST request length. Find details in the Configuring ASP.NET and Configuring PHP topics.


If you encounter a problem during installation, evaluation, or upload; try to find a solution in the knowledge base available in the Troubleshooting section. It contains information on how to resolve typical problems which may occur with Image Uploader.

If this information does not help and the problem still occurs, feel free to create a support case and report us about it.

See Also