Edgar Image

Edgar Image is an open-source image transformation service built to make it possible for developers to own and host their own image services. Including functionality such as changing the width, height, and quality of a remote image but also encoding it into more modern formats.

The goal is for you as a developer to just deploy the service onto a hosting provider you choose your own, that's why we only provide a docker container.

Documentation

You find the documentation at https://edgar-image.com

Features

We would love feedback on more functionality to add. If you have an idea are you more then welcome to contribute or by commenting the functionality you are looking for here: #15

Usage/Examples

Use the service while it's deployed

All settings are sent as query parameters. To generate a image with width of 400px, height of 400px, quality of 100% from the original image and sharpen the image with 30 sigma do you add these query parameters.

https://image.edgar-image.com/?src=https://images.unsplash.com/photo-1659419865658-54b9eff7fbc0&w=400&h=400&q=100&sharpen=30

To start the docker container

To start the Docker container do you only need to run

docker run -p 8080:8080 emilpriver/edgar-image:VERSION

To start the Docker container with a config file:

Default config file:

{
	  "domains": ["*"],
    "allowedImageOutputFormats": ["image/webp", "image/jpeg", "image/png"],
    "defaults": {
        "quality": 70 
    }
}

OBS we expect that the config file include all of the fields abow. Domains can include wildcards, example: *.example.com. Supported formats are: - imge/webp - image/jpeg - image/png

Example of a modified config file:

{
	  "domains": ["image.unsplash.com", "*.edgar-image.com"],
    "allowedImageOutputFormats": ["image/jpeg", "image/png"],
    "defaults": {
        "quality": 60
    }
}

After you have modified the config file can you start the container with:

docker run -p 8080:8080 -v $(pwd)/config.json:/app/config.json emilpriver/edgar-image:VERSION

Caching

As this service only provide the functionality to transform a image and encode it into more mordern formats, you will need to manage caching on your own. However, there are relatively simple ways to solve it. For example, can run the entire system behind cloudflare and cache the content with Cloudflare.

In the future, there will be a solution to cache images on the server.

Documentation

We are currently working on documentation.

We will cover how to cache your images on for example Cloudflare and how to host the system on different providers such as Digitalocean and AWS

More Information

This system is in beta meaning there can be errors. We would love inputs and feedback.

This README is a work in progress

Our goal is also to in the documentation provide information about how you can deploy this system to different providers. Also to provide information on automatic deployments when we release updates

Download