Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2025-07-09 18:40:16 +02:00
Code Issues Packages Projects Releases Wiki Activity
sharp/docs/install.md
Lovell Fuller bf6b894480 Improve dependency-less documentation 
Start to comment ever-growing GYP config

Add Circle CI config to run packaging tests
2015-11-10 21:49:45 +00:00

3.1 KiB
Raw Blame History

Installation

npm install sharp

Prerequisites

  • C++11 compatible compiler such as gcc 4.6+ (Node v4+ requires gcc 4.8+), clang 3.0+ or MSVC 2013
  • node-gyp

Linux

Ubuntu 14.04 Build Status

libvips and its dependencies are fetched and stored within node_modules/sharp during npm install. This involves an automated HTTPS download of approximately 6MB.

Most recent 64-bit Linux-based operating systems should "just work", e.g.:

  • Debian 8
  • Ubuntu 12.04, 14.04, 14.10, 15.04, 15.10
  • Centos 7
  • Fedora 20, 21
  • openSUSE 13.2
  • Archlinux 2015.06.01

Preference will be given to an existing globally-installed (via pkg-config) version of libvips that meets the minimum version requirement. This allows the use of newer versions of libvips with older versions of sharp.

For older and 32-bit Linux-based operating systems, a system-wide installation of the most suitable version of libvips and its dependencies can be achieved by running the following command as a user with sudo access (requires curl and pkg-config):

curl -s https://raw.githubusercontent.com/lovell/sharp/master/preinstall.sh | sudo bash -

Mac OS

OS X 10.9.5 Build Status

libvips must be installed before npm install is run. This can be achieved via homebrew:

brew install homebrew/science/vips --with-webp --with-graphicsmagick

A missing or incorrectly configured Xcode Command Line Tools installation can lead to a library not found for -ljpeg error. If so, please try: xcode-select --install.

The gettext dependency of libvips can lead to a library not found for -lintl error. If so, please try brew link gettext --force.

Windows

Windows x64 Build Status

libvips and its dependencies are fetched and stored within node_modules\sharp during npm install. This involves an automated HTTPS download of approximately 11MB.

Only 64-bit (x64) node.exe is supported. The WebP format is currently unavailable on Windows.

Heroku

Alessandro Tagliapietra maintains an Heroku buildpack for libvips and its dependencies.

Docker

Marc Bachmann maintains an Ubuntu-based Dockerfile for libvips.

docker pull marcbachmann/libvips

Will Jordan maintains an Alpine-based Dockerfile for libvips.

docker pull wjordan/libvips

Build tools