gotenberg/build/docs/content/01-install.md

title

title
Install

Gotenberg is shipped within a Docker image.

You may start it with:

$ docker run --rm -p 3000:3000 thecodingmachine/gotenberg:3

The API will be available at http://localhost:3000.

Or add it in your Docker Compose stack:

version: '3'

services:

  # your others services

  gotenberg:
    image: thecodingmachine/gotenberg:3

The API will be available under gotenberg:3000 in your Docker Compose network.

It may also be deployed with Kubernetes.

In the following examples, we will assume your Gotenberg API is available at http://localhost:3000.

Go client

$ go get -u github.com/thecodingmachine/gotenberg

PHP client

Unless your project already has a PSR7 HttpClient, install php-http/guzzle6-adapter:

$ composer require php-http/guzzle6-adapter

Then the PHP client:

$ composer require thecodingmachine/gotenberg-php-client