Skip to content

Commit

Permalink
docs(thumbnails): mention processors in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fschade committed Oct 5, 2023
1 parent c8a25e1 commit a34649a
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions services/thumbnails/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ The relevant environment variables defining file locations are:
- (2) `STORAGE_USERS_OCIS_ROOT`
- (3) `THUMBNAILS_FILESYSTEMSTORAGE_ROOT`

(1) ... Having a default set by the Infinite Scale code, but if defined, used as base path for other services.
(2) ... Source files, defaults to (1) plus path component, but can be freely defined if required.
(3) ... Target files, defaults to (1) plus path component, but can be freely defined if required.
(1) ... Having a default set by the Infinite Scale code, but if defined, used as base path for other services.
(2) ... Source files, defaults to (1) plus path component, but can be freely defined if required.
(3) ... Target files, defaults to (1) plus path component, but can be freely defined if required.

For details and defaults for these environment variables see the ocis admin documentation.

Expand Down Expand Up @@ -45,9 +45,20 @@ Various resolutions can be defined via `THUMBNAILS_RESOLUTIONS`. A requestor can

Example:

Requested: 18x12
Available: 30x20, 15x10, 9x6
Returned: 15x10
Requested: 18x12
Available: 30x20, 15x10, 9x6
Returned: 15x10

## Thumbnail Processors

Image generation can be configured by defining different processors, following processors are available:

* resize

Check warning on line 56 in services/thumbnails/README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

services/thumbnails/README.md#L56

[list-item-indent] Incorrect list-item indent: add 2 spaces
* fit

Check warning on line 57 in services/thumbnails/README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

services/thumbnails/README.md#L57

[list-item-indent] Incorrect list-item indent: add 2 spaces
* fill

Check warning on line 58 in services/thumbnails/README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

services/thumbnails/README.md#L58

[list-item-indent] Incorrect list-item indent: add 2 spaces
* thumbnail

Check warning on line 59 in services/thumbnails/README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

services/thumbnails/README.md#L59

[list-item-indent] Incorrect list-item indent: add 2 spaces

to apply one of those, a query parameter has to be added to the request, e.g. `?processor=fit`

## Deleting Thumbnails

Expand Down

0 comments on commit a34649a

Please sign in to comment.