Skip to content

QazCetelic/grist-image-optimizer

Repository files navigation

Grist Image Optimizer

The Grist Image Optimizer is a tool designed to reduce image attachment size in Grist by converting larger image files to more efficient formats (WEBP) (and by losing some detail). It uses grist-client-rs.

It can be used as CLI tool or be ran as a Docker service with the example docker-compose.yml.

7x size reduction example

The image optimization process is particularly useful for users accessing Grist using cellular data. Large multi-MB images can consume substantial amounts of data, and it can add up quite quickly if each row in a spreadsheet contains one.

Options

Flag Environment Variable Description
-u, --base-url <BASE_URL> GIO_BASE_URL Instance URL (e.g. https://grist.mydomain.net/api)
-d, --dir <DIR> GIO_TEMPORARY_DIRECTORY Temporary directory (e.g. /tmp/)
-t, --token <TOKEN> GIO_API_TOKEN Grist user API-token
-m, --conversion-method <CONVERSION_METHOD> GIO_CONVERSION_METHOD Attachment conversion method [default: normal]
[possible values: fastest, faster, fast, normal, slow, slower, slowest]
-s, --specific-document <SPECIFIC_DOCUMENT> - A specific document or nothing to scan all documents
-c, --concurrent-downloads GIO_CONCURRENT_DOWNLOADS The limit of concurrent attachment downloads

About

Replaces image attachments with smaller files to reduce network bandwidth and file size

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published