mirror of
https://github.com/gotenberg/gotenberg.git
synced 2026-08-14 11:22:15 +01:00
138 lines
3.2 KiB
Markdown
138 lines
3.2 KiB
Markdown
---
|
||
title: Office
|
||
---
|
||
|
||
Gotenberg provides the endpoint `/convert/office` for Office document conversions.
|
||
|
||
It accepts `POST` requests with a `multipart/form-data` Content-Type.
|
||
|
||
## Basic
|
||
|
||
You may send one or more Office documents. Following file extensions are accepted:
|
||
|
||
* `.txt`
|
||
* `.rtf`
|
||
* `.doc`
|
||
* `.docx`
|
||
* `.odt`
|
||
* `.xls`
|
||
* `.xlsx`
|
||
* `.ods`
|
||
* `.ppt`
|
||
* `.pptx`
|
||
* `.odp`
|
||
|
||
All files will be merged into a single resulting PDF.
|
||
|
||
> **Attention:** currently, `unoconv` cannot perform concurrent conversions.
|
||
> That's why for Office conversions, the API does only one conversion at a time.
|
||
> See the [scalability section](#scalability) to find how to mitigate this issue.
|
||
|
||
### cURL
|
||
|
||
```bash
|
||
$ curl --request POST \
|
||
--url http://localhost:3000/convert/office \
|
||
--header 'Content-Type: multipart/form-data' \
|
||
--form files=@document.docx \
|
||
--form files=@document2.docx \
|
||
-o result.pdf
|
||
```
|
||
|
||
### Go
|
||
|
||
```golang
|
||
import "github.com/thecodingmachine/gotenberg/pkg"
|
||
|
||
func main() {
|
||
c := &gotenberg.Client{Hostname: "http://localhost:3000"}
|
||
req, _ := gotenberg.NewOfficeRequest([]string{"document.docx", "document2.docx"})
|
||
dest := "result.pdf"
|
||
c.Store(req, dest)
|
||
}
|
||
```
|
||
|
||
### PHP
|
||
|
||
```php
|
||
use TheCodingMachine\Gotenberg\Client;
|
||
use TheCodingMachine\Gotenberg\DocumentFactory;
|
||
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'),
|
||
];
|
||
$request = new OfficeRequest($files);
|
||
$dirPath = "/foo";
|
||
$filename = $client->store($request, $dirPath);
|
||
```
|
||
|
||
## Paper size and orientation
|
||
|
||
You may also customize the resulting PDF format.
|
||
|
||
By default, it will be rendered with `A4` size and `portrait` orientation.
|
||
|
||
> Paper size has to be provided in `inches`.
|
||
> Also, you have to set both `paperWidth` and `paperHeight`.
|
||
|
||
### cURL
|
||
|
||
```bash
|
||
$ curl --request POST \
|
||
--url http://localhost:3000/convert/office \
|
||
--header 'Content-Type: multipart/form-data' \
|
||
--form files=@document.docx \
|
||
--form paperWidth=8.27 \
|
||
--form paperHeight=11.27 \
|
||
--form landscape=true \
|
||
-o result.pdf
|
||
```
|
||
|
||
### Go
|
||
|
||
```golang
|
||
import "github.com/thecodingmachine/gotenberg/pkg"
|
||
|
||
func main() {
|
||
c := &gotenberg.Client{Hostname: "http://localhost:3000"}
|
||
req, _ := gotenberg.NewOfficeRequest([]string{"document.docx"})
|
||
req.SetPaperSize(gotenberg.A4)
|
||
req.SetLandscape(true)
|
||
dest := "result.pdf"
|
||
c.Store(req, dest)
|
||
}
|
||
```
|
||
|
||
### PHP
|
||
|
||
```php
|
||
use TheCodingMachine\Gotenberg\Client;
|
||
use TheCodingMachine\Gotenberg\DocumentFactory;
|
||
use TheCodingMachine\Gotenberg\OfficeRequest;
|
||
|
||
$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
|
||
$files = [
|
||
DocumentFactory::makeFromPath('document.docx', 'document.docx'),
|
||
];
|
||
$request = new OfficeRequest($files);
|
||
$request->setPaperSize(Request::A4);
|
||
$request->setLandscape(true);
|
||
$dirPath = "/foo";
|
||
$filename = $client->store($request, $dirPath);
|
||
```
|
||
|
||
## Fonts
|
||
|
||
By default, only ` ttf-mscorefonts` fonts are installed.
|
||
|
||
If you wish to use more fonts, you will have to create your own image:
|
||
|
||
```Dockerfile
|
||
FROM thecodingmachine/gotenberg:3
|
||
|
||
RUN apt-get -y install yourfonts
|
||
```
|