Quick Start

Getting started with using LibPixel is easy. You just need to signup, provide an image source and you can start serving and processing images with LibPixel

Signing Up

The first step towards using LibPixel's awesome features is to signup here. Carefully select your organisation's name, subdomain and provide your email. Also setup a secure password to protect your LibPixel account from unauthorised access.

Sign Up If You're Awesome

Please select your subdomain carefully, it will be used to serve images after defining image sources. To change it afterwards, you'll need to contact our support.

After signing up and confirming the email via the link sent to your email, you can start using LibPixel.

Welcome to LibPixel

Create Your First Source

Now the only thing left to do before you can start serving images with LibPixel is defining the source of your images. To do this, press the Create Source button that will be present on your home screen after signing up and verifying your email address.

Create Your First Source

You'll be redirected to a form that will ask you enter the relevant information of your image source. Carefully fill out this information!

Enter Your New Source

Select the region closest to your source not the users. LibPixel will take care of delivering images to your users via the closest CDN.

There are two types of image sources to select from. You can either provide a public URL to the images or, you can provide access to a private S3 bucket that stores your images. There are additional steps required if you are adding a private S3 bucket and you can read about these steps on the Image Sources page.

Select the Type of Source

After setting up the source, you are ready to start using LibPixel to serve and process the images present in Image Source.

Creating URL Source

The Path define the route where the image source that you will define below will be available through LibPixel. Suppose you have images similar to the following URL:

https://www.example-source.com/images/giraffe.png

Then you will enter the following URL in the Base URL field of the New Source form:

New URL Source

The Base URL must end with a trailing slash

Now you can access the images present in the base URL with the help of LibPixel. If you have defined the path as images then your LibPixel URL for the image mentioned above will be:

https://www.your-awesome-domain.libpx.com/images/giraffe.png

Learn how to create an AWS S3 bucket source in the image sources page.

Serving Images

There are two ways of serving images while using LibPixel:

Using Predefined Image Sources

After configuring an image source as defined in the preceding section, you can access all images with the path you configured during the source creation process.

Using Secure URLs (Src Parameter)

The second way of using LibPixel's service is to use Secure URL's. Using this technique, you can access any public image through LibPixel. Consider the same image as in the previous section:

https://www.example-source.com/images/giraffe.png

However, this time we're not adding this as an image source and will directly access it. We can do this by building a URL as follows and appending processing queries to it.

?src=https%3A%2F%2Fwww.example-source.com%2Fimages%2Fgiraffe.png?blur=5

The last step is to secure this URL by using the Generate Secure URLs tool of LibPixel.

If you are manually creating such URLs then you will have to escape the source URL. Our client libraries automatically encode URLs.

The final URL that you can use in <img> tags will be produced by the secure URL generator and will look like:

<img src="http://your-awesome-domain.libpx.com/?src=https%3A%2F%2Fwww.example-source.com%2Fimages%2Fgiraffe.png?blur=5&signature=d5c81193da20d2fb3ffe61ceb1fc43e7178d60eb" />

The above shown request blurs the giraffe image by a scale of 5