https://github.com/threez/gpd

Ghostscript PDF Daemon
https://github.com/threez/gpd

Last synced: 8 months ago
JSON representation

Ghostscript PDF Daemon

• Host: GitHub
• URL: https://github.com/threez/gpd
• Owner: threez
• License: bsd-2-clause
• Created: 2018-07-31T11:58:36.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-08-09T18:47:04.000Z (almost 8 years ago)
• Last Synced: 2025-02-07T08:12:41.983Z (over 1 year ago)
• Language: Go
• Size: 928 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# gpd

Ghostscript PDF Daemon is a small minio companion application.

[Minio](https://minio.io) supports bucket notifications e.g. a webhook.

This application is similar to the [thumbnailer](https://github.com/minio/thumbnailer) but applies only to PDF.

Purpose of the Ghostscript PDF Daemon is to react on webhook bucket

notifications, download the file if it is a PDF, extract the text

content into a JSON file and create thumbnails for all pages of the

document.

## Architecture

                         +-----------+

                  +------>   minio   |

                  |      +---+-------+

                  |          |

        2. down-  |          | 1. webhook

        load      |          |

                  |      +---v-------+    +-------------+

        4. upload +------+    gpd    +----> ghostscript |

        json +           +-----------+    +-------------+

        thumbnails

                                    3. analyse

## Created documents layout

The created documents have the following format.

Given the input PDF with 3 pages:

    path/in/minio/XYZ.pdf

The following files will be produced:

    path/in/minio/XYZ.json

    path/in/minio/XYZ-1.jpeg

    path/in/minio/XYZ-2.jpeg

    path/in/minio/XYZ-3.jpeg

## License

The 2-Clause BSD License.

## Configuration and Setup

The token can be used to secure the connection between the minio server and the

gpd. Only events that are done via the token URL are allowed and processed.

### 1. Enable webhooks in minio

The URL needs to be the URL of the gpd server. Example:

    "webhook": {

        "1": {

                "enable": true,

                "endpoint": "https://:3443/gpd/events?token="

        }

### 2. Create bucket and enable events on the bucket via minio command

    $ minio-client mb / --region=

    $ minio-client events add / arn:minio:sqs::1:webhook --suffix .pdf

For example:

    $ minio-client mb s3/test --region=

    $ minio-client events add s3/test arn:minio:sqs:us-east-1:1:webhook --suffix .pdf

The notifications can also be restricted to a certain prefix using `--prefix`.

### 3. Start the gpd service

    $ ./gpd -address :3443 -token  -cert cert.pem -key key.pem"