lyh2668 / press-ready

🚀 Make your PDF compliant with press-ready PDF/X-1a.

🚀 press-ready

Make your PDF compliant with press-ready PDF/X-1a.

日本語ドキュメント

Pre-requisite

• Docker

Quick Usage

Pull vibranthq/press-ready image from Docker Hub.

Then run docker run -it -v $PWD:/workdir vibranthq/press-ready --input <input.pdf> --output <output.pdf>.

docker pull vibranthq/press-ready

docker run --rm -it \
  -v $PWD:/workdir \
  vibranthq/press-ready \
  --input ./input.pdf \
  --output ./output.pdf

Run docker run --rm vibranthq/press-ready --help for the help.

➜ docker run --rm vibranthq/press-ready --help
Options:
  --version          Show version number                               [boolean]
  --input            Input file path                                  [required]
  --output           Output file path                  [default: "./output.pdf"]
  --gray-scale       Use gray scale color space instead of CMYK
                                                      [boolean] [default: false]
  --enforce-outline  Convert embedded fonts to outlined fonts          [boolean]
  --boundary-boxes   Add boundary boxes on every page [boolean] [default: false]
  --help             Show help                                         [boolean]

Options

Color Mode

Press-ready will use CMYK by default. Give --gray-scale option to let them use Grayscale instead.

docker run --rm -it \
  -v ${CURDIR}:/workdir \
  vibranthq/press-ready \
  --input ./input.pdf \
  --output ./output.pdf \
  --gray-scale

Boundary Boxes

Option --boundary-boxes will build TrimBox, CropBox and BleedBox on a generated PDF.

docker run --rm -it \
  -v ${CURDIR}:/workdir \
  vibranthq/press-ready \
  --input ./input.pdf \
  --output ./output.pdf \
  --boundary-boxes

Outlined Fonts

You might not want to use this option since press-ready automatically guess whether embedded fonts should be outlined. However, you can still control this behavior by passing --enforce-outline or --no-enforce-outline.

docker run --rm -it \
  -v ${CURDIR}:/workdir \
  vibranthq/press-ready \
  --input ./input.pdf \
  --output ./output.pdf \
  --enforce-outline

Color Profile

Currently, there is only support for Japan 2001 Coated. If you have any suggestions, please consider submitting an issue.

Tips

press-ready command

You might want to assign an alias for press-ready as a shorthand command.

alias press-ready="docker run -it -v \$PWD:/workdir vibranthq/press-ready"

Then you can type press-ready just like a normal command:

press-ready --help
press-ready --input <input.pdf> --output <output.pdf>

Pull resource from AWS S3

! This feature is not yet available in press-ready v2. If you need this feature, use press-ready v1 (vibranthq/pdfx) image instead.

Just run with S3 URL: docker run -t vibranthq/press-ready <input s3url> <output s3url>.

For fetching and uploading AWS S3 resources, you need to set env var AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.

docker run --rm -it \
  -e AWS_ACCESS_KEY_ID=<aws_key_id> \
  -e AWS_SECRET_ACCESS_KEY=<aws_secret> \
  vibranthq/pdfx s3://bucket/input.pdf s3://bucket/output.pdf

Contribution

PRs are welcome. Make sure to do make test before filing pull requests.

Development Build

make build
make test

Contributors

List of awesome contributors (generated by git shortlog -sn).

• Yasuaki Uechi
• Kenshi Muto