+ 
-
+
A Docker-powered stateless API for converting HTML, Markdown and Office documents to PDF.
@@ -39,4 +39,6 @@ to learn how to interact with it! --- -Psst: TheCodingMachine is always looking for [talented coders](https://coders.thecodingmachine.com). +
+
+
+* `background-color` and `color` CSS properties require an additional `-webkit-print-color-adjust: exact` CSS property in order to work
### cURL
@@ -119,16 +119,17 @@ $ curl --request POST \
### Go
```golang
-import)
setHeader($header);
$request->setFooter($footer);
-$dirPath = "/foo";
-$filename = $client->store($request, $dirPath);
+$dest = 'result.pdf';
+$client->store($request, $dest);
```
## Assets
@@ -209,15 +210,17 @@ $ curl --request POST \
### Go
```golang
-import "github.com/thecodingmachine/gotenberg-go-client/v6"
+import "github.com/thecodingmachine/gotenberg-go-client/v7"
-func main() {
- c := &gotenberg.Client{Hostname: "http://localhost:3000"}
- req, _ := gotenberg.NewHTMLRequest("index.html")
- req.Assets("font.woff", "img.gif", "style.css")
- dest := "result.pdf"
- c.Store(req, dest)
-}
+c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file")
+style, _ := gotenberg.NewDocumentFromPath("style.css", "/path/to/file")
+img, _ := gotenberg.NewDocumentFromPath("img.png", "/path/to/file")
+font, _ := gotenberg.NewDocumentFromPath("font.woff", "/path/to/file")
+req := gotenberg.NewHTMLRequest(index)
+req.Assets(style, img, font)
+dest := "result.pdf"
+c.Store(req, dest)
```
### PHP
@@ -228,15 +231,15 @@ use TheCodingMachine\Gotenberg\DocumentFactory;
use TheCodingMachine\Gotenberg\HTMLRequest;
$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', 'index.html');
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
$assets = [
- DocumentFactory::makeFromPath('style.css', 'style.css'),
- DocumentFactory::makeFromPath('img.png', 'img.png'),
- DocumentFactory::makeFromPath('font.woff', 'font.woff'),
+ DocumentFactory::makeFromPath('style.css', '/path/to/file'),
+ DocumentFactory::makeFromPath('img.png', '/path/to/file'),
+ DocumentFactory::makeFromPath('font.woff', '/path/to/file'),
];
$request = new HTMLRequest($index);
$request->setAssets($assets);
-$dest = "result.pdf";
+$dest = 'result.pdf';
$client->store($request, $dest);
```
@@ -268,17 +271,16 @@ $ curl --request POST \
### Go
```golang
-import "github.com/thecodingmachine/gotenberg-go-client/v6"
+import "github.com/thecodingmachine/gotenberg-go-client/v7"
-func main() {
- c := &gotenberg.Client{Hostname: "http://localhost:3000"}
- req, _ := gotenberg.NewHTMLRequest("index.html")
- req.PaperSize(gotenberg.A4)
- req.Margins(gotenberg.NoMargins)
- req.Landscape(true)
- dest := "result.pdf"
- c.Store(req, dest)
-}
+c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file")
+req := gotenberg.NewHTMLRequest(index)
+req.PaperSize(gotenberg.A4)
+req.Margins(gotenberg.NoMargins)
+req.Landscape(true)
+dest := "result.pdf"
+c.Store(req, dest)
```
### PHP
@@ -290,11 +292,58 @@ use TheCodingMachine\Gotenberg\HTMLRequest;
use TheCodingMachine\Gotenberg\Request;
$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', 'index.html');
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
$request = new HTMLRequest($index);
$request->setPaperSize(Request::A4);
$request->setMargins(Request::NO_MARGINS);
$request->setLandscape(true);
+$dest = 'result.pdf';
+$client->store($request, $dest);
+```
+
+## Page ranges
+
+You may specify the page ranges to convert.
+
+The format is the same as the one from the print options
+of Google Chrome, e.g. `1-5,8,11-13`.
+
+### cURL
+
+```bash
+$ curl --request POST \
+ --url http://localhost:3000/convert/html \
+ --header 'Content-Type: multipart/form-data' \
+ --form files=@index.html \
+ --form pageRanges='1-3,5' \
+ -o result.pdf
+```
+
+### Go
+
+```golang
+import "github.com/thecodingmachine/gotenberg-go-client/v7"
+
+c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file")
+req := gotenberg.NewHTMLRequest(index)
+req.PageRanges("1-3,5")
+dest := "result.pdf"
+c.Store(req, dest)
+```
+
+### PHP
+
+```php
+use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\HTMLRequest;
+use TheCodingMachine\Gotenberg\Request;
+
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
+$request = new HTMLRequest($index);
+$request->setPageRanges("1-3,5");
$dest = "result.pdf";
$client->store($request, $dest);
```
@@ -321,15 +370,14 @@ $ curl --request POST \
### Go
```golang
-import "github.com/thecodingmachine/gotenberg-go-client/v6"
+import "github.com/thecodingmachine/gotenberg-go-client/v7"
-func main() {
- c := &gotenberg.Client{Hostname: "http://localhost:3000"}
- req, _ := gotenberg.NewHTMLRequest("index.html")
- req.WaitDelay(5.5)
- dest := "result.pdf"
- c.Store(req, dest)
-}
+c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file")
+req := gotenberg.NewHTMLRequest(index)
+req.WaitDelay(5.5)
+dest := "result.pdf"
+c.Store(req, dest)
```
### PHP
@@ -341,19 +389,23 @@ use TheCodingMachine\Gotenberg\HTMLRequest;
use TheCodingMachine\Gotenberg\Request;
$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', 'index.html');
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
$request = new HTMLRequest($index);
$request->setWaitDelay(5.5);
-$dest = "result.pdf";
+$dest = 'result.pdf';
$client->store($request, $dest);
```
-## Page ranges
+## Rpcc buffer size
-You may specify the page ranges to convert.
+The API might return a `400` HTTP code with the message `increase the Google Chrome rpcc buffer size`.
-The format is the same as the one from the print options
-of Google Chrome, e.g. `1-5,8,11-13`.
+If so, you may increase this buffer size with a form field named `googleChromeRpccBufferSize`.
+
+It takes an int as value (e.g. `1048576` for 1 MB).
+The hard limit is 100 MB and is defined by Google Chrome itself.
+
+> You may also define this value globally: see the [environment variables](#environment_variables.default_google_chrome_rpcc_buffer_size) section.
### cURL
@@ -362,22 +414,21 @@ $ curl --request POST \
--url http://localhost:3000/convert/html \
--header 'Content-Type: multipart/form-data' \
--form files=@index.html \
- --form pageRanges='1-3,5' \
+ --form googleChromeRpccBufferSize=1048576 \
-o result.pdf
```
### Go
```golang
-import "github.com/thecodingmachine/gotenberg-go-client/v6"
+import "github.com/thecodingmachine/gotenberg-go-client/v7"
-func main() {
- c := &gotenberg.Client{Hostname: "http://localhost:3000"}
- req, _ := gotenberg.NewHTMLRequest("index.html")
- req.PageRanges("1-3,5")
- dest := "result.pdf"
- c.Store(req, dest)
-}
+c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file")
+req := gotenberg.NewHTMLRequest(index)
+req.GoogleChromeRpccBufferSize(1048576)
+dest := "result.pdf"
+c.Store(req, dest)
```
### PHP
@@ -389,9 +440,9 @@ use TheCodingMachine\Gotenberg\HTMLRequest;
use TheCodingMachine\Gotenberg\Request;
$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', 'index.html');
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
$request = new HTMLRequest($index);
-$request->setPageRanges("1-3,5");
-$dest = "result.pdf";
+$request->setGoogleChromeRpccBufferSize(1048576);
+$dest = 'result.pdf';
$client->store($request, $dest);
```
diff --git a/build/docs/content/05-url.md b/build/docs/content/05-url.md
index 6517843a..fc307445 100644
--- a/build/docs/content/05-url.md
+++ b/build/docs/content/05-url.md
@@ -31,15 +31,13 @@ $ curl --request POST \
### Go
```golang
-import "github.com/thecodingmachine/gotenberg-go-client/v6"
+import "github.com/thecodingmachine/gotenberg-go-client/v7"
-func main() {
- c := &gotenberg.Client{Hostname: "http://localhost:3000"}
- req := gotenberg.NewURLRequest("https://google.com")
- req.Margins(gotenberg.NoMargins)
- dest := "result.pdf"
- c.Store(req, dest)
-}
+c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+req := gotenberg.NewURLRequest("https://google.com")
+req.Margins(gotenberg.NoMargins)
+dest := "result.pdf"
+c.Store(req, dest)
```
### PHP
@@ -51,6 +49,55 @@ use TheCodingMachine\Gotenberg\URLRequest;
$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
$request = new URLRequest('https://google.com');
$request->setMargins(Request::NO_MARGINS);
-$dest = "result.pdf";
+$dest = 'result.pdf';
+$client->store($request, $dest);
+```
+
+## Custom HTTP headers
+
+You may send your own HTTP headers to the `remoteURL`.
+
+For instance, by adding the HTTP header `Gotenberg-Remoteurl-Your-Header` to your request,
+the API will send a request to the `remoteURL` with the HTTP header `Your-Header`.
+
+> **Attention:** the API uses a canonical format for the HTTP headers:
+> it transforms the first
+> letter and any letter following a hyphen to upper case;
+> the rest are converted to lowercase. For example, the
+> canonical key for `accept-encoding` is `Accept-Encoding`.
+
+### cURL
+
+```bash
+$ curl --request POST \
+ --url http://localhost:3000/convert/url \
+ --header 'Content-Type: multipart/form-data' \
+ --header 'Gotenberg-Remoteurl-Your-Header: Foo' \
+ --form remoteURL=https://google.com \
+ -o result.pdf
+```
+
+### Go
+
+```golang
+import "github.com/thecodingmachine/gotenberg-go-client/v7"
+
+c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+req := gotenberg.NewURLRequest("https://google.com")
+req.AddRemoteURLHTTPHeader("Your-Header", "Foo")
+dest := "result.pdf"
+c.Store(req, dest)
+```
+
+### PHP
+
+```php
+use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\URLRequest;
+
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$request = new URLRequest('https://google.com');
+$request->addRemoteURLHTTPHeader('Your-Header', 'Foo')
+$dest = 'result.pdf';
$client->store($request, $dest);
```
diff --git a/build/docs/content/06-markdown.md b/build/docs/content/06-markdown.md
index 66c50ee4..5838ea7b 100644
--- a/build/docs/content/06-markdown.md
+++ b/build/docs/content/06-markdown.md
@@ -42,14 +42,14 @@ $ curl --request POST \
### Go
```golang
-import "github.com/thecodingmachine/gotenberg-go-client/v6"
+import "github.com/thecodingmachine/gotenberg-go-client/v7"
-func main() {
- c := &gotenberg.Client{Hostname: "http://localhost:3000"}
- req, _ := gotenberg.NewMarkdownRequest("index.html", "file.md")
- dest := "result.pdf"
- c.Store(req, dest)
-}
+c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file")
+markdown, _ := gotenberg.NewDocumentFromPath("file.md", "/path/to/file")
+req := gotenberg.NewMarkdownRequest(index, markdown)
+dest := "result.pdf"
+c.Store(req, dest)
```
### PHP
@@ -60,11 +60,11 @@ use TheCodingMachine\Gotenberg\DocumentFactory;
use TheCodingMachine\Gotenberg\MarkdownRequest;
$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', 'index.html');
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
$markdowns = [
- DocumentFactory::makeFromPath('file.md', 'file.md'),
+ DocumentFactory::makeFromPath('file.md', '/path/to/file'),
];
$request = new MarkdownRequest($index, $markdowns);
-$dest = "result.pdf";
+$dest = 'result.pdf';
$client->store($request, $dest);
```
diff --git a/build/docs/content/07-office.md b/build/docs/content/07-office.md
index 546ee7de..a6ec46e0 100644
--- a/build/docs/content/07-office.md
+++ b/build/docs/content/07-office.md
@@ -41,14 +41,14 @@ $ curl --request POST \
### Go
```golang
-import "github.com/thecodingmachine/gotenberg-go-client/v6"
+import "github.com/thecodingmachine/gotenberg-go-client/v7"
-func main() {
- c := &gotenberg.Client{Hostname: "http://localhost:3000"}
- req, _ := gotenberg.NewOfficeRequest("document.docx", "document2.docx")
- dest := "result.pdf"
- c.Store(req, dest)
-}
+c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+doc, _ := gotenberg.NewDocumentFromPath("document.docx", "/path/to/file")
+doc2, _ := gotenberg.NewDocumentFromPath("document2.docx", "/path/to/file")
+req := gotenberg.NewOfficeRequest(doc, doc2)
+dest := "result.pdf"
+c.Store(req, dest)
```
### PHP
@@ -60,11 +60,11 @@ use TheCodingMachine\Gotenberg\OfficeRequest;
$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
$files = [
- DocumentFactory::makeFromPath('document.docx', 'document.docx'),
- DocumentFactory::makeFromPath('document2.docx', 'document2.docx'),
+ DocumentFactory::makeFromPath('document.docx', '/path/to/file'),
+ DocumentFactory::makeFromPath('document2.docx', '/path/to/file'),
];
$request = new OfficeRequest($files);
-$dest = "result.pdf";
+$dest = 'result.pdf';
$client->store($request, $dest);
```
@@ -88,15 +88,14 @@ $ curl --request POST \
### Go
```golang
-import "github.com/thecodingmachine/gotenberg-go-client/v6"
+import "github.com/thecodingmachine/gotenberg-go-client/v7"
-func main() {
- c := &gotenberg.Client{Hostname: "http://localhost:3000"}
- req, _ := gotenberg.NewOfficeRequest("document.docx")
- req.Landscape(true)
- dest := "result.pdf"
- c.Store(req, dest)
-}
+c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+doc, _ := gotenberg.NewDocumentFromPath("document.docx", "/path/to/file")
+req := gotenberg.NewOfficeRequest(doc)
+req.Landscape(true)
+dest := "result.pdf"
+c.Store(req, dest)
```
### PHP
@@ -108,11 +107,11 @@ use TheCodingMachine\Gotenberg\OfficeRequest;
$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
$files = [
- DocumentFactory::makeFromPath('document.docx', 'document.docx'),
+ DocumentFactory::makeFromPath('document.docx', '/path/to/file'),
];
$request = new OfficeRequest($files);
$request->setLandscape(true);
-$dest = "result.pdf";
+$dest = 'result.pdf';
$client->store($request, $dest);
```
@@ -142,13 +141,12 @@ $ curl --request POST \
```golang
import "github.com/thecodingmachine/gotenberg-go-client/v6"
-func main() {
- c := &gotenberg.Client{Hostname: "http://localhost:3000"}
- req, _ := gotenberg.NewOfficeRequest("document.docx")
- req.PageRanges("1-3")
- dest := "result.pdf"
- c.Store(req, dest)
-}
+c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+doc, _ := gotenberg.NewDocumentFromPath("document.docx", "/path/to/file")
+req := gotenberg.NewOfficeRequest(doc)
+req.PageRanges("1-3")
+dest := "result.pdf"
+c.Store(req, dest)
```
### PHP
@@ -160,7 +158,7 @@ use TheCodingMachine\Gotenberg\OfficeRequest;
$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
$files = [
- DocumentFactory::makeFromPath('document.docx', 'document.docx'),
+ DocumentFactory::makeFromPath('document.docx', '/path/to/file'),
];
$request = new OfficeRequest($files);
$request->setPageRanges("1-3");
diff --git a/build/docs/content/08-merge.md b/build/docs/content/08-merge.md
index 49ac0b2b..8e693743 100644
--- a/build/docs/content/08-merge.md
+++ b/build/docs/content/08-merge.md
@@ -27,14 +27,14 @@ $ curl --request POST \
### Go
```golang
-import "github.com/thecodingmachine/gotenberg-go-client/v6"
+import "github.com/thecodingmachine/gotenberg-go-client/v7"
-func main() {
- c := &gotenberg.Client{Hostname: "http://localhost:3000"}
- req, _ := gotenberg.NewMergeRequest("file.pdf", "file2.pdf")
- dest := "result.pdf"
- c.Store(req, dest)
-}
+c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+pdf, _ := gotenberg.NewDocumentFromPath("file.pdf", "/path/to/file")
+pdf2, _ := gotenberg.NewDocumentFromPath("file2.pdf", "/path/to/file")
+req := gotenberg.NewMergeRequest(pdf, pdf2)
+dest := "result.pdf"
+c.Store(req, dest)
```
### PHP
@@ -46,10 +46,10 @@ use TheCodingMachine\Gotenberg\MergeRequest;
$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
$files = [
- DocumentFactory::makeFromPath('file.pdf', 'file.pdf'),
- DocumentFactory::makeFromPath('file2.pdf', 'file2.pdf'),
+ DocumentFactory::makeFromPath('file.pdf', '/path/to/file'),
+ DocumentFactory::makeFromPath('file2.pdf', '/path/to/file'),
];
$request = new MergeRequest($files);
-$dest = "result.pdf";
+$dest = 'result.pdf';
$client->store($request, $dest);
```
diff --git a/build/docs/content/09-timeout.md b/build/docs/content/09-timeout.md
index 9392b84f..c7cbbd70 100644
--- a/build/docs/content/09-timeout.md
+++ b/build/docs/content/09-timeout.md
@@ -26,14 +26,13 @@ $ curl --request POST \
### Go
```golang
-import "github.com/thecodingmachine/gotenberg-go-client/v6"
+import "github.com/thecodingmachine/gotenberg-go-client/v7"
-func main() {
- c := &gotenberg.Client{Hostname: "http://localhost:3000"}
- req, _ := gotenberg.NewHTMLRequest("index.html")
- req.WaitTimeout(2.5)
- resp, _ := c.Post(req)
-}
+c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file")
+req := gotenberg.NewHTMLRequest(index)
+req.WaitTimeout(2.5)
+resp, _ := c.Post(req)
```
### PHP
@@ -45,9 +44,9 @@ use TheCodingMachine\Gotenberg\HTMLRequest;
use TheCodingMachine\Gotenberg\Request;
$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', 'index.html');
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
$request = new HTMLRequest($index);
$request->setWaitTimeout(2.5);
-$dest = "result.pdf";
+$dest = 'result.pdf';
$client->store($request, $dest);
```
diff --git a/build/docs/content/10-webhook.md b/build/docs/content/10-webhook.md
index fff2456d..3d5e69e1 100644
--- a/build/docs/content/10-webhook.md
+++ b/build/docs/content/10-webhook.md
@@ -24,14 +24,13 @@ $ curl --request POST \
### Go
```golang
-import "github.com/thecodingmachine/gotenberg-go-client/v6"
+import "github.com/thecodingmachine/gotenberg-go-client/v7"
-func main() {
- c := &gotenberg.Client{Hostname: "http://localhost:3000"}
- req, _ := gotenberg.NewHTMLRequest("index.html")
- req.WebhookURL("http://myapp.com/webhook/")
- resp, _ := c.Post(req)
-}
+c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file")
+req := gotenberg.NewHTMLRequest(index)
+req.WebhookURL("http://myapp.com/webhook/")
+resp, _ := c.Post(req)
```
### PHP
@@ -42,7 +41,7 @@ use TheCodingMachine\Gotenberg\DocumentFactory;
use TheCodingMachine\Gotenberg\HTMLRequest;
$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', 'index.html');
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
$request = new HTMLRequest($index);
$request->setWebhookURL('http://myapp.com/webhook/');
$resp = $client->post($request);
@@ -58,9 +57,7 @@ It takes a float as value (e.g `2.5` for 2.5 seconds).
> You may also define this value globally: see the [environment variables](#environment_variables.default_webhook_url_timeout) section.
-### Examples
-
-#### cURL
+### cURL
```bash
$ curl --request POST \
@@ -71,21 +68,20 @@ $ curl --request POST \
--form webhookURLTimeout=2.5
```
-#### Go
+### Go
```golang
-import "github.com/thecodingmachine/gotenberg-go-client/v6"
+import "github.com/thecodingmachine/gotenberg-go-client/v7"
-func main() {
- c := &gotenberg.Client{Hostname: "http://localhost:3000"}
- req, _ := gotenberg.NewHTMLRequest("index.html")
- req.WebhookURL("http://myapp.com/webhook/")
- req.WebhookURLTimeout(2.5)
- resp, _ := c.Post(req)
-}
+c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file")
+req := gotenberg.NewHTMLRequest(index)
+req.WebhookURL("http://myapp.com/webhook/")
+req.WebhookURLTimeout(2.5)
+resp, _ := c.Post(req)
```
-#### PHP
+### PHP
```php
use TheCodingMachine\Gotenberg\Client;
@@ -93,9 +89,61 @@ use TheCodingMachine\Gotenberg\DocumentFactory;
use TheCodingMachine\Gotenberg\HTMLRequest;
$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', 'index.html');
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
$request = new HTMLRequest($index);
$request->setWebhookURL('http://myapp.com/webhook/');
$request->setWebhookURLTimeout(2.5);
$resp = $client->post($request);
```
+
+## Custom HTTP headers
+
+You may send your own HTTP headers to the `webhookURL`.
+
+For instance, by adding the HTTP header `Gotenberg-Webhookurl-Your-Header` to your request,
+the API will send a request to the `webhookURL` with the HTTP header `Your-Header`.
+
+> **Attention:** the API uses a canonical format for the HTTP headers:
+> it transforms the first
+> letter and any letter following a hyphen to upper case;
+> the rest are converted to lowercase. For example, the
+> canonical key for `accept-encoding` is `Accept-Encoding`.
+
+### cURL
+
+```bash
+$ curl --request POST \
+ --url http://localhost:3000/convert/html \
+ --header 'Content-Type: multipart/form-data' \
+ --header 'Gotenberg-Webhookurl-Your-Header: Foo' \
+ --form files=@index.html \
+ --form webhookURL='http://myapp.com/webhook/'
+```
+
+### Go
+
+```golang
+import "github.com/thecodingmachine/gotenberg-go-client/v7"
+
+c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file")
+req := gotenberg.NewHTMLRequest(index)
+req.WebhookURL("http://myapp.com/webhook/")
+req.AddWebhookURLHTTPHeader("Your-Header", "Foo")
+resp, _ := c.Post(req)
+```
+
+### PHP
+
+```php
+use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\HTMLRequest;
+
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
+$request = new HTMLRequest($index);
+$request->setWebhookURL('http://myapp.com/webhook/');
+$request->addWebhookURLHTTPHeader('Your-Header', 'Foo');
+$resp = $client->post($request);
+```
\ No newline at end of file
diff --git a/build/docs/content/11-result-filename.md b/build/docs/content/11-result-filename.md
index aabb4177..94bc230f 100644
--- a/build/docs/content/11-result-filename.md
+++ b/build/docs/content/11-result-filename.md
@@ -24,14 +24,13 @@ $ curl --request POST \
### Go
```golang
-import "github.com/thecodingmachine/gotenberg-go-client/v6"
+import "github.com/thecodingmachine/gotenberg-go-client/v7"
-func main() {
- c := &gotenberg.Client{Hostname: "http://localhost:3000"}
- req, _ := gotenberg.NewHTMLRequest("index.html")
- req.ResultFilename("foo.pdf")
- resp, _ := c.Post(req)
-}
+c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file")
+req := gotenberg.NewHTMLRequest(index)
+req.ResultFilename("foo.pdf")
+resp, _ := c.Post(req)
```
### PHP
@@ -43,7 +42,7 @@ use TheCodingMachine\Gotenberg\HTMLRequest;
use TheCodingMachine\Gotenberg\Request;
$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', 'index.html');
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
$request = new HTMLRequest($index);
$request->setResultFilename('foo.pdf');
$resp = $client->post($request);
diff --git a/build/docs/content/12-scalability.md b/build/docs/content/12-scalability.md
index 7b30ef41..b1a062fc 100644
--- a/build/docs/content/12-scalability.md
+++ b/build/docs/content/12-scalability.md
@@ -5,10 +5,10 @@ title: Scalability
The API uses under the hood intricate programs.
Gotenberg tries to abstract as much complexity as possible but it can
-only do it to a certain extend.
+only do it to a certain extent.
For instance, [Office](#office) and [Merge](#merge) endpoints will start respectively as many LibreOffice (unoconv) and PDTk
-instances are there are requests. The limitation here is the available memory and CPU usage.
+instances as there are requests. The limitation here is the available memory and CPU usage.
On another hand, for the [HTML](#html), [URL](#url) and [Markdown](#markdown) endpoints, the API does only 6 conversions in parallel.
Indeed, Google Chrome misbehaves if there are too many concurrent conversions.
diff --git a/build/docs/content/15-links.md b/build/docs/content/15-links.md
index 23ac7d55..17f2aa7c 100644
--- a/build/docs/content/15-links.md
+++ b/build/docs/content/15-links.md
@@ -2,8 +2,10 @@
title: Links
---
+
+
+
+
Gotenberg
A Docker-powered stateless API for converting HTML, Markdown and Office documents to PDF.
Gotenberg is shipped within a Docker image.
---It uses a dedicated non-root user called
-gotenbergwith uid and gid1001.
You may start it with:
-$ docker run --rm -p 3000:3000 thecodingmachine/gotenberg:6 +$ docker run --rm -p 3000:3000 thecodingmachine/gotenberg:6+The API will be available at http://localhost:3000.
The image uses a dedicated non-root user called
+ +gotenbergwith uid and gid1001.If you wish to change those uid and gid, you will have to:
+ +
For instance:
+ +$ git clone https://github.com/thecodingmachine/gotenberg.git +$ make publish GOTENBERG_USER_GID=your_custom_gid GOTENBERG_USER_UID=your_custom_uid DOCKER_REGISTRY=your_registry DOCKER_USER=registry_user DOCKER_PASSWORD=registry_password VERSION=6.1.0 ++ +
+++
masterbranch is always up-to-date with the latest version of the API.
You may also add it in your Docker Compose stack:
-version: '3' +version: '3' -services: +services: # your others services - gotenberg: - image: thecodingmachine/gotenberg:6 + gotenberg: + image: thecodingmachine/gotenberg:6@@ -177,13 +193,19 @@-The more resources are granted, the quicker will be the conversions.
In the deployment specification of the pod, also specify the uid
+1001of the usergotenberg:In the deployment specification of the pod, also specify the uid of the user
gotenberg:securityContext: privileged: false runAsUser: 1001+Cloud Run (Google Cloud)
+ +If you’re looking for cost savings, you might be interested by Cloud Run.
+In the following examples, we will assume your Gotenberg API is available at http://localhost:3000.
@@ -199,9 +221,11 @@ Gotenberg API is available at http://localhost:3 Go client -$ go get -u github.com/thecodingmachine/gotenberg-go-client/v6 +$ go get -u github.com/thecodingmachine/gotenberg-go-client/v7+See also the example from the README.
+PHP client
@@ -211,11 +235,22 @@ Gotenberg API is available at http://localhost:3$ composer require php-http/guzzle6-adapter-Then the PHP client:
+Then the PHP client:
$ composer require thecodingmachine/gotenberg-php-client+See also the example from the README.
+ +Community clients
+ + +
This environment variable accepts any string that can be turned into a port number.
+By default, the API root path is /.
You may customize this value with the environment variable ROOT_PATH.
This environment variable accepts a string starting and ending with /.
For instance, /gotenberg/ is a valid value while gotenberg is not.
++This is useful if you wish to do service discovery via URL paths.
+
When performing a HTML, URL or Markdown conversion, the API might return
+a 400 HTTP code with the message increase the Google Chrome rpcc buffer size.
If so, you may increase this buffer size with the environment variable DEFAULT_GOOGLE_CHROME_RPCC_BUFFER_SIZE.
It takes a string representation of an int as value (e.g. "1048576" for 1 MB).
+The hard limit is 100 MB and is defined by Google Chrome itself.
++The default Google Chrome rpcc buffer size may also be overridden per request thanks to the form field
+googleChromeRpccBufferSize. +See the rpcc buffer size section.
import "github.com/thecodingmachine/gotenberg-go-client/v6" +import "github.com/thecodingmachine/gotenberg-go-client/v7" -func main() { - c := &gotenberg.Client{Hostname: "http://localhost:3000"} - req, _ := gotenberg.NewHTMLRequest("index.html") - dest := "result.pdf" - c.Store(req, dest) -} +c := &gotenberg.Client{Hostname: "http://localhost:3000"} +index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file") +req := gotenberg.NewHTMLRequest(index) +dest := "result.pdf" +c.Store(req, dest)
import "github.com/thecodingmachine/gotenberg-go-client/v6" +@@ -624,8 +695,8 @@ $client->store($request, $dest); --url http://localhost:3000/convert/html \ --header 'Content-Type: multipart/form-data' \ --form files=@index.html \ - --form paperWidth=8.27 \ - --form paperHeight=11.69 \ + --form paperWidth=8.27 \ + --form paperHeight=11.69 \ --form marginTop=0 \ --form marginBottom=0 \ --form marginLeft=0 \ @@ -638,17 +709,16 @@ $client->store($request, $dest); Go -import "github.com/thecodingmachine/gotenberg-go-client/v7" -func main() { - c := &gotenberg.Client{Hostname: "http://localhost:3000"} - req, _ := gotenberg.NewHTMLRequest("index.html") - req.Assets("font.woff", "img.gif", "style.css") - dest := "result.pdf" - c.Store(req, dest) -} +c := &gotenberg.Client{Hostname: "http://localhost:3000"} +index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file") +style, _ := gotenberg.NewDocumentFromPath("style.css", "/path/to/file") +img, _ := gotenberg.NewDocumentFromPath("img.png", "/path/to/file") +font, _ := gotenberg.NewDocumentFromPath("font.woff", "/path/to/file") +req := gotenberg.NewHTMLRequest(index) +req.Assets(style, img, font) +dest := "result.pdf" +c.Store(req, dest)
import "github.com/thecodingmachine/gotenberg-go-client/v6" +- -import "github.com/thecodingmachine/gotenberg-go-client/v7" -func main() { - c := &gotenberg.Client{Hostname: "http://localhost:3000"} - req, _ := gotenberg.NewHTMLRequest("index.html") - req.PaperSize(gotenberg.A4) - req.Margins(gotenberg.NoMargins) - req.Landscape(true) - dest := "result.pdf" - c.Store(req, dest) -} +c := &gotenberg.Client{Hostname: "http://localhost:3000"} +index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file") +req := gotenberg.NewHTMLRequest(index) +req.PaperSize(gotenberg.A4) +req.Margins(gotenberg.NoMargins) +req.Landscape(true) +dest := "result.pdf" +c.Store(req, dest)
In some cases, you may want to wait a certain amount of time to make sure the -page you’re trying to generate is fully rendered. For instance, if your page relies -a lot on JavaScript for rendering.
- --- -The wait delay is a duration in seconds (e.g
-2.5for 2.5 seconds).
$ curl --request POST \ - --url http://localhost:3000/convert/html \ - --header 'Content-Type: multipart/form-data' \ - --form files=@index.html \ - --form waitDelay=5.5 \ - -o result.pdf -- -
import "github.com/thecodingmachine/gotenberg-go-client/v6" - -func main() { - c := &gotenberg.Client{Hostname: "http://localhost:3000"} - req, _ := gotenberg.NewHTMLRequest("index.html") - req.WaitDelay(5.5) - dest := "result.pdf" - c.Store(req, dest) -} -- -
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\DocumentFactory;
-use TheCodingMachine\Gotenberg\HTMLRequest;
-use TheCodingMachine\Gotenberg\Request;
-
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', 'index.html');
-$request = new HTMLRequest($index);
-$request->setWaitDelay(5.5);
-$dest = "result.pdf";
+$dest = 'result.pdf';
$client->store($request, $dest);
@@ -751,15 +765,14 @@ of Google Chrome, e.g. 1-5,8,11-13.
Go
-import "github.com/thecodingmachine/gotenberg-go-client/v6" ++ +import "github.com/thecodingmachine/gotenberg-go-client/v7" -func main() { - c := &gotenberg.Client{Hostname: "http://localhost:3000"} - req, _ := gotenberg.NewHTMLRequest("index.html") - req.PageRanges("1-3,5") - dest := "result.pdf" - c.Store(req, dest) -} +c := &gotenberg.Client{Hostname: "http://localhost:3000"} +index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file") +req := gotenberg.NewHTMLRequest(index) +req.PageRanges("1-3,5") +dest := "result.pdf" +c.Store(req, dest)
In some cases, you may want to wait a certain amount of time to make sure the +page you’re trying to generate is fully rendered. For instance, if your page relies +a lot on JavaScript for rendering.
+ +++ +The wait delay is a duration in seconds (e.g
+2.5for 2.5 seconds).
$ curl --request POST \ + --url http://localhost:3000/convert/html \ + --header 'Content-Type: multipart/form-data' \ + --form files=@index.html \ + --form waitDelay=5.5 \ + -o result.pdf ++ +
import "github.com/thecodingmachine/gotenberg-go-client/v7" + +c := &gotenberg.Client{Hostname: "http://localhost:3000"} +index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file") +req := gotenberg.NewHTMLRequest(index) +req.WaitDelay(5.5) +dest := "result.pdf" +c.Store(req, dest) ++ +
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\HTMLRequest;
+use TheCodingMachine\Gotenberg\Request;
+
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
+$request = new HTMLRequest($index);
+$request->setWaitDelay(5.5);
+$dest = 'result.pdf';
+$client->store($request, $dest);
+
+
+The API might return a 400 HTTP code with the message increase the Google Chrome rpcc buffer size.
If so, you may increase this buffer size with a form field named googleChromeRpccBufferSize.
It takes an int as value (e.g. 1048576 for 1 MB).
+The hard limit is 100 MB and is defined by Google Chrome itself.
++ +You may also define this value globally: see the environment variables section.
+
$ curl --request POST \ + --url http://localhost:3000/convert/html \ + --header 'Content-Type: multipart/form-data' \ + --form files=@index.html \ + --form googleChromeRpccBufferSize=1048576 \ + -o result.pdf ++ +
import "github.com/thecodingmachine/gotenberg-go-client/v7" + +c := &gotenberg.Client{Hostname: "http://localhost:3000"} +index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file") +req := gotenberg.NewHTMLRequest(index) +req.GoogleChromeRpccBufferSize(1048576) +dest := "result.pdf" +c.Store(req, dest) ++ +
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\HTMLRequest;
+use TheCodingMachine\Gotenberg\Request;
+
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
+$request = new HTMLRequest($index);
+$request->setGoogleChromeRpccBufferSize(1048576);
+$dest = 'result.pdf';
+$client->store($request, $dest);
import "github.com/thecodingmachine/gotenberg-go-client/v6" ++ +import "github.com/thecodingmachine/gotenberg-go-client/v7" -func main() { - c := &gotenberg.Client{Hostname: "http://localhost:3000"} - req := gotenberg.NewURLRequest("https://google.com") - req.Margins(gotenberg.NoMargins) - dest := "result.pdf" - c.Store(req, dest) -} +c := &gotenberg.Client{Hostname: "http://localhost:3000"} +req := gotenberg.NewURLRequest("https://google.com") +req.Margins(gotenberg.NoMargins) +dest := "result.pdf" +c.Store(req, dest)
You may send your own HTTP headers to the remoteURL.
For instance, by adding the HTTP header Gotenberg-Remoteurl-Your-Header to your request,
+the API will send a request to the remoteURL with the HTTP header Your-Header.
++ +Attention: the API uses a canonical format for the HTTP headers: +it transforms the first +letter and any letter following a hyphen to upper case; +the rest are converted to lowercase. For example, the +canonical key for
+accept-encodingisAccept-Encoding.
$ curl --request POST \ + --url http://localhost:3000/convert/url \ + --header 'Content-Type: multipart/form-data' \ + --header 'Gotenberg-Remoteurl-Your-Header: Foo' \ + --form remoteURL=https://google.com \ + -o result.pdf ++ +
import "github.com/thecodingmachine/gotenberg-go-client/v7" + +c := &gotenberg.Client{Hostname: "http://localhost:3000"} +req := gotenberg.NewURLRequest("https://google.com") +req.AddRemoteURLHTTPHeader("Your-Header", "Foo") +dest := "result.pdf" +c.Store(req, dest) ++ +
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\URLRequest;
+
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$request = new URLRequest('https://google.com');
+$request->addRemoteURLHTTPHeader('Your-Header', 'Foo')
+$dest = 'result.pdf';
$client->store($request, $dest);
@@ -894,14 +1074,14 @@ in the file index.html. This function will convert a given markdown
Go
-import "github.com/thecodingmachine/gotenberg-go-client/v6" +@@ -975,14 +1155,14 @@ $client->store($request, $dest); Go -import "github.com/thecodingmachine/gotenberg-go-client/v7" -func main() { - c := &gotenberg.Client{Hostname: "http://localhost:3000"} - req, _ := gotenberg.NewMarkdownRequest("index.html", "file.md") - dest := "result.pdf" - c.Store(req, dest) -} +c := &gotenberg.Client{Hostname: "http://localhost:3000"} +index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file") +markdown, _ := gotenberg.NewDocumentFromPath("file.md", "/path/to/file") +req := gotenberg.NewMarkdownRequest(index, markdown) +dest := "result.pdf" +c.Store(req, dest)
import "github.com/thecodingmachine/gotenberg-go-client/v6" +@@ -1027,15 +1207,14 @@ $client->store($request, $dest); Go -import "github.com/thecodingmachine/gotenberg-go-client/v7" -func main() { - c := &gotenberg.Client{Hostname: "http://localhost:3000"} - req, _ := gotenberg.NewOfficeRequest("document.docx", "document2.docx") - dest := "result.pdf" - c.Store(req, dest) -} +c := &gotenberg.Client{Hostname: "http://localhost:3000"} +doc, _ := gotenberg.NewDocumentFromPath("document.docx", "/path/to/file") +doc2, _ := gotenberg.NewDocumentFromPath("document2.docx", "/path/to/file") +req := gotenberg.NewOfficeRequest(doc, doc2) +dest := "result.pdf" +c.Store(req, dest)
import "github.com/thecodingmachine/gotenberg-go-client/v6" +@@ -1088,13 +1267,12 @@ applied for each document.import "github.com/thecodingmachine/gotenberg-go-client/v7" -func main() { - c := &gotenberg.Client{Hostname: "http://localhost:3000"} - req, _ := gotenberg.NewOfficeRequest("document.docx") - req.Landscape(true) - dest := "result.pdf" - c.Store(req, dest) -} +c := &gotenberg.Client{Hostname: "http://localhost:3000"} +doc, _ := gotenberg.NewDocumentFromPath("document.docx", "/path/to/file") +req := gotenberg.NewOfficeRequest(doc) +req.Landscape(true) +dest := "result.pdf" +c.Store(req, dest)
import "github.com/thecodingmachine/gotenberg-go-client/v6" -func main() { - c := &gotenberg.Client{Hostname: "http://localhost:3000"} - req, _ := gotenberg.NewOfficeRequest("document.docx") - req.PageRanges("1-3") - dest := "result.pdf" - c.Store(req, dest) -} +c := &gotenberg.Client{Hostname: "http://localhost:3000"} +doc, _ := gotenberg.NewDocumentFromPath("document.docx", "/path/to/file") +req := gotenberg.NewOfficeRequest(doc) +req.PageRanges("1-3") +dest := "result.pdf" +c.Store(req, dest)
import "github.com/thecodingmachine/gotenberg-go-client/v6" +@@ -1209,21 +1387,20 @@ If unsucessful, it returns aimport "github.com/thecodingmachine/gotenberg-go-client/v7" -func main() { - c := &gotenberg.Client{Hostname: "http://localhost:3000"} - req, _ := gotenberg.NewMergeRequest("file.pdf", "file2.pdf") - dest := "result.pdf" - c.Store(req, dest) -} +c := &gotenberg.Client{Hostname: "http://localhost:3000"} +pdf, _ := gotenberg.NewDocumentFromPath("file.pdf", "/path/to/file") +pdf2, _ := gotenberg.NewDocumentFromPath("file2.pdf", "/path/to/file") +req := gotenberg.NewMergeRequest(pdf, pdf2) +dest := "result.pdf" +c.Store(req, dest)
504 HTTP code.
--url http://localhost:3000/convert/html \
--header 'Content-Type: multipart/form-data' \
--form files=@index.html \
- --form waitTimeout=2.5
+ --form waitTimeout=2.5
import "github.com/thecodingmachine/gotenberg-go-client/v6" +@@ -1275,14 +1452,13 @@ to given URL. Go -import "github.com/thecodingmachine/gotenberg-go-client/v7" -func main() { - c := &gotenberg.Client{Hostname: "http://localhost:3000"} - req, _ := gotenberg.NewHTMLRequest("index.html") - req.WaitTimeout(2.5) - resp, _ := c.Post(req) -} +c := &gotenberg.Client{Hostname: "http://localhost:3000"} +index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file") +req := gotenberg.NewHTMLRequest(index) +req.WaitTimeout(2.5) +resp, _ := c.Post(req)
import "github.com/thecodingmachine/gotenberg-go-client/v6" +import "github.com/thecodingmachine/gotenberg-go-client/v7" -func main() { - c := &gotenberg.Client{Hostname: "http://localhost:3000"} - req, _ := gotenberg.NewHTMLRequest("index.html") - req.WebhookURL("http://myapp.com/webhook/") - resp, _ := c.Post(req) -} +c := &gotenberg.Client{Hostname: "http://localhost:3000"} +index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file") +req := gotenberg.NewHTMLRequest(index) +req.WebhookURL("http://myapp.com/webhook/") +resp, _ := c.Post(req)Go
-import "github.com/thecodingmachine/gotenberg-go-client/v6" +import "github.com/thecodingmachine/gotenberg-go-client/v7" -func main() { - c := &gotenberg.Client{Hostname: "http://localhost:3000"} - req, _ := gotenberg.NewHTMLRequest("index.html") - req.WebhookURL("http://myapp.com/webhook/") - req.WebhookURLTimeout(2.5) - resp, _ := c.Post(req) -} +c := &gotenberg.Client{Hostname: "http://localhost:3000"} +index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file") +req := gotenberg.NewHTMLRequest(index) +req.WebhookURL("http://myapp.com/webhook/") +req.WebhookURLTimeout(2.5) +resp, _ := c.Post(req)-+PHP
use TheCodingMachine\Gotenberg\Client; use TheCodingMachine\Gotenberg\DocumentFactory; use TheCodingMachine\Gotenberg\HTMLRequest; $client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client()); -$index = DocumentFactory::makeFromPath('index.html', 'index.html'); +$index = DocumentFactory::makeFromPath('index.html', '/path/to/file'); $request = new HTMLRequest($index); $request->setWebhookURL('http://myapp.com/webhook/'); $request->setWebhookURLTimeout(2.5); $resp = $client->post($request); ++ +Custom HTTP headers
+ +You may send your own HTTP headers to the
+ +webhookURL.For instance, by adding the HTTP header
+ +Gotenberg-Webhookurl-Your-Headerto your request, +the API will send a request to thewebhookURLwith the HTTP headerYour-Header.++ +Attention: the API uses a canonical format for the HTTP headers: +it transforms the first +letter and any letter following a hyphen to upper case; +the rest are converted to lowercase. For example, the +canonical key for
+accept-encodingisAccept-Encoding.cURL
+ +$ curl --request POST \ + --url http://localhost:3000/convert/html \ + --header 'Content-Type: multipart/form-data' \ + --header 'Gotenberg-Webhookurl-Your-Header: Foo' \ + --form files=@index.html \ + --form webhookURL='http://myapp.com/webhook/' ++ +Go
+ +import "github.com/thecodingmachine/gotenberg-go-client/v7" + +c := &gotenberg.Client{Hostname: "http://localhost:3000"} +index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file") +req := gotenberg.NewHTMLRequest(index) +req.WebhookURL("http://myapp.com/webhook/") +req.AddWebhookURLHTTPHeader("Your-Header", "Foo") +resp, _ := c.Post(req) ++ +PHP
+ +use TheCodingMachine\Gotenberg\Client; +use TheCodingMachine\Gotenberg\DocumentFactory; +use TheCodingMachine\Gotenberg\HTMLRequest; + +$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client()); +$index = DocumentFactory::makeFromPath('index.html', '/path/to/file'); +$request = new HTMLRequest($index); +$request->setWebhookURL('http://myapp.com/webhook/'); +$request->addWebhookURLHTTPHeader('Your-Header', 'Foo'); +$resp = $client->post($request);
import "github.com/thecodingmachine/gotenberg-go-client/v6" +import "github.com/thecodingmachine/gotenberg-go-client/v7" -func main() { - c := &gotenberg.Client{Hostname: "http://localhost:3000"} - req, _ := gotenberg.NewHTMLRequest("index.html") - req.ResultFilename("foo.pdf") - resp, _ := c.Post(req) -} +c := &gotenberg.Client{Hostname: "http://localhost:3000"} +index, _ := gotenberg.NewDocumentFromPath("index.html", "/path/to/file") +req := gotenberg.NewHTMLRequest(index) +req.ResultFilename("foo.pdf") +resp, _ := c.Post(req)