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:4

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:4

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

It may also be deployed with Kubernetes.

In Kubernetes, make sure to provide enough memory and CPU requests (for instance 512Mi and 0.2 CPU). Otherwise the API will not be able to launch Google Chrome and Libreoffice (unoconv).

Also note the more resources are granted, the quicker will be the conversions.

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-go-client/v4

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