@fdmediagroep/imgix-upload
v0.0.38
Published
Command-line tool to upload images to the FDMG IMGIX S3 Bucket
Downloads
103
Readme
IMGIX Upload
Upload images to IMGIX and output a JSON-file with mappings to the hashed filenames on IMGIX.
Prerequisites
- Node & NPM
Getting started
For users of this tool
- Run
npm i -g @fdmg/imgix-upload
to install this CLI-tool globally. - Make sure the required environment variables are set
- You can now use
fdmg-imgix-upload
from the command-line or use the shorthandfiu
.- Run
fiu --help
to see the available options.
- Run
Alternatively:
- Run
npm i -D @fdmg/imgix-upload
to install the tool for your project. - Make sure the required environment variables are set or available in an
.env
file. fdmg-imgix-upload
orfiu
commands are now available in package.json scripts.
For developers of this tool
- Run
npm i
to install all dependencies - Run
npm run build
to build the development version of this application.- Alternatively run
npm run build:prod
to build the production version of this application.
- Alternatively run
- Make sure the required environment variables are set or available in an
.env
file. - Run
npm start
Environment variables
The following environment are supported:
- ENVIRONMENT
- IMGIX_UPLOAD_AWS_DEFAULT_REGION=eu-west-1
- IMGIX_UPLOAD_RELATIVE_IMAGE_MAP_LOCATION=./imageMap.json
- IMGIX_UPLOAD_RELATIVE_IMAGE_FOLDER_LOCATION=./public
- IMGIX_UPLOAD_ACC_S3_API_KEY= (required)
- IMGIX_UPLOAD_ACC_S3_SECRET_KEY= (required)
- IMGIX_UPLOAD_ACC_S3_BUCKET_URL= (required)
- IMGIX_UPLOAD_ACC_S3_BUCKET= (required)
- IMGIX_UPLOAD_DEV_S3_API_KEY= (required)
- IMGIX_UPLOAD_DEV_S3_SECRET_KEY= (required)
- IMGIX_UPLOAD_DEV_S3_BUCKET_URL= (required)
- IMGIX_UPLOAD_DEV_S3_BUCKET= (required)
- IMGIX_UPLOAD_PROD_S3_API_KEY= (required)
- IMGIX_UPLOAD_PROD_S3_SECRET_KEY= (required)
- IMGIX_UPLOAD_PROD_S3_BUCKET_URL= (required)
- IMGIX_UPLOAD_PROD_S3_BUCKET= (required)
- IMGIX_UPLOAD_S3_DATA_CACHE_CONTROL=max-age=15768000