mirror of
https://github.com/gotenberg/gotenberg.git
synced 2026-08-08 08:32:16 +01:00
Compare commits
7 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4827a45f22 | ||
|
|
40eef457ab | ||
|
|
c22a4d109b | ||
|
|
571c3e04c4 | ||
|
|
f9fb97a572 | ||
|
|
e6484bb2d5 | ||
|
|
19f51fdc1f |
@@ -186,6 +186,9 @@ You may also use *remote* paths for Google fonts, images and so on.
|
||||
|
||||
> If you want to install fonts directly in the Gotenberg Docker image,
|
||||
> see to the [fonts section](#fonts).
|
||||
>
|
||||
> For web fonts (Google fonts), there is a timeout of 500ms by default. You may update
|
||||
> this value thanks to the form field `webFontsTimeout`.
|
||||
|
||||
### cURL
|
||||
|
||||
|
||||
@@ -52,5 +52,5 @@ $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";
|
||||
$filename = $client->store($request, $dest);
|
||||
$client->store($request, $dest);
|
||||
```
|
||||
|
||||
@@ -66,5 +66,5 @@ $markdowns = [
|
||||
];
|
||||
$request = new MarkdownRequest($index, $markdowns);
|
||||
$dest = "result.pdf";
|
||||
$filename = $client->store($request, $dest);
|
||||
$client->store($request, $dest);
|
||||
```
|
||||
|
||||
@@ -12,6 +12,7 @@ You may send one or more Office documents. Following file extensions are accepte
|
||||
|
||||
* `.txt`
|
||||
* `.rtf`
|
||||
* `.fodt`
|
||||
* `.doc`
|
||||
* `.docx`
|
||||
* `.odt`
|
||||
@@ -66,7 +67,7 @@ $files = [
|
||||
];
|
||||
$request = new OfficeRequest($files);
|
||||
$dest = "result.pdf";
|
||||
$filename = $client->store($request, $dest);
|
||||
$client->store($request, $dest);
|
||||
```
|
||||
|
||||
## Orientation
|
||||
@@ -114,5 +115,5 @@ $files = [
|
||||
$request = new OfficeRequest($files);
|
||||
$request->setLandscape(true);
|
||||
$dest = "result.pdf";
|
||||
$filename = $client->store($request, $dest);
|
||||
$client->store($request, $dest);
|
||||
```
|
||||
|
||||
@@ -49,5 +49,5 @@ $files = [
|
||||
];
|
||||
$request = new MergeRequest($files);
|
||||
$dest = "result.pdf";
|
||||
$filename = $client->store($request, $dest);
|
||||
$client->store($request, $dest);
|
||||
```
|
||||
@@ -363,6 +363,9 @@ are on the same level as the <code>index.html</code> file.</p>
|
||||
<blockquote>
|
||||
<p>If you want to install fonts directly in the Gotenberg Docker image,
|
||||
see to the <a href="#fonts">fonts section</a>.</p>
|
||||
|
||||
<p>For web fonts (Google fonts), there is a timeout of 500ms by default. You may update
|
||||
this value thanks to the form field <code>webFontsTimeout</code>.</p>
|
||||
</blockquote>
|
||||
|
||||
<h3 class="Heading"><a class="Anchor" aria-hidden="true" id="html.assets.c_url" href="#html.assets.c_url">
|
||||
@@ -545,7 +548,7 @@ $client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\
|
||||
$request = new URLRequest('https://google.com');
|
||||
$request->setMargins(Request::NO_MARGINS);
|
||||
$dest = "result.pdf";
|
||||
$filename = $client->store($request, $dest);
|
||||
$client->store($request, $dest);
|
||||
</pre>
|
||||
|
||||
</div>
|
||||
@@ -622,7 +625,7 @@ $markdowns = [
|
||||
];
|
||||
$request = new MarkdownRequest($index, $markdowns);
|
||||
$dest = "result.pdf";
|
||||
$filename = $client->store($request, $dest);
|
||||
$client->store($request, $dest);
|
||||
</pre>
|
||||
|
||||
</div>
|
||||
@@ -644,6 +647,7 @@ $filename = $client->store($request, $dest);
|
||||
<ul>
|
||||
<li><code>.txt</code></li>
|
||||
<li><code>.rtf</code></li>
|
||||
<li><code>.fodt</code></li>
|
||||
<li><code>.doc</code></li>
|
||||
<li><code>.docx</code></li>
|
||||
<li><code>.odt</code></li>
|
||||
@@ -704,7 +708,7 @@ $files = [
|
||||
];
|
||||
$request = new OfficeRequest($files);
|
||||
$dest = "result.pdf";
|
||||
$filename = $client->store($request, $dest);
|
||||
$client->store($request, $dest);
|
||||
</pre>
|
||||
|
||||
<h2 class="Heading"><a class="Anchor" aria-hidden="true" id="office.orientation" href="#office.orientation">
|
||||
@@ -757,7 +761,7 @@ $files = [
|
||||
$request = new OfficeRequest($files);
|
||||
$request->setLandscape(true);
|
||||
$dest = "result.pdf";
|
||||
$filename = $client->store($request, $dest);
|
||||
$client->store($request, $dest);
|
||||
</pre>
|
||||
|
||||
</div>
|
||||
@@ -818,7 +822,7 @@ $files = [
|
||||
];
|
||||
$request = new MergeRequest($files);
|
||||
$dest = "result.pdf";
|
||||
$filename = $client->store($request, $dest);
|
||||
$client->store($request, $dest);
|
||||
</pre>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -47,5 +47,10 @@ func convertHTML(c echo.Context) error {
|
||||
return hijackErr(err, r)
|
||||
}
|
||||
p.Landscape = landscape
|
||||
chromeWebFontsTimeout, err := r.webFontsTimeout()
|
||||
if err != nil {
|
||||
return hijackErr(err, r)
|
||||
}
|
||||
p.WebFontsTimeout = chromeWebFontsTimeout
|
||||
return print(c, p, r)
|
||||
}
|
||||
|
||||
@@ -46,5 +46,10 @@ func convertMarkdown(c echo.Context) error {
|
||||
return hijackErr(err, r)
|
||||
}
|
||||
p.Landscape = landscape
|
||||
chromeWebFontsTimeout, err := r.webFontsTimeout()
|
||||
if err != nil {
|
||||
return hijackErr(err, r)
|
||||
}
|
||||
p.WebFontsTimeout = chromeWebFontsTimeout
|
||||
return print(c, p, r)
|
||||
}
|
||||
|
||||
@@ -10,6 +10,7 @@ import (
|
||||
var officeExts = []string{
|
||||
".txt",
|
||||
".rtf",
|
||||
".fodt",
|
||||
".doc",
|
||||
".docx",
|
||||
".odt",
|
||||
|
||||
@@ -13,15 +13,16 @@ import (
|
||||
)
|
||||
|
||||
const (
|
||||
remoteURL string = "remoteURL"
|
||||
webhookURL string = "webhookURL"
|
||||
paperWidth string = "paperWidth"
|
||||
paperHeight string = "paperHeight"
|
||||
marginTop string = "marginTop"
|
||||
marginBottom string = "marginBottom"
|
||||
marginLeft string = "marginLeft"
|
||||
marginRight string = "marginRight"
|
||||
landscape string = "landscape"
|
||||
remoteURL string = "remoteURL"
|
||||
webhookURL string = "webhookURL"
|
||||
paperWidth string = "paperWidth"
|
||||
paperHeight string = "paperHeight"
|
||||
marginTop string = "marginTop"
|
||||
marginBottom string = "marginBottom"
|
||||
marginLeft string = "marginLeft"
|
||||
marginRight string = "marginRight"
|
||||
landscape string = "landscape"
|
||||
webFontsTimeout string = "webFontsTimeout"
|
||||
)
|
||||
|
||||
// resource facilitates storing and accessing
|
||||
@@ -42,6 +43,7 @@ func newResource(c echo.Context) (*resource, error) {
|
||||
v[marginLeft] = c.FormValue(marginLeft)
|
||||
v[marginRight] = c.FormValue(marginRight)
|
||||
v[landscape] = c.FormValue(landscape)
|
||||
v[webFontsTimeout] = c.FormValue(webFontsTimeout)
|
||||
dirPath, err := rand.Get()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
@@ -190,5 +192,17 @@ func (r *resource) remoteURL() (string, error) {
|
||||
return r.values[remoteURL], nil
|
||||
}
|
||||
|
||||
func (r *resource) webFontsTimeout() (int64, error) {
|
||||
webFontsTimeoutStr := r.values[webFontsTimeout]
|
||||
if webFontsTimeoutStr == "" {
|
||||
return 500, nil
|
||||
}
|
||||
timeout, err := strconv.ParseInt(webFontsTimeoutStr, 10, 64)
|
||||
if err != nil {
|
||||
return 500, fmt.Errorf("web fonts timeout: %v", err)
|
||||
}
|
||||
return timeout, nil
|
||||
}
|
||||
|
||||
func (r *resource) webhookURL() string { return r.values[webhookURL] }
|
||||
func (r *resource) removeAll() error { return os.RemoveAll(r.dirPath) }
|
||||
|
||||
@@ -47,5 +47,10 @@ func convertURL(c echo.Context) error {
|
||||
return hijackErr(err, r)
|
||||
}
|
||||
p.Landscape = landscape
|
||||
chromeWebFontsTimeout, err := r.webFontsTimeout()
|
||||
if err != nil {
|
||||
return hijackErr(err, r)
|
||||
}
|
||||
p.WebFontsTimeout = chromeWebFontsTimeout
|
||||
return print(c, p, r)
|
||||
}
|
||||
|
||||
@@ -18,17 +18,18 @@ import (
|
||||
|
||||
// HTML facilitates HTML to PDF conversion.
|
||||
type HTML struct {
|
||||
Context context.Context
|
||||
URL string
|
||||
HeaderHTML string
|
||||
FooterHTML string
|
||||
PaperWidth float64
|
||||
PaperHeight float64
|
||||
MarginTop float64
|
||||
MarginBottom float64
|
||||
MarginLeft float64
|
||||
MarginRight float64
|
||||
Landscape bool
|
||||
Context context.Context
|
||||
URL string
|
||||
HeaderHTML string
|
||||
FooterHTML string
|
||||
PaperWidth float64
|
||||
PaperHeight float64
|
||||
MarginTop float64
|
||||
MarginBottom float64
|
||||
MarginLeft float64
|
||||
MarginRight float64
|
||||
Landscape bool
|
||||
WebFontsTimeout int64
|
||||
}
|
||||
|
||||
const defaultHeaderFooterHTML string = "<html><head></head><body></body></html>"
|
||||
@@ -103,14 +104,17 @@ func (html *HTML) Print(destination string) error {
|
||||
return fmt.Errorf("waiting for page loading: %v", err)
|
||||
}
|
||||
// inject a script to make sure web fonts are loaded.
|
||||
script := `new Promise((resolve, reject) => {
|
||||
script := fmt.Sprintf(`new Promise((resolve, reject) => {
|
||||
document.fonts.ready.then(function () {
|
||||
resolve('fonts loaded');
|
||||
});
|
||||
setTimeout(resolve.bind(resolve, 'timeout'), %.0f);
|
||||
});`
|
||||
setTimeout(resolve.bind(resolve, 'timeout'), %d);
|
||||
});`, html.WebFontsTimeout)
|
||||
scriptArg := runtime.NewEvaluateArgs(script).SetAwaitPromise(true)
|
||||
returnObj, _ := c.Runtime.Evaluate(html.Context, scriptArg)
|
||||
if returnObj.ExceptionDetails != nil {
|
||||
return fmt.Errorf("script evaluated with exception: %+v", returnObj.ExceptionDetails)
|
||||
}
|
||||
loadFontsResult := string(returnObj.Result.Value)
|
||||
if strings.Contains(loadFontsResult, "timeout") {
|
||||
return errors.New("timed out loading fonts")
|
||||
|
||||
@@ -15,17 +15,18 @@ import (
|
||||
|
||||
// Markdown facilitates Markdown to PDF conversion.
|
||||
type Markdown struct {
|
||||
Context context.Context
|
||||
TemplatePath string
|
||||
HeaderHTML string
|
||||
FooterHTML string
|
||||
PaperWidth float64
|
||||
PaperHeight float64
|
||||
MarginTop float64
|
||||
MarginBottom float64
|
||||
MarginLeft float64
|
||||
MarginRight float64
|
||||
Landscape bool
|
||||
Context context.Context
|
||||
TemplatePath string
|
||||
HeaderHTML string
|
||||
FooterHTML string
|
||||
PaperWidth float64
|
||||
PaperHeight float64
|
||||
MarginTop float64
|
||||
MarginBottom float64
|
||||
MarginLeft float64
|
||||
MarginRight float64
|
||||
Landscape bool
|
||||
WebFontsTimeout int64
|
||||
|
||||
html *HTML
|
||||
}
|
||||
@@ -52,6 +53,7 @@ func (md *Markdown) Print(destination string) error {
|
||||
md.html.MarginLeft = md.MarginLeft
|
||||
md.html.MarginRight = md.MarginRight
|
||||
md.html.Landscape = md.Landscape
|
||||
md.html.WebFontsTimeout = md.WebFontsTimeout
|
||||
tmpl, err := template.
|
||||
New(filepath.Base(md.TemplatePath)).
|
||||
Funcs(template.FuncMap{"toHTML": toHTML}).
|
||||
|
||||
@@ -13,15 +13,16 @@ import (
|
||||
)
|
||||
|
||||
const (
|
||||
remoteURL string = "remoteURL"
|
||||
webhookURL string = "webhookURL"
|
||||
paperWidth string = "paperWidth"
|
||||
paperHeight string = "paperHeight"
|
||||
marginTop string = "marginTop"
|
||||
marginBottom string = "marginBottom"
|
||||
marginLeft string = "marginLeft"
|
||||
marginRight string = "marginRight"
|
||||
landscape string = "landscape"
|
||||
remoteURL string = "remoteURL"
|
||||
webhookURL string = "webhookURL"
|
||||
paperWidth string = "paperWidth"
|
||||
paperHeight string = "paperHeight"
|
||||
marginTop string = "marginTop"
|
||||
marginBottom string = "marginBottom"
|
||||
marginLeft string = "marginLeft"
|
||||
marginRight string = "marginRight"
|
||||
landscape string = "landscape"
|
||||
webFontsTimeout string = "webFontsTimeout"
|
||||
)
|
||||
|
||||
var (
|
||||
@@ -75,6 +76,7 @@ type ChromeRequest interface {
|
||||
SetPaperSize(size [2]float64)
|
||||
SetMargins(margins [4]float64)
|
||||
SetLandscape(isLandscape bool)
|
||||
SetWebFontsTimeout(timeout int64)
|
||||
}
|
||||
|
||||
// UnoconvRequest is a type for sending
|
||||
|
||||
@@ -78,6 +78,11 @@ func (html *HTMLRequest) SetLandscape(isLandscape bool) {
|
||||
html.values[landscape] = strconv.FormatBool(isLandscape)
|
||||
}
|
||||
|
||||
// SetWebFontsTimeout sets webFontsTimeout form field.
|
||||
func (html *HTMLRequest) SetWebFontsTimeout(timeout int64) {
|
||||
html.values[webFontsTimeout] = strconv.FormatInt(timeout, 10)
|
||||
}
|
||||
|
||||
func (html *HTMLRequest) getPostURL() string {
|
||||
return "/convert/html"
|
||||
}
|
||||
|
||||
@@ -88,6 +88,11 @@ func (markdown *MarkdownRequest) SetLandscape(isLandscape bool) {
|
||||
markdown.values[landscape] = strconv.FormatBool(isLandscape)
|
||||
}
|
||||
|
||||
// SetWebFontsTimeout sets webFontsTimeout form field.
|
||||
func (markdown *MarkdownRequest) SetWebFontsTimeout(timeout int64) {
|
||||
markdown.values[webFontsTimeout] = strconv.FormatInt(timeout, 10)
|
||||
}
|
||||
|
||||
func (markdown *MarkdownRequest) getPostURL() string {
|
||||
return "/convert/markdown"
|
||||
}
|
||||
|
||||
@@ -63,6 +63,11 @@ func (url *URLRequest) SetLandscape(isLandscape bool) {
|
||||
url.values[landscape] = strconv.FormatBool(isLandscape)
|
||||
}
|
||||
|
||||
// SetWebFontsTimeout sets webFontsTimeout form field.
|
||||
func (url *URLRequest) SetWebFontsTimeout(timeout int64) {
|
||||
url.values[webFontsTimeout] = strconv.FormatInt(timeout, 10)
|
||||
}
|
||||
|
||||
func (url *URLRequest) getPostURL() string {
|
||||
return "/convert/url"
|
||||
}
|
||||
|
||||
@@ -21,11 +21,13 @@ docker build -t thecodingmachine/gotenberg:base -f build/base/Dockerfile .
|
||||
docker build \
|
||||
--build-arg GOLANG_VERSION=${GOLANG_VERSION} \
|
||||
--build-arg VERSION=${VERSION} \
|
||||
-t thecodingmachine/gotenberg:latest \
|
||||
-t thecodingmachine/gotenberg:${SEMVER[0]} \
|
||||
-t thecodingmachine/gotenberg:${SEMVER[0]}.${SEMVER[1]} \
|
||||
-t thecodingmachine/gotenberg:${SEMVER[0]}.${SEMVER[1]}.${SEMVER[2]} \
|
||||
-f build/package/Dockerfile .
|
||||
|
||||
docker push "thecodingmachine/gotenberg:latest"
|
||||
docker push "thecodingmachine/gotenberg:${SEMVER[0]}"
|
||||
docker push "thecodingmachine/gotenberg:${SEMVER[0]}.${SEMVER[1]}"
|
||||
docker push "thecodingmachine/gotenberg:${SEMVER[0]}.${SEMVER[1]}.${SEMVER[2]}"
|
||||
Reference in New Issue
Block a user