SixLabors.ImageSharp.Web

ImageSharp.Web is a high-performance ASP.NET Core middleware leveraging the ImageSharp graphics library to allow on-the-fly image manipulation via URL based commands.

License

• ImageSharp.Web is licensed under the Six Labors Split License, Version 1.0

Support Six Labors

Support the efforts of the development of the Six Labors projects.

• Purchase a Commercial Support License :heart:
• Become a sponsor via GitHub Sponsors :heart:
• Become a sponsor via Open Collective :heart:

Documentation

• Detailed documentation for the ImageSharp.Web API is available. This includes additional conceptual documentation to help you get started.

Questions

• Do you have questions? We are happy to help! Please join our Discussions Forum, or ask them on Stack Overflow using the ImageSharp.Web tag. Please do not open issues for questions.
• Please read our Contribution Guide before opening issues or pull requests!

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information, see the .NET Foundation Code of Conduct.

Installation

Install stable releases via Nuget; development releases are available via Feedz.io.

Package Name	Release (NuGet)	Nightly (Feedz.io)
SixLabors.ImageSharp.Web

Manual build

If you prefer, you can compile ImageSharp.Web yourself (please do and help!)

• Using Visual Studio 2022
  • Make sure you have the latest version installed
  • Make sure you have the .NET 6 SDK installed

Alternatively, you can work from command line and/or with a lightweight editor on both Linux/Unix and Windows:

• Visual Studio Code with C# Extension
• .NET Core

To clone ImageSharp.Web locally, click the "Clone in [YOUR_OS]" button above or run the following git commands:

git clone https://github.com/SixLabors/ImageSharp.Web

If working with Windows please ensure that you have enabled log file paths in git (run as Administrator).

git config --system core.longpaths true

This repository contains git submodules. To add the submodules to the project, navigate to the repository root and type:

git submodule update --init --recursive

Running the Tests

The unit tests require Azurite Azure Storage Emulator and s3rver in order to run.

On Windows to install and run the server as a background process run the following command

npm install -g azurite
start /B azurite --loose --skipApiVersionCheck

npm install -g s3rver
start /B s3rver -d .

On Linux

sudo npm install -g azurite
sudo azurite --loose --skipApiVersionCheck &

sudo npm install -g s3rver
sudo s3rver -d . &

How can you help?

Please... Spread the word, contribute algorithms, submit performance improvements, unit tests, no input is too little. Make sure to read our Contribution Guide before opening a PR.

The ImageSharp.Web Team

• James Jackson-South
• Dirk Lemstra
• Anton Firsov
• Scott Williams
• Brian Popow