Documentation

Quick Start Guide

Getting set up with imgix is easy—just tell us where your images live, set some basic defaults, and you can start serving images through our Image URL API in minutes.

The quick-start instructions are below, and if you have a more complex integration, you can head directly to Source setup for the advanced details like cache TTL, default parameters, and custom domains.

For information about analytics and adding users or payment methods, see Account Setup & Analytics.

10 Minutes to Serving with imgix

Once you’ve signed up or signed in to your imgix account, you’ll be at the dashboard, which is the hub for all operations and stats for your account. Here’s the simplified process for serving your first images.

  1. From the dashboard, go to the Sources page, then click Add a Source. This is where you connect your images storage to imgix. Screenshot-Message telling you to add a Source

  2. Configure your Source. You’ll need to name your imgix.net subdomain (the root of the URL you’ll use to serve images), and specify where your images live. Each type of image storage has its own set of options that will appear when you select it. Screenshot-Source configuration options

    Note: The subdomain name you choose is unique to your Source and can’t be re-used. If you’re setting up a Source with a lot of customization (particularly a Custom Domain), choose the name you plan to use going forward.

  3. Click Save to save your changes and deploy your Source. Once successful, your image storage will be connected to imgix and the subdomain will be active. You’ll be sent to the settings page for the Source, where you can see its status Screenshot-Source edit screen

  4. Try out a test image. Just type https://your_domain.imgix.net/path-to-image into a browser window and your image should appear.

Now that you know the connection is working, you can start applying our API parameters to optimize your images. Here are some good next steps:

  • API Documentation: Describes all of the available parameters, with examples.
  • Serving Images guide: This guide will show you the recommended operations that most of our customers use to optimize their images.
  • Developer Tools: Once you’ve figured out the parameters you want to use, you can use our client libraries to build out image helpers in most modern languages and frameworks.