Skip to content

Commit

Permalink
Apply suggestions from proof reading
Browse files Browse the repository at this point in the history
Co-authored-by: Martin <[email protected]>
  • Loading branch information
rhafer and mmattel committed Oct 16, 2024
1 parent 91593d4 commit 38581a6
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions services/thumbnails/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,17 +90,17 @@ To have more control over memory (and CPU) consumption the maximum number of con

If a resource is shared using SecureView, the share reciever will get a 403 (forbidden) response when requesting a thumbnail. The requesting client needs to decide what to show and usually a placeholder thumbnail is used.

## Using libvips for thumbnail generation
## Using libvips for Thumbnail Generation

To improve performance (and to support a wider range of images formats) the thumbnails service is able to utilize libvips (https://www.libvips.org/) for thumbnail generation. Support for libvips needs to be
To improve performance and to support a wider range of images formats, the thumbnails service is able to utilize the [libvips library](https://www.libvips.org/) for thumbnail generation. Support for libvips needs to be
enabled at buildtime and has a couple of implications:

* With libvips support enabled it is not possible to create a statically linked ocis binary
* So the libvips shared libraries need to be available at runtime in the same release that was used to build the ocis binary
* When using the ocis docker images the libvips shared libraries are included in the image
* With libvips support enabled, it is not possible to create a statically linked ocis binary.
* Therefore, the libvips shared libraries need to be available at runtime in the same release that was used to build the ocis binary.
* When using the ocis docker images, the libvips shared libraries are included in the image and are correctly embedded.

Support of libvips is disabled by default. To enable it make sure libvips and its buildtime dependencies are install in your build environment. Then just set
the `ENABLE_VIPS` variable on the `make` command:
Support of libvips is disabled by default. To enable it, make sure libvips and its buildtime dependencies are installed in your build environment.
Then you just need to set the `ENABLE_VIPS` variable on the `make` command:

```shell
make -C ocis build ENABLE_VIPS=1
Expand Down

0 comments on commit 38581a6

Please sign in to comment.