Skip to content

Use this GitHub template repository for your custom modules and Gotenberg's Docker image variants.

Want to share your work? Open a PR to the awesome list! 🚀

Quick Start

Update the following variables in the Makefile:

  • APP_NAME - the name of your Gotenberg's Docker image variant.
  • APP_VERSION
  • APP_AUTHOR
  • APP_REPOSITORY
  • DOCKER_REGISTRY
  • DOCKER_REPOSITORY

You may now run:

make build

This command builds your Gotenberg's Docker image ($(DOCKER_REGISTRY)/$(DOCKER_REPOSITORY):$(GOTENBERG_VERSION)-$(APP_NAME)-$(APP_VERSION)).

Next steps

  1. Update the go.mod file with your Go module's name.
  2. Update the build/Dockerfile with your instructions.
  3. Create your module(s) in pkg/modules.
  4. Import your module(s) in cmd/app/main.go.

FAQ

How can I check the underlying Gotenberg's version?

The Gotenberg's image has a version label which contains the underlying Gotenberg's version:

docker inspect $(DOCKER_REGISTRY)/$(DOCKER_REPOSITORY):$(GOTENBERG_VERSION)-$(APP_NAME)-$(APP_VERSION)

Where can I see the list of Makefile commands?

Run make help to display the available commands 💡

About

A developer-friendly API for converting numerous document formats into PDF files, and more!

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages