fixing publish command (for good this time)

6.0.0

.blueprints/Dockerfile.blueprint

@@ -1,64 +0,0 @@
-FROM {{ if eq "CI" .Orbit.Image }}golang:1.10-stretch{{ else }}debian:stretch-slim{{ end }}
-
-LABEL authors="Julien Neuhart <j.neuhart@thecodingmachine.com>"
-
-# |--------------------------------------------------------------------------
-# | Libraries
-# |--------------------------------------------------------------------------
-# |
-# | Installs all required libraries.
-# |
-
-RUN echo "deb http://httpredir.debian.org/debian/ stretch main contrib non-free" > /etc/apt/sources.list &&\
-    apt-get update &&\
-    apt-get install -y xvfb wkhtmltopdf pdftk unoconv ttf-mscorefonts-installer &&\
-    ln -s /usr/bin/xvfb-run /usr/local/bin/xvfb-run &&\
-    ln -s /usr/bin/wkhtmltopdf /usr/local/bin/wkhtmltopdf &&\
-    ln -s /usr/bin/pdftk /usr/local/bin/pdftk &&\
-    ln -s /usr/bin/unoconv /usr/local/bin/unoconv
-
-RUN apt-get install -y curl gnupg &&\
-    curl -sL https://deb.nodesource.com/setup_8.x | bash - &&\
-    apt-get update &&\
-    apt-get install -y nodejs
-
-RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - &&\
-    echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list &&\
-    apt-get update &&\
-    apt-get install -y yarn bzip2 &&\
-    yarn global add markdown-pdf --prefix /usr/local
-
-# |--------------------------------------------------------------------------
-# | Gotenberg
-# |--------------------------------------------------------------------------
-# |
-# | All Gotenberg related stuff.
-# |
-
-{{- if eq "CI" .Orbit.Image }}
-
-WORKDIR /go/src/github.com/thecodingmachine/gotenberg
-
-# Installs lint dependencies.
-RUN go get -u gopkg.in/alecthomas/gometalinter.v2 &&\
-    gometalinter.v2 --install
-
-# Copies our Go source.
-COPY . .
-
-# Installs project dependencies.
-RUN go get -d -v ./...
-
-ENTRYPOINT [".ci/docker-entrypoint.sh"]
-{{- else }}
-
-COPY .ci/gotenberg /usr/bin/gotenberg
-RUN ln -s /usr/bin/gotenberg /usr/local/bin/gotenberg
-
-COPY .ci/gotenberg.yml /gotenberg/gotenberg.yml
-
-WORKDIR /gotenberg
-
-EXPOSE 3000
-CMD ["gotenberg"]
-{{- end }}

.ci/docker-entrypoint.sh

@@ -1,33 +0,0 @@
-#!/bin/bash
-
-set -xe
-
-# Statically checking Go source for errors and warnings.
-gometalinter.v2 --disable-all -E vet -E gofmt -E misspell -E ineffassign -E goimports -E deadcode -E gocyclo --vendor ./...;
-
-# Running tests according to current Gotenberg version.
-if [[ "$VERSION" == "snapshot" ]]; then
-    for d in $(go list ./... | grep -v vendor); do
-        go test -race -cover -covermode=atomic $d;
-    done
-else
-    echo "" > .ci/coverage.txt;
-    for d in $(go list ./... | grep -v vendor); do
-        go test -race -coverprofile=profile.out -covermode=atomic $d;
-        if [ -f profile.out ]; then
-            cat profile.out >> .ci/coverage.txt;
-            rm profile.out;
-        fi
-    done
-fi
-
-
-# Builds the Linux binary.
-if [ -f .ci/gotenberg ]; then
-    rm .ci/gotenberg
-fi
-
-env GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -ldflags "-X main.version=${VERSION}" && mv gotenberg .ci/;
-
-# Bye!
-exit 0;

.ci/gotenberg.yml

@@ -1,60 +0,0 @@
-# The port the application will listen to.
-port: 3000
-
-logs:
-  # Accepted values, in order of severity: DEBUG, INFO, WARN, ERROR, FATAL, PANIC.
-  # Messages at and above the selected level will be logged.
-  level: "INFO"
-
-  # Accepted values: text, json.
-  # When a TTY is not attached, the output will be in the defined format.
-  formatter: "text"
-
-# You don't like a library which is used for a conversion? You want to handle a new file type?
-# You may provide here your own implementation!
-commands:
-
-  # Some libraries like unoconv cannot perform concurrent conversions. That's why the API does only one conversion at a time.
-  # If your current implementation uses libraries which are able to perform concurrent conversions, you may
-  # change this value to false.
-  lock: true
-
-  # Unlike others commands' templates, you have access to FilesPaths instead of FilePath: it gathers all PDF files which should be merged.
-  merge:
-    template: "pdftk {{ range $filePath := .FilesPaths }} {{ $filePath }} {{ end }} cat output {{ .ResultFilePath }}"
-    interpreter: "/bin/sh -c"
-    timeout: 30
-  
-  # You may add more commands (or less, or even none).
-  conversions:
-
-      # The command template: you have access to FilePath and ResultFilePath variables.
-    - template: "markdown-pdf {{ .FilePath }} -o {{ .ResultFilePath }}"
-      # The binary which will call the command.
-      interpreter: "/bin/sh -c"
-      # Duration in seconds after which the command will be killed if it has not finished.
-      timeout: 30
-      # Files with the following extensions will be converted by the current command.
-      extensions:
-        - ".md"
-
-    - template: "xvfb-run -e /dev/stdout wkhtmltopdf {{ .FilePath }} {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".html"
-        - ".htm"
-
-    - template: "unoconv --format pdf --output \"{{ .ResultFilePath }}\" \"{{ .FilePath }}\""
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".doc"
-        - ".docx"
-        - ".odt"
-        - ".xls"
-        - ".xlsx"
-        - ".ods"
-        - ".ppt"
-        - ".pptx"
-        - ".odp"

.github/CODE_OF_CONDUCT.md

@@ -43,4 +43,4 @@ Project maintainers who do not follow or enforce the Code of Conduct in good fai
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+[version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

@@ -1,15 +1,16 @@
 # Contributing
 
-Hi! Thank your for considering contributing to Gotenberg. You'll
+Hi! Thank you for considering contributing to Gotenberg. You'll
 find below useful information about how to contribute to the Gotenberg project.
 
 ## Contributing code
 
 ### Install from sources
 
-1. Fork this repository
-2. Clone it to your local Go environment (requires *Go* >= 1.10)
-3. Install the latest [Orbit](https://github.com/gulien/orbit) release
+1. Install and run the latest version of Docker
+2. Verify your Go version (>= 1.13)
+3. Fork this repository
+4. Clone it outside of your `GOPATH` (we're using Go modules)
 
 ### Working with git
 
@@ -18,6 +19,11 @@ find below useful information about how to contribute to the Gotenberg project.
 3. Push to the branch (`git push origin my-new-feature`)
 4. Create a new pull request
 
+### Testing
+
+1. Run all linters (`make lint`)
+2. Run all tests (`make tests`)
+
 ## Reporting bugs and feature request
 
 Your issue or feature request may already be reported!
@@ -30,4 +36,4 @@ add a new one!
 
 * [Code of conduct](CODE_OF_CONDUCT.md)
 * [Issue template](ISSUE_TEMPLATE.md)
-* [Pull request template](PULL_REQUEST_TEMPLATE.md)
+* [Pull request template](PULL_REQUEST_TEMPLATE.md)

.github/ISSUE_TEMPLATE.md

@@ -21,6 +21,9 @@ Please search on the [issue tracker](../../../issues) before creating one.
 3.
 4.
 
+## Logs (LOG_LEVEL="DEBUG")
+<!--- Include here a relevant snippet of the log entries of your Gotenberg instance -->
+
 ## Context
 <!--- How has this issue affected you? What are you trying to accomplish? -->
 <!--- Providing context helps us come up with a solution that is most useful in the real world -->
@@ -29,4 +32,4 @@ Please search on the [issue tracker](../../../issues) before creating one.
 <!--- Include as many relevant details about the environment you experienced the bug in -->
 * Version used:
 * Operating System and version:
-* Link to your project:
+* Link to your project:

.github/PULL_REQUEST_TEMPLATE.md

@@ -27,7 +27,7 @@ Explain the **motivation** for making this change. What existing problem does th
 
 Demonstrate the code is solid. Example: The exact commands you ran and their output.
 
-<!-- Make sure tests pass on both Travis and AppVeyor. -->
+<!-- Make sure tests pass on Travis. -->
 
 **Closing issues**
 
@@ -37,8 +37,9 @@ Fixes #
 **Checklist**
 
 - [ ] Have you followed the guidelines in our [CONTRIBUTING](CONTRIBUTING.md) guide?
-- [ ] Have you lint your code locally prior to submission (`orbit run fmt`)?
+- [ ] Have you lint your code locally prior to submission (`make lint`)?
 - [ ] Have you written new tests for your core changes, as applicable?
-- [ ] Have you successfully ran tests with your changes locally (`orbit run ci`)?
+- [ ] Have you successfully ran tests with your changes locally (`make tests`)?
+- [ ] Have you updated the documentation (`make doc`)?
 - [ ] I have squashed any insignificant commits
-- [ ] This change has comments for package types, values, functions, and non-obvious lines of code
+- [ ] This change has comments for package types, values, functions, and non-obvious lines of code

.github/workflows/publish.yml

@@ -0,0 +1,14 @@
+name: Publish
+on: 
+  push:
+    branches:
+      - releases/*
+
+jobs:
+  publish:
+    name: Publish to Docker Hub
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v1
+      - run: echo $GITHUB_REF
+      #- run: make publish VERSION=$GITHUB_REF DOCKER_USER=${{ secrets.DOCKER_USER }} DOCKER_PASSWORD=${{ secrets.DOCKER_PASSWORD }}

.github/workflows/push.yml

@@ -0,0 +1,12 @@
+name: Push
+on: push
+
+jobs:
+  tests:
+    name: Lint, tests and code coverage
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v1
+      #- run: make lint
+      #- run: make tests CODE_COVERAGE=1
+      #- run: bash <(curl -s https://codecov.io/bash) -t ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -1,2 +1,2 @@
-.ci/coverage.txt
-.ci/gotenberg
+.idea
+coverage.txt

.goreleaser.yml

@@ -1,28 +0,0 @@
----
-project_name: Gotenberg
-builds:
-  - main: ./main.go
-    binary: gotenberg
-    env:
-     - CGO_ENABLED=0
-    goos:
-      - linux
-      - darwin
-      - windows
-    goarch:
-      - 386
-      - amd64
-      - arm
-      - arm64
-archive:
-  name_template: '{{ .Binary }}_{{ .Os }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}'
-  replacements:
-    darwin: Darwin
-    linux: Linux
-    windows: Windows
-    386: i386
-    amd64: x86_64
-  format: tar.gz
-  format_overrides:
-    - goos: windows
-      format: zip

.travis.yml

@@ -10,14 +10,17 @@ env:
   - secure: d6pliM7iR7KJ3TQkr1C0tHi0HgU6Vdmc/ycw11XrXs794/dgj6g9UDrhgcvT2mTzOVIUNouHx7gyEWAlwJv7p8PPyguHJfIsyqMWfaXNPoytTx1ETUiygl1G/UsvXVdry6I5tZF/U+/PJ3hBXoAvo8EOFe0/MxxvP3ghCeeCpeEwEdoYP2jbADGffywVUNI7OEdmS29A28GusXXp2cWCIZYSq5Gn5iu1ZMPaJA6SkRTXpS+iVVLUvlbz5HW09ETFfurTvsdz5Ze4JICiuQt///CR1uwdxD8K7Ils/mkenaMtja9NHA9RdQBa51Azn8iCLsObCTYc52Zb6atbCi/X4ae9M8GA8qaaLigNz5G4v1BHneJylYfWKj5GwqUA3VmRu1mlEw7d2sN2uFRmgIl5kgsYYyOVOLBOKaJWhyBhNnR4U8KeqwUkOnlSdmNZnjfexXXBEcKHen1SozpXwMnzZh8LZuN6BNYd6TVpKmjulGI3vqNMM0c4JJZ9pSm4q5FjbNGQArwCsujDDwY4bCGZSJJTPMXjYOrx4yJ1RY+0TpyV9oDU3ogEqaWnhrkgrphfiYBlDY2bEvrxMTMukLCxJb0Nru6LGCpg4X1P9hu9r0gceqUSnBgdJI4rYTNddenxlEd4j/Thqv835stJWz6YoV+rfvERuSUpntl8xvrk3U8=
   - secure: CmLh169xwt3OC7l19lDUwdZYfw+l/+XXKjTGxnuJiXHa9hAH+nc4mEUSmqHMHwjquyYE6LnSVGZ94LH8sCaGed/TMm0Lj3DZtZ0VsjYu3sKsNrVJn5WdYEah+GvNJ8i8uzvHnGk1L2fAagLpXFUB2K9UraA1CFiHs1fF5Fua7Ra0mE7lMz0MFvyvzcmc9u8nMz71K2YVsXqn+I/rv8onJCTtc/Ds0hVrBXwG5Fh0T3xHqjOhME9ZI2hRHnnQVdBojSY3USifQ//qAKowfBVc0pebEtgFpyXx/I17A6xCm0KVtnA2tNqu1+XFkjWaBzryaLE9ujhJcTRC/YK0JUZ+QxfYbD5C7jVy9Jlx1lOEjJ42B/ImNxPP+9p3wi2MWNbcbZJPxIe635fnT17lI7CLK2Qg1xjfTQ4WTEKW5IhnYMiyfRKiripFh4PCkDm8cJlTbpntsX1n0uheydbsgf/11vS7o1WGhVQ8+Jelc4DvIbBHCqienQEOLJDBwm7FiK5JbwZJ6ZAGeDM/IhGU1h9PNjVbHUyJhUxYoPYUE9QsZFT7ENCrRQpq49KOzXBRfffyJNJRh+Ep9X5YoW0dUp0MNu5B7z2+6w9X9n/C+loa11xF42bFzniCvvbSOQ37J+EngDinVxJkNPeyivR4fye2ENhIAjAEjouTJLOSXL9nAOU=
 
-before_install:
-  - wget -qO- https://github.com/gulien/orbit/releases/download/v3.0.0/orbit_Linux_x86_64.tar.gz | tar xvz -C .
-  - sudo mv ./orbit /usr/local/bin && chmod +x /usr/local/bin/orbit
+stages:
+  - tests
+  - publish
 
-script:
-  - orbit run ci -p "Version,${TRAVIS_BRANCH}"
-  - orbit run build -p "Version,${TRAVIS_BRANCH}"
-  # Uploads coverage.
-  - bash <(curl -s https://codecov.io/bash)
-  # Let's push to Docker hub only if not in a pull request and the branch name matches the semver format.
-  - if [[ "$TRAVIS_PULL_REQUEST" = false && "$TRAVIS_BRANCH" =~ ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*)?(\+[0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*)?$ ]]; then docker login -u $DOCKER_USER -p $DOCKER_PASS && docker push thecodingmachine/gotenberg:${TRAVIS_BRANCH}; fi
+jobs:
+  include:
+    - stage: tests
+      script: 
+        - make lint
+        - make tests CODE_COVERAGE=1
+        - bash <(curl -s https://codecov.io/bash)
+    - stage: publish
+      if: tag IS present
+      script: make publish VERSION=$TRAVIS_TAG DOCKER_USER=$DOCKER_USER DOCKER_PASSWORD=$DOCKER_PASS

Dockerfile

@@ -1,46 +0,0 @@
-FROM debian:stretch-slim
-
-LABEL authors="Julien Neuhart <j.neuhart@thecodingmachine.com>"
-
-# |--------------------------------------------------------------------------
-# | Libraries
-# |--------------------------------------------------------------------------
-# |
-# | Installs all required libraries.
-# |
-
-RUN echo "deb http://httpredir.debian.org/debian/ stretch main contrib non-free" > /etc/apt/sources.list &&\
-    apt-get update &&\
-    apt-get install -y xvfb wkhtmltopdf pdftk unoconv ttf-mscorefonts-installer &&\
-    ln -s /usr/bin/xvfb-run /usr/local/bin/xvfb-run &&\
-    ln -s /usr/bin/wkhtmltopdf /usr/local/bin/wkhtmltopdf &&\
-    ln -s /usr/bin/pdftk /usr/local/bin/pdftk &&\
-    ln -s /usr/bin/unoconv /usr/local/bin/unoconv
-
-RUN apt-get install -y curl gnupg &&\
-    curl -sL https://deb.nodesource.com/setup_8.x | bash - &&\
-    apt-get update &&\
-    apt-get install -y nodejs
-
-RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - &&\
-    echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list &&\
-    apt-get update &&\
-    apt-get install -y yarn bzip2 &&\
-    yarn global add markdown-pdf --prefix /usr/local
-
-# |--------------------------------------------------------------------------
-# | Gotenberg
-# |--------------------------------------------------------------------------
-# |
-# | All Gotenberg related stuff.
-# |
-
-COPY .ci/gotenberg /usr/bin/gotenberg
-RUN ln -s /usr/bin/gotenberg /usr/local/bin/gotenberg
-
-COPY .ci/gotenberg.yml /gotenberg/gotenberg.yml
-
-WORKDIR /gotenberg
-
-EXPOSE 3000
-CMD ["gotenberg"]

Dockerfile.ci

@@ -1,50 +0,0 @@
-FROM golang:1.10-stretch
-
-LABEL authors="Julien Neuhart <j.neuhart@thecodingmachine.com>"
-
-# |--------------------------------------------------------------------------
-# | Libraries
-# |--------------------------------------------------------------------------
-# |
-# | Installs all required libraries.
-# |
-
-RUN echo "deb http://httpredir.debian.org/debian/ stretch main contrib non-free" > /etc/apt/sources.list &&\
-    apt-get update &&\
-    apt-get install -y xvfb wkhtmltopdf pdftk unoconv ttf-mscorefonts-installer &&\
-    ln -s /usr/bin/xvfb-run /usr/local/bin/xvfb-run &&\
-    ln -s /usr/bin/wkhtmltopdf /usr/local/bin/wkhtmltopdf &&\
-    ln -s /usr/bin/pdftk /usr/local/bin/pdftk &&\
-    ln -s /usr/bin/unoconv /usr/local/bin/unoconv
-
-RUN apt-get install -y curl gnupg &&\
-    curl -sL https://deb.nodesource.com/setup_8.x | bash - &&\
-    apt-get update &&\
-    apt-get install -y nodejs
-
-RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - &&\
-    echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list &&\
-    apt-get update &&\
-    apt-get install -y yarn bzip2 &&\
-    yarn global add markdown-pdf --prefix /usr/local
-
-# |--------------------------------------------------------------------------
-# | Gotenberg
-# |--------------------------------------------------------------------------
-# |
-# | All Gotenberg related stuff.
-# |
-
-WORKDIR /go/src/github.com/thecodingmachine/gotenberg
-
-# Installs lint dependencies.
-RUN go get -u gopkg.in/alecthomas/gometalinter.v2 &&\
-    gometalinter.v2 --install
-
-# Copies our Go source.
-COPY . .
-
-# Installs project dependencies.
-RUN go get -d -v ./...
-
-ENTRYPOINT [".ci/docker-entrypoint.sh"]

Gopkg.lock

@@ -1,66 +0,0 @@
-# This file is autogenerated, do not edit; changes may be undone by the next 'dep ensure'.
-
-
-[[projects]]
-  branch = "master"
-  name = "github.com/dustin/go-humanize"
-  packages = ["."]
-  revision = "02af3965c54e8cacf948b97fef38925c4120652c"
-
-[[projects]]
-  name = "github.com/gorilla/context"
-  packages = ["."]
-  revision = "1ea25387ff6f684839d82767c1733ff4d4d15d0a"
-  version = "v1.1"
-
-[[projects]]
-  name = "github.com/gorilla/mux"
-  packages = ["."]
-  revision = "53c1911da2b537f792e7cafcb446b05ffe33b996"
-  version = "v1.6.1"
-
-[[projects]]
-  branch = "master"
-  name = "github.com/justinas/alice"
-  packages = ["."]
-  revision = "03f45bd4b7dad4734bc4620e46a35789349abb20"
-
-[[projects]]
-  name = "github.com/satori/go.uuid"
-  packages = ["."]
-  revision = "f58768cc1a7a7e77a3bd49e98cdd21419399b6a3"
-  version = "v1.2.0"
-
-[[projects]]
-  name = "github.com/sirupsen/logrus"
-  packages = ["."]
-  revision = "c155da19408a8799da419ed3eeb0cb5db0ad5dbc"
-  version = "v1.0.5"
-
-[[projects]]
-  branch = "master"
-  name = "golang.org/x/crypto"
-  packages = ["ssh/terminal"]
-  revision = "88942b9c40a4c9d203b82b3731787b672d6e809b"
-
-[[projects]]
-  branch = "master"
-  name = "golang.org/x/sys"
-  packages = [
-    "unix",
-    "windows"
-  ]
-  revision = "13d03a9a82fba647c21a0ef8fba44a795d0f0835"
-
-[[projects]]
-  name = "gopkg.in/yaml.v2"
-  packages = ["."]
-  revision = "86f5ed62f8a0ee96bd888d2efdfd6d4fb100a4eb"
-  version = "v2.2.0"
-
-[solve-meta]
-  analyzer-name = "dep"
-  analyzer-version = 1
-  inputs-digest = "97e0dbb20631792bc25ad19e6a85a90a9d24bb03f773cd36dee11eebae152091"
-  solver-name = "gps-cdcl"
-  solver-version = 1

Gopkg.toml

@@ -1,54 +0,0 @@
-# Gopkg.toml example
-#
-# Refer to https://github.com/golang/dep/blob/master/docs/Gopkg.toml.md
-# for detailed Gopkg.toml documentation.
-#
-# required = ["github.com/user/thing/cmd/thing"]
-# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"]
-#
-# [[constraint]]
-#   name = "github.com/user/project"
-#   version = "1.0.0"
-#
-# [[constraint]]
-#   name = "github.com/user/project2"
-#   branch = "dev"
-#   source = "github.com/myfork/project2"
-#
-# [[override]]
-#   name = "github.com/x/y"
-#   version = "2.4.0"
-#
-# [prune]
-#   non-go = false
-#   go-tests = true
-#   unused-packages = true
-
-
-[prune]
-  go-tests = true
-  unused-packages = true
-
-[[constraint]]
-  name = "github.com/satori/go.uuid"
-  version = "1.2.0"
-
-[[constraint]]
-  name = "github.com/gorilla/mux"
-  version = "1.6.1"
-
-[[constraint]]
-  branch = "master"
-  name = "github.com/justinas/alice"
-
-[[constraint]]
-  name = "gopkg.in/yaml.v2"
-  version = "2.2.0"
-
-[[constraint]]
-  name = "github.com/sirupsen/logrus"
-  version = "1.0.5"
-
-[[constraint]]
-  branch = "master"
-  name = "github.com/dustin/go-humanize"

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 TheCodingMachine
+Copyright (c) 2019 TheCodingMachine
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -0,0 +1,61 @@
+GOLANG_VERSION=1.13
+VERSION=snapshot
+DOCKER_USER=
+DOCKER_PASSWORD=
+DOCKER_REPOSITORY=thecodingmachine
+GOLANGCI_LINT_VERSION=1.19.1
+CODE_COVERAGE=0
+TINI_VERSION=0.18.0
+MAXIMUM_WAIT_TIMEOUT=30.0
+MAXIMUM_WAIT_DELAY=10.0
+MAXIMUM_WEBHOOK_URL_TIMEOUT=30.0
+DEFAULT_WAIT_TIMEOUT=10.0
+DEFAULT_WEBHOOK_URL_TIMEOUT=10.0
+DEFAULT_LISTEN_PORT=3000
+DISABLE_GOOGLE_CHROME=0
+DISABLE_UNOCONV=0
+LOG_LEVEL=INFO
+
+# build the base Docker image.
+base:
+	docker build -t $(DOCKER_REPOSITORY)/gotenberg:base -f build/base/Dockerfile .
+
+# build the workspace Docker image.
+workspace:
+	make base
+	docker build --build-arg GOLANG_VERSION=$(GOLANG_VERSION) -t $(DOCKER_REPOSITORY)/gotenberg:workspace -f build/workspace/Dockerfile . 
+
+# gofmt and goimports all go files.
+fmt:
+	go fmt ./...
+	go mod tidy
+
+# run all linters.
+lint:
+	make workspace
+	docker build --build-arg GOLANGCI_LINT_VERSION=$(GOLANGCI_LINT_VERSION) -t $(DOCKER_REPOSITORY)/gotenberg:lint -f build/lint/Dockerfile .
+	docker run --rm $(DOCKER_REPOSITORY)/gotenberg:lint
+
+# run all tests.
+tests:
+	make workspace
+	./scripts/tests.sh $(DOCKER_REPOSITORY) $(CODE_COVERAGE)
+
+# generate documentation.
+doc:
+	docker build -t $(DOCKER_REPOSITORY)/gotenberg:docs -f build/docs/Dockerfile . 
+	docker run --rm -it -v "$(PWD):/gotenberg/docs" $(DOCKER_REPOSITORY)/gotenberg:docs
+
+# build Gotenberg Docker image.
+image:
+	make workspace
+	docker build --build-arg VERSION=$(VERSION) --build-arg TINI_VERSION=$(TINI_VERSION) -t $(DOCKER_REPOSITORY)/gotenberg:$(VERSION) -f build/package/Dockerfile .
+
+# start the API using previously built Docker image.
+gotenberg:
+	docker run -it --rm -e MAXIMUM_WAIT_TIMEOUT=$(MAXIMUM_WAIT_TIMEOUT) -e MAXIMUM_WAIT_DELAY=$(MAXIMUM_WAIT_DELAY) -e MAXIMUM_WEBHOOK_URL_TIMEOUT=$(MAXIMUM_WEBHOOK_URL_TIMEOUT) -e DEFAULT_WEBHOOK_URL_TIMEOUT=$(DEFAULT_WEBHOOK_URL_TIMEOUT) -e MAXIMUM_WEBHOOK_URL_TIMEOUT=$(MAXIMUM_WEBHOOK_URL_TIMEOUT) -e DEFAULT_LISTEN_PORT=$(DEFAULT_LISTEN_PORT) -e DISABLE_GOOGLE_CHROME=$(DISABLE_GOOGLE_CHROME) -e DISABLE_UNOCONV=$(DISABLE_UNOCONV) -e LOG_LEVEL=$(LOG_LEVEL)  -p "$(DEFAULT_LISTEN_PORT):$(DEFAULT_LISTEN_PORT)" $(DOCKER_REPOSITORY)/gotenberg:$(VERSION)
+
+# publish Gotenberg images according to version.
+publish:
+	make workspace
+	./scripts/publish.sh $(GOLANG_VERSION) $(TINI_VERSION) $(DOCKER_REPOSITORY) $(VERSION) $(DOCKER_USER) $(DOCKER_PASSWORD)

README.md

@@ -1,202 +1,42 @@
 <p align="center">
-    <img src="https://user-images.githubusercontent.com/8983173/38133342-11df3bd8-340f-11e8-9fe4-50baecdceeca.png" alt="Gotenberg's logo" width="250" height="250" />
+    <img src="https://user-images.githubusercontent.com/8983173/50009948-84b01e00-ffb8-11e8-850b-fc240382c626.png" alt="Gotenberg logo" width="250" height="250" />
 </p>
 <h3 align="center">Gotenberg</h3>
-<p align="center">A stateless API for converting Markdown files, HTML files and Office documents to PDF</p>
-<p align="center">
-    <a href="https://microbadger.com/images/thecodingmachine/gotenberg:2.0.0">
-        <img src="https://images.microbadger.com/badges/image/thecodingmachine/gotenberg:2.0.0.svg" alt="MicroBadger layers">
-    </a>
-    <a href="https://travis-ci.org/thecodingmachine/gotenberg">
-        <img src="https://travis-ci.org/thecodingmachine/gotenberg.svg?branch=master" alt="Travis CI">
-    </a>
-    <a href="https://godoc.org/github.com/thecodingmachine/gotenberg">
-        <img src="https://godoc.org/github.com/thecodingmachine/gotenberg?status.svg" alt="GoDoc">
-    </a>
-    <a href="https://goreportcard.com/report/thecodingmachine/gotenberg">
-        <img src="https://goreportcard.com/badge/github.com/thecodingmachine/gotenberg" alt="Go Report Card">
-    </a>
-    <a href="https://codecov.io/gh/thecodingmachine/gotenberg/branch/master">
-        <img src="https://codecov.io/gh/thecodingmachine/gotenberg/branch/master/graph/badge.svg" alt="Codecov">
-    </a>
-</p>
+<p align="center">A Docker-powered stateless API for converting HTML, Markdown and Office documents to PDF.</p>
+<p align="center"><a href="https://thecodingmachine.github.io/gotenberg">Documentation</a> &#183; <a href="/.github/CONTRIBUTING.md">Contributing</a></p>
 
 ---
 
-At TheCodingMachine, we build a lot of web applications (intranets, extranets and so on) which require to generate PDF from 
-various sources. Each time, we ended up using some well known libraries like **wkhtmltopdf** or **unoconv** and kind of lost time by
-reimplementing a solution from a project to another project. Meh.
+At TheCodingMachine, we build a lot of web applications (intranets, extranets and so on) which require to generate PDF from various sources. Each time, we ended up using some well known libraries and kind of lost time by reimplementing a solution from a project to another project. Meh.
 
-# Menu
+## Features
 
-* [Usage](#usage)
-* [Security](#security)
-* [Scalability](#scalability)
-* [Custom implementation](#custom-implementation)
-* [Clients](#clients)
+* HTML and Markdown conversions using Google Chrome headless
+* Office conversions (.txt, .rtf, .docx, .doc, .odt, .pptx, .ppt, .odp and so on) using [unoconv](https://github.com/dagwieers/unoconv)
+* Assets :package:: send your header, footer, images, fonts, stylesheets and so on for converting your HTML and Markdown to beaufitul PDFs!
+* Easily interact with the API using our [Go](https://github.com/thecodingmachine/gotenberg-go-client) and [PHP](https://github.com/thecodingmachine/gotenberg-php-client) libraries
 
-## Usage
+## Quick start
 
-Let's say you're starting the API using this simple command:
-
-```sh
-$ docker run --rm -p 3000:3000 thecodingmachine/gotenberg:2.0.0
-```
-
-The API is now available on your host under `http://127.0.0.1:3000`.
-
-It accepts `POST` requests with a `multipart/form-data` Content-Type. Your form data should provide one or more files to convert.
-The default image accepts the following:
-
-* Markdown files
-* HTML files
-* Office documents (.docx, .doc, .odt, .pptx, .ppt, .odp and so on)
-* PDF files
-
-**Heads up:** the API relies on the file extension to determine which library to use for conversion.
-
-There are two use cases:
-
-* If you send one file, it will convert it and return the resulting PDF
-* If many files, it will convert them to PDF, merge the resulting PDFs into a single PDF and return it
-
-### Examples:
-
-* One file
-
-```sh
-$ curl --request POST \
-    --url http://127.0.0.1:3000 \
-    --header 'Content-Type: multipart/form-data' \
-    --form files=@file.docx \
-    > result.pdf
-```
-
-* Many files
-
-```sh
-$ curl --request POST \
-    --url http://127.0.0.1:3000 \
-    --header 'Content-Type: multipart/form-data' \
-    --form files=@file.md \
-    --form files=@file.html \
-    --form files=@file.pdf \
-    --form files=@file.docx \
-    > result.pdf
-```
-
-## Security
-
-The API does not provide any authentication mechanisms. Make sure to not put it on a public facing port and your client(s) should always 
-controls what is sent to the API.
-
-## Scalability
-
-Some libraries like **unoconv** cannot perform concurrent conversions. That's why the API does only one conversion at a time.
-If your API is under heavy load, a request will take time to be processed. 
-
-Fortunately, you may pass through this limitation by scaling the API.
-
-In the following example, I'll demonstrate how to do some vertical scaling (= on the same machine) with Docker Compose, but of course horizontal scaling works too!
-
-```yaml
-version: '3'
-
-services:
-
-  # your others services
-      
-  gotenberg:
-    image: thecodingmachine/gotenberg:2.0.0
-```
-
-You may now launch your services using:
+Open a terminal and run the following command:
 
 ```bash
-docker-compose up --scale gotenberg=your_number_of_instances
+$ docker run --rm -p 3000:3000 thecodingmachine/gotenberg:6
 ```
 
-When requesting the Gotenberg service with your client(s), Docker will automatically redirect a request to a Gotenberg container
-according to the round-robin strategy.
+The API is now available on your host at `http://localhost:3000`.
 
-## Custom implementation
+Head to the [documentation](https://thecodingmachine.github.io/gotenberg)
+to learn how to interact with it!
 
-The API relies on a simple YAML configuration file called `gotenberg.yml`. It allows you to tweak some values and even provides you 
-a way to change the commands called for each kind of conversion.
+## Badges
 
-Below the default configuration file:
-
-```yaml
-# The port the application will listen to.
-port: 3000
-
-logs:
-  # Accepted values, in order of severity: DEBUG, INFO, WARN, ERROR, FATAL, PANIC.
-  # Messages at and above the selected level will be logged.
-  level: "INFO"
-
-  # Accepted values: text, json.
-  # When a TTY is not attached, the output will be in the defined format.
-  formatter: "text"
-
-# You don't like a library which is used for a conversion? You want to handle a new file type?
-# You may provide here your own implementation!
-commands:
-
-  # Some libraries like unoconv cannot perform concurrent conversions. That's why the API does only one conversion at a time.
-  # If your current implementation uses libraries which are able to perform concurrent conversions, you may
-  # change this value to false.
-  lock: true
-
-  # Unlike others commands' templates, you have access to FilesPaths instead of FilePath: it gathers all PDF files which should be merged.
-  merge:
-    template: "pdftk {{ range $filePath := .FilesPaths }} {{ $filePath }} {{ end }} cat output {{ .ResultFilePath }}"
-    interpreter: "/bin/sh -c"
-    timeout: 30
-  
-  # You may add more commands (or less, or even none).
-  conversions:
-
-      # The command template: you have access to FilePath and ResultFilePath variables.
-    - template: "markdown-pdf {{ .FilePath }} -o {{ .ResultFilePath }}"
-      # The binary which will call the command.
-      interpreter: "/bin/sh -c"
-      # Duration in seconds after which the command will be killed if it has not finished.
-      timeout: 30
-      # Files with the following extensions will be converted by the current command.
-      extensions:
-        - ".md"
-
-    - template: "xvfb-run -e /dev/stdout wkhtmltopdf {{ .FilePath }} {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".html"
-        - ".htm"
-
-    - template: "unoconv --format pdf --output \"{{ .ResultFilePath }}\" \"{{ .FilePath }}\""
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".doc"
-        - ".docx"
-        - ".odt"
-        - ".xls"
-        - ".xlsx"
-        - ".ods"
-        - ".ppt"
-        - ".pptx"
-        - ".odp"
-```
-
-We provide binaries for a wide range of OS and architecture in the [releases page](../../releases), 
-so feel free to create your own Docker image for your implementation of the Gotenberg API :metal:
-
-## Clients
-
-* https://github.com/thecodingmachine/gotenberg-php-client (PHP client)
-* Add your own client by submitting a [pull request](../../pulls)!
+[![Docker image layers](https://images.microbadger.com/badges/image/thecodingmachine/gotenberg:6.svg)](https://microbadger.com/images/thecodingmachine/gotenberg:6)
+[![Travis CI](https://travis-ci.org/thecodingmachine/gotenberg.svg?branch=master)](https://travis-ci.org/thecodingmachine/gotenberg)
+[![GoDoc](https://godoc.org/github.com/thecodingmachine/gotenberg?status.svg)](https://godoc.org/github.com/thecodingmachine/gotenberg)
+[![Codecov](https://codecov.io/gh/thecodingmachine/gotenberg/branch/master/graph/badge.svg)](https://codecov.io/gh/thecodingmachine/gotenberg)
+[![Go Report Card](https://goreportcard.com/badge/github.com/thecodingmachine/gotenberg)](https://goreportcard.com/report/thecodingmachine/gotenberg)
 
 ---
 
-Would you like to update this documentation ? Feel free to open an [issue](../../issues).
+Psst: TheCodingMachine is always looking for [talented coders](https://coders.thecodingmachine.com).

_tests/configurations/broken-gotenberg.yml

@@ -1,39 +0,0 @@
-port: 3000
-logs:
-  level: "DEBUG"
-  formatter: {
-      value: [
-      ...
-    }
-commands:
-  lock: true
-  merge:
-    template: "pdftk {{ range $filePath := .FilesPaths }} {{ $filePath }} {{ end }} cat output {{ .ResultFilePath }}"
-    interpreter: "/bin/sh -c"
-    timeout: 30
-  conversions:
-    - template: "markdown-pdf {{ .FilePath }} -o {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".md"
-    - template: "xvfb-run -e /dev/stdout wkhtmltopdf {{ .FilePath }} {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".html"
-        - ".htm"
-    - template: "unoconv --format pdf --output \"{{ .ResultFilePath }}\" \"{{ .FilePath }}\""
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".doc"
-        - ".docx"
-        - ".odt"
-        - ".xls"
-        - ".xlsx"
-        - ".ods"
-        - ".ppt"
-        - ".pptx"
-        - ".odp"
-

_tests/configurations/duplicate-command-gotenberg.yml

@@ -1,40 +0,0 @@
-port: 3000
-logs:
-  level: "DEBUG"
-  formatter: "text"
-commands:
-  lock: true
-  merge:
-    template: "pdftk {{ range $filePath := .FilesPaths }} {{ $filePath }} {{ end }} cat output {{ .ResultFilePath }}"
-    interpreter: "/bin/sh -c"
-    timeout: 30
-  conversions:
-    - template: "markdown-pdf {{ .FilePath }} -o {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".md"
-    - template: "markdown-pdf {{ .FilePath }} -o {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".md"
-    - template: "xvfb-run -e /dev/stdout wkhtmltopdf {{ .FilePath }} {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".html"
-        - ".htm"
-    - template: "unoconv --format pdf --output \"{{ .ResultFilePath }}\" \"{{ .FilePath }}\""
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".doc"
-        - ".docx"
-        - ".odt"
-        - ".xls"
-        - ".xlsx"
-        - ".ods"
-        - ".ppt"
-        - ".pptx"
-        - ".odp"

_tests/configurations/gotenberg.yml

@@ -1,35 +0,0 @@
-port: 3000
-logs:
-  level: "DEBUG"
-  formatter: "text"
-commands:
-  lock: true
-  merge:
-    template: "pdftk {{ range $filePath := .FilesPaths }} {{ $filePath }} {{ end }} cat output {{ .ResultFilePath }}"
-    interpreter: "/bin/sh -c"
-    timeout: 30
-  conversions:
-    - template: "markdown-pdf {{ .FilePath }} -o {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".md"
-    - template: "xvfb-run -e /dev/stdout wkhtmltopdf {{ .FilePath }} {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".html"
-        - ".htm"
-    - template: "unoconv --format pdf --output \"{{ .ResultFilePath }}\" \"{{ .FilePath }}\""
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".doc"
-        - ".docx"
-        - ".odt"
-        - ".xls"
-        - ".xlsx"
-        - ".ods"
-        - ".ppt"
-        - ".pptx"
-        - ".odp"

_tests/configurations/merge-timeout-gotenberg.yml

@@ -1,35 +0,0 @@
-port: 3000
-logs:
-  level: "DEBUG"
-  formatter: "text"
-commands:
-  lock: true
-  merge:
-    template: "pdftk {{ range $filePath := .FilesPaths }} {{ $filePath }} {{ end }} cat output {{ .ResultFilePath }}"
-    interpreter: "/bin/sh -c"
-    timeout: 0
-  conversions:
-    - template: "markdown-pdf {{ .FilePath }} -o {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".md"
-    - template: "xvfb-run -e /dev/stdout wkhtmltopdf {{ .FilePath }} {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".html"
-        - ".htm"
-    - template: "unoconv --format pdf --output \"{{ .ResultFilePath }}\" \"{{ .FilePath }}\""
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".doc"
-        - ".docx"
-        - ".odt"
-        - ".xls"
-        - ".xlsx"
-        - ".ods"
-        - ".ppt"
-        - ".pptx"
-        - ".odp"

_tests/configurations/no-lock-gotenberg.yml

@@ -1,35 +0,0 @@
-port: 3000
-logs:
-  level: "DEBUG"
-  formatter: "text"
-commands:
-  lock: false
-  merge:
-    template: "pdftk {{ range $filePath := .FilesPaths }} {{ $filePath }} {{ end }} cat output {{ .ResultFilePath }}"
-    interpreter: "/bin/sh -c"
-    timeout: 30
-  conversions:
-    - template: "markdown-pdf {{ .FilePath }} -o {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".md"
-    - template: "xvfb-run -e /dev/stdout wkhtmltopdf {{ .FilePath }} {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".html"
-        - ".htm"
-    - template: "unoconv --format pdf --output \"{{ .ResultFilePath }}\" \"{{ .FilePath }}\""
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".doc"
-        - ".docx"
-        - ".odt"
-        - ".xls"
-        - ".xlsx"
-        - ".ods"
-        - ".ppt"
-        - ".pptx"
-        - ".odp"

_tests/configurations/timeout-gotenberg.yml

@@ -1,35 +0,0 @@
-port: 3000
-logs:
-  level: "DEBUG"
-  formatter: "text"
-commands:
-  lock: true
-  merge:
-    template: "pdftk {{ range $filePath := .FilesPaths }} {{ $filePath }} {{ end }} cat output {{ .ResultFilePath }}"
-    interpreter: "/bin/sh -c"
-    timeout: 0
-  conversions:
-    - template: "markdown-pdf {{ .FilePath }} -o {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 0
-      extensions:
-        - ".md"
-    - template: "xvfb-run -e /dev/stdout wkhtmltopdf {{ .FilePath }} {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 0
-      extensions:
-        - ".html"
-        - ".htm"
-    - template: "unoconv --format pdf --output \"{{ .ResultFilePath }}\" \"{{ .FilePath }}\""
-      interpreter: "/bin/sh -c"
-      timeout: 0
-      extensions:
-        - ".doc"
-        - ".docx"
-        - ".odt"
-        - ".xls"
-        - ".xlsx"
-        - ".ods"
-        - ".ppt"
-        - ".pptx"
-        - ".odp"

_tests/configurations/wrong-command-template-gotenberg.yml

@@ -1,35 +0,0 @@
-port: 3000
-logs:
-  level: "DEBUG"
-  formatter: "text"
-commands:
-  lock: true
-  merge:
-    template: "pdftk {{ range $filePath := .FilesPaths }} {{ $filePath }} {{ end }} cat output {{ .ResultFilePath }}"
-    interpreter: "/bin/sh -c"
-    timeout: 30
-  conversions:
-    - template: "markdown-pdf {{ FilePath }} -o {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".md"
-    - template: "xvfb-run -e /dev/stdout wkhtmltopdf {{ .FilePath }} {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".html"
-        - ".htm"
-    - template: "unoconv --format pdf --output \"{{ .ResultFilePath }}\" \"{{ .FilePath }}\""
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".doc"
-        - ".docx"
-        - ".odt"
-        - ".xls"
-        - ".xlsx"
-        - ".ods"
-        - ".ppt"
-        - ".pptx"
-        - ".odp"

_tests/configurations/wrong-logging-formatter-gotenberg.yml

@@ -1,35 +0,0 @@
-port: 3000
-logs:
-  level: "DEBUG"
-  formatter: "DEBUG"
-commands:
-  lock: true
-  merge:
-    template: "pdftk {{ range $filePath := .FilesPaths }} {{ $filePath }} {{ end }} cat output {{ .ResultFilePath }}"
-    interpreter: "/bin/sh -c"
-    timeout: 30
-  conversions:
-    - template: "markdown-pdf {{ .FilePath }} -o {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".md"
-    - template: "xvfb-run -e /dev/stdout wkhtmltopdf {{ .FilePath }} {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".html"
-        - ".htm"
-    - template: "unoconv --format pdf --output \"{{ .ResultFilePath }}\" \"{{ .FilePath }}\""
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".doc"
-        - ".docx"
-        - ".odt"
-        - ".xls"
-        - ".xlsx"
-        - ".ods"
-        - ".ppt"
-        - ".pptx"
-        - ".odp"

_tests/configurations/wrong-logging-level-gotenberg.yml

@@ -1,35 +0,0 @@
-port: 3000
-logs:
-  level: "text"
-  formatter: "text"
-commands:
-  lock: true
-  merge:
-    template: "pdftk {{ range $filePath := .FilesPaths }} {{ $filePath }} {{ end }} cat output {{ .ResultFilePath }}"
-    interpreter: "/bin/sh -c"
-    timeout: 30
-  conversions:
-    - template: "markdown-pdf {{ .FilePath }} -o {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".md"
-    - template: "xvfb-run -e /dev/stdout wkhtmltopdf {{ .FilePath }} {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".html"
-        - ".htm"
-    - template: "unoconv --format pdf --output \"{{ .ResultFilePath }}\" \"{{ .FilePath }}\""
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".doc"
-        - ".docx"
-        - ".odt"
-        - ".xls"
-        - ".xlsx"
-        - ".ods"
-        - ".ppt"
-        - ".pptx"
-        - ".odp"

_tests/configurations/wrong-merge-command-template-gotenberg.yml

@@ -1,35 +0,0 @@
-port: 3000
-logs:
-  level: "DEBUG"
-  formatter: "text"
-commands:
-  lock: true
-  merge:
-    template: "pdftk {{ range $filePath := FilesPaths }} {{ $filePath }} {{ end }} cat output {{ .ResultFilePath }}"
-    interpreter: "/bin/sh -c"
-    timeout: 30
-  conversions:
-    - template: "markdown-pdf {{ .FilePath }} -o {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".md"
-    - template: "xvfb-run -e /dev/stdout wkhtmltopdf {{ .FilePath }} {{ .ResultFilePath }}"
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".html"
-        - ".htm"
-    - template: "unoconv --format pdf --output \"{{ .ResultFilePath }}\" \"{{ .FilePath }}\""
-      interpreter: "/bin/sh -c"
-      timeout: 30
-      extensions:
-        - ".doc"
-        - ".docx"
-        - ".odt"
-        - ".xls"
-        - ".xlsx"
-        - ".ods"
-        - ".ppt"
-        - ".pptx"
-        - ".odp"

_tests/file.html

@@ -1,16 +0,0 @@
-<!DOCTYPE html>
-<html>
-
-<head>
-  <meta charset="utf-8">
-  <title>Some title</title>
-  <meta name="author" content="Julien Neuhart">
-  <meta name="description" content="Simple HTML page">
-  <meta name="viewport" content="width=device-width, initial-scale=1">
-</head>
-
-<body>
-  <p>Hi! I have been converted from an HTML page!</p>
-</body>
-
-</html>

_tests/file.md

@@ -1 +0,0 @@
-# Hi, I've been converted from a markdown file!

app/config/config.go

@@ -1,213 +0,0 @@
-/*
-Package config contains all the logic allowing us to instantiate the application's configuration.
-
-The application's configuration is loaded from a YAML file named gotenberg.yml.
-It should be located where the user starts the application from the CLI.
-*/
-package config
-
-import (
-	"fmt"
-	"strings"
-	"text/template"
-
-	"github.com/sirupsen/logrus"
-)
-
-type (
-	// appConfig gathers all configuration data.
-	appConfig struct {
-		port          string
-		logsLevel     logrus.Level
-		logsFormatter logrus.Formatter
-		lock          bool
-		// commands associates a file extension with a Command instance.
-		// Particular case: ".pdf" extension is used for the merge command.
-		commands map[string]*Command
-	}
-
-	// Command gathers information on how to launch an external binary used for converting
-	// a file to PDF.
-	Command struct {
-		// Template is the data-driven template of the command.
-		Template *template.Template
-		// The binary which will call the command.
-		Interpreter []string
-		// Timeout is the duration in seconds after which the command's process will be killed
-		// if it does not finish before.
-		Timeout int
-	}
-)
-
-// our default instance of appConfig.
-var config = &appConfig{}
-
-// Reset reinitializes our configuration.
-func Reset() {
-	config = &appConfig{}
-}
-
-// WithPort sets the port which will be used by the application.
-func WithPort(port string) {
-	config.port = port
-}
-
-// GetPort returns the current port.
-func GetPort() string {
-	return config.port
-}
-
-// levels associates logging levels as defined in the configuration file gotenberg.yml
-// with its counterpart from the logrus library.
-var levels = map[string]logrus.Level{
-	"DEBUG": logrus.DebugLevel,
-	"INFO":  logrus.InfoLevel,
-	"WARN":  logrus.WarnLevel,
-	"ERROR": logrus.ErrorLevel,
-	"FATAL": logrus.FatalLevel,
-	"PANIC": logrus.PanicLevel,
-}
-
-type wrongLogsLevelError struct{}
-
-const wrongLogsLevelErrorMessage = "accepted values for logs level: DEBUG, INFO, WARN, ERROR, FATAL, PANIC"
-
-func (e *wrongLogsLevelError) Error() string {
-	return wrongLogsLevelErrorMessage
-}
-
-// WithLogsLevel sets the logs level.
-// If the given string does not match with a logrus level,
-// throws an error.
-func WithLogsLevel(level string) error {
-	l, ok := levels[level]
-	if !ok {
-		return &wrongLogsLevelError{}
-	}
-
-	config.logsLevel = l
-	return nil
-}
-
-// GetLogsLevel returns the current logs level.
-func GetLogsLevel() logrus.Level {
-	return config.logsLevel
-}
-
-// formatters associates logging formatter as defined in the configuration file gotenberg.yml
-// with its counterpart from the logrus library.
-var formatters = map[string]logrus.Formatter{
-	"text": &logrus.TextFormatter{},
-	"json": &logrus.JSONFormatter{},
-}
-
-type wrongLogsFormatterError struct{}
-
-const wrongLogsFormatterErrorMessage = "accepted value for logs formatter: text, json"
-
-func (e *wrongLogsFormatterError) Error() string {
-	return wrongLogsFormatterErrorMessage
-}
-
-// WithLogsFormatter sets the logs formatter.
-// If the given string does not match with a logrus formatter,
-// throws an error.
-func WithLogsFormatter(formatter string) error {
-	f, ok := formatters[formatter]
-	if !ok {
-		return &wrongLogsFormatterError{}
-	}
-
-	config.logsFormatter = f
-	return nil
-}
-
-// GetLogsFormatter returns the current logs formatter.
-func GetLogsFormatter() logrus.Formatter {
-	return config.logsFormatter
-}
-
-// WithLock sets the lock strategy.
-func WithLock(lock bool) {
-	config.lock = lock
-}
-
-// HasLock returns the current lock strategy.
-func HasLock() bool {
-	return config.lock
-}
-
-type interpreterEmptyError struct {
-	command string
-}
-
-const interpreterEmptyErrorMessage = "the interepreter for command %s should not be empty"
-
-func (e *interpreterEmptyError) Error() string {
-	return fmt.Sprintf(interpreterEmptyErrorMessage, e.command)
-}
-
-// NewCommand instantiates a Command. If the given command string
-// is not a valid template, throws an error.
-func NewCommand(command string, interpreter string, timeout int) (*Command, error) {
-	t, err := template.New(command).Parse(command)
-	if err != nil {
-		return nil, err
-	}
-
-	if interpreter == "" {
-		return nil, &interpreterEmptyError{command}
-	}
-
-	return &Command{t, strings.Fields(interpreter), timeout}, nil
-}
-
-type fileExtensionAlreadyUsedError struct {
-	extension       string
-	command         *Command
-	existingCommand *Command
-}
-
-const fileExtensionAlreadyUsedErrorMessage = "file extension %s from command %s is already used by command %s"
-
-func (e *fileExtensionAlreadyUsedError) Error() string {
-	return fmt.Sprintf(fileExtensionAlreadyUsedErrorMessage, e.extension, e.command.Template.Name(), e.existingCommand.Template.Name())
-}
-
-// WithCommand adds a Command instance and associates it with the given
-// file extension. If the file extension is already used by another Command
-// instance, throws an error.
-func WithCommand(extension string, command *Command) error {
-	if config.commands == nil {
-		config.commands = make(map[string]*Command)
-	}
-
-	existingCommand, ok := config.commands[extension]
-	if ok {
-		return &fileExtensionAlreadyUsedError{extension, command, existingCommand}
-	}
-
-	config.commands[extension] = command
-	return nil
-}
-
-type noCommandFoundForFileExtensionError struct {
-	extension string
-}
-
-const noCommandFoundForFileExtensionErrorMessage = "no command found for file extension %s"
-
-func (e *noCommandFoundForFileExtensionError) Error() string {
-	return fmt.Sprintf(noCommandFoundForFileExtensionErrorMessage, e.extension)
-}
-
-// GetCommand returns the Command instance associated with the given
-// file extension. If no Command instance found, throws an error.
-func GetCommand(extension string) (*Command, error) {
-	c, ok := config.commands[extension]
-	if !ok {
-		return nil, &noCommandFoundForFileExtensionError{extension}
-	}
-
-	return c, nil
-}

app/config/config_test.go

@@ -1,201 +0,0 @@
-package config
-
-import (
-	"fmt"
-	"testing"
-
-	"github.com/sirupsen/logrus"
-)
-
-func TestReset(t *testing.T) {
-	c := &appConfig{}
-	config.port = "3000"
-	Reset()
-
-	if c.port != config.port {
-		t.Error("Configuration should have been reset")
-	}
-}
-
-func TestWithPort(t *testing.T) {
-	port := "3000"
-	WithPort(port)
-
-	if config.port != port {
-		t.Errorf("Configuration populated with a wrong port: got '%s' want '%s'", config.port, port)
-	}
-}
-
-func TestGetPort(t *testing.T) {
-	port := "3000"
-	config.port = port
-
-	if GetPort() != port {
-		t.Errorf("Configuration returned a wrong port: got '%s' want '%s'", GetPort(), port)
-	}
-}
-
-func TestWrongLogsLevelError(t *testing.T) {
-	err := &wrongLogsLevelError{}
-	if err.Error() != wrongLogsLevelErrorMessage {
-		t.Errorf("Error returned a wrong message: got '%s' want '%s'", err.Error(), wrongLogsLevelErrorMessage)
-	}
-}
-
-func TestWithLogsLevel(t *testing.T) {
-	var lvl string
-
-	// case 1: uses a wrong logs level.
-	lvl = "text"
-	if err := WithLogsLevel(lvl); err == nil {
-		t.Errorf("Configuration should not have been populated by using '%s' as logs level", lvl)
-	}
-
-	// case 2: uses a correct logs level.
-	lvl = "DEBUG"
-	if err := WithLogsLevel(lvl); err != nil {
-		t.Errorf("Configuration should have been populated by using '%s' as logs level", lvl)
-	}
-}
-
-func TestGetLogsLevel(t *testing.T) {
-	lvl := logrus.DebugLevel
-	config.logsLevel = lvl
-
-	if GetLogsLevel() != lvl {
-		t.Errorf("Configuration returned a wrong logs level: got '%s' want '%s'", GetLogsLevel(), lvl)
-	}
-}
-
-func TestWrongLogsFormatterError(t *testing.T) {
-	err := &wrongLogsFormatterError{}
-	if err.Error() != wrongLogsFormatterErrorMessage {
-		t.Errorf("Error returned a wrong message: got '%s' want '%s'", err.Error(), wrongLogsFormatterErrorMessage)
-	}
-}
-
-func TestWithLogsFormatter(t *testing.T) {
-	var formatter string
-
-	// case 1: uses a wrong logs formatter.
-	formatter = "DEBUG"
-	if err := WithLogsFormatter(formatter); err == nil {
-		t.Errorf("Configuration should not have been populated by using '%s' as logs formatter", formatter)
-	}
-
-	// case 2: uses a correct logs formatter.
-	formatter = "text"
-	if err := WithLogsFormatter(formatter); err != nil {
-		t.Errorf("Configuration should have been populated by using '%s' as logs formatter", formatter)
-	}
-}
-
-func TestGetLogsFormatter(t *testing.T) {
-	formatter := &logrus.TextFormatter{}
-	config.logsFormatter = formatter
-
-	if GetLogsFormatter() != formatter {
-		t.Errorf("Configuration returned a wrong logs formatter: got '%v' want '%v'", GetLogsFormatter(), formatter)
-	}
-}
-
-func TestWithLock(t *testing.T) {
-	lock := true
-	WithLock(lock)
-
-	if config.lock != lock {
-		t.Errorf("Configuration populated with a wrong lock strategy: got '%t' want '%t'", config.lock, lock)
-	}
-}
-
-func TestHasLock(t *testing.T) {
-	lock := true
-	config.lock = true
-
-	if HasLock() != lock {
-		t.Errorf("Configuration returned a wrong port: got '%t' want '%t'", HasLock(), lock)
-	}
-}
-
-func TestInterpreterEmptyError(t *testing.T) {
-	err := &interpreterEmptyError{"echo hello world"}
-	expected := fmt.Sprintf(interpreterEmptyErrorMessage, err.command)
-	if err.Error() != expected {
-		t.Errorf("Error returned a wrong message: got '%s' want '%s'", err.Error(), expected)
-	}
-}
-
-func TestNewCommand(t *testing.T) {
-	var cmd string
-
-	// case 1: uses a wrong command template.
-	cmd = "pdftk {{ range $filePath := FilesPaths }} {{ $filePath }} {{ end }} cat output {{ .ResultFilePath }}"
-	if _, err := NewCommand(cmd, "/bin/sh -c", 0); err == nil {
-		t.Errorf("Command should not have been instantiated by using '%s' as command template", cmd)
-	}
-
-	// case 2: uses a correct command template.
-	cmd = "pdftk {{ range $filePath := .FilesPaths }} {{ $filePath }} {{ end }} cat output {{ .ResultFilePath }}"
-	if _, err := NewCommand(cmd, "/bin/sh -c", 0); err != nil {
-		t.Errorf("Command should have been instantiated by using '%s' as command template", cmd)
-	}
-
-	// case 3: uses an empty interpreter.
-	if _, err := NewCommand(cmd, "", 0); err == nil {
-		t.Error("Command should not have been instantiated by using an empty interpreter")
-	}
-}
-
-func TestFileExtensionAlreadyUsedError(t *testing.T) {
-	ext := ".pdf"
-	cmd1, _ := NewCommand("echo", "/bin/sh -c", 0)
-	cmd2, _ := NewCommand("echo", "/bin/sh -c", 0)
-	err := &fileExtensionAlreadyUsedError{ext, cmd1, cmd2}
-	expected := fmt.Sprintf(fileExtensionAlreadyUsedErrorMessage, err.extension, err.command.Template.Name(), err.existingCommand.Template.Name())
-
-	if err.Error() != expected {
-		t.Errorf("Error returned a wrong message: got '%s' want '%s'", err.Error(), expected)
-	}
-}
-
-func TestWithCommand(t *testing.T) {
-	ext := ".pdf"
-	cmd, _ := NewCommand("echo", "/bin/sh -c", 0)
-
-	// case 1: uses a command with a file extension not already referenced.
-	if err := WithCommand(ext, cmd); err != nil {
-		t.Errorf("Configuration should have been populated by using a command with the file extension '%s'", ext)
-	}
-
-	// case 2: uses a command with a file extension already referenced.
-	if err := WithCommand(ext, cmd); err == nil {
-		t.Errorf("Configuration should not have been populated by using a command with the file extension '%s'", ext)
-	}
-}
-
-func TestNoCommandFoundForFileExtensionError(t *testing.T) {
-	err := &noCommandFoundForFileExtensionError{".pdf"}
-	expected := fmt.Sprintf(noCommandFoundForFileExtensionErrorMessage, err.extension)
-
-	if err.Error() != expected {
-		t.Errorf("Error returned a wrong message: got '%s' want '%s'", err.Error(), expected)
-	}
-}
-
-func TestGetCommand(t *testing.T) {
-	Reset()
-	ext := ".pdf"
-	cmd, _ := NewCommand("echo", "/bin/sh -c", 0)
-	WithCommand(ext, cmd)
-
-	// case 1: uses a file extension which has a command associated.
-	if _, err := GetCommand(ext); err != nil {
-		t.Errorf("Configuration should have been able to return a command by using the file extension '%s'", ext)
-	}
-
-	// case 2: uses a file extension which has no command associated.
-	ext = ".docx"
-	if _, err := GetCommand(ext); err == nil {
-		t.Errorf("Configuration should not have been able to return a command by using the file extension '%s'", ext)
-	}
-}

app/config/parser.go

@@ -1,99 +0,0 @@
-package config
-
-import (
-	"io/ioutil"
-
-	"gopkg.in/yaml.v2"
-)
-
-// ParseFile instantiates the application's configuration using the given YAML file.
-func ParseFile(configurationFilePath string) error {
-	fileConfig, err := readFile(configurationFilePath)
-	if err != nil {
-		return err
-	}
-
-	WithPort(fileConfig.Port)
-
-	if err := WithLogsLevel(fileConfig.Logs.Level); err != nil {
-		return err
-	}
-
-	if err := WithLogsFormatter(fileConfig.Logs.Formatter); err != nil {
-		return err
-	}
-
-	WithLock(fileConfig.Commands.Lock)
-
-	// handles merge command first...
-	cmd, err := NewCommand(fileConfig.Commands.Merge.Template, fileConfig.Commands.Merge.Interpreter, fileConfig.Commands.Merge.Timeout)
-	if err != nil {
-		return err
-	}
-
-	WithCommand(".pdf", cmd)
-
-	// ...then conversion commands!
-	for _, command := range fileConfig.Commands.Conversions {
-		cmd, err := NewCommand(command.Template, command.Interpreter, command.Timeout)
-		if err != nil {
-			return err
-		}
-
-		for _, ext := range command.Extensions {
-			if err := WithCommand(ext, cmd); err != nil {
-				return err
-			}
-		}
-	}
-
-	return nil
-}
-
-type (
-	// fileConfig gathers all data coming from the configuration file gotenberg.yml.
-	fileConfig struct {
-		Port string `yaml:"port"`
-		Logs struct {
-			Level     string `yaml:"level"`
-			Formatter string `yaml:"formatter"`
-		} `yaml:"logs"`
-		Commands struct {
-			Lock        bool                 `yaml:"lock"`
-			Merge       *mergeCommand        `yaml:"merge"`
-			Conversions []*conversionCommand `yaml:"conversions,omitempty"`
-		} `yaml:"commands"`
-	}
-
-	// mergeCommand gathers all data regarding the... merge command.
-	mergeCommand struct {
-		Template    string `yaml:"template"`
-		Interpreter string `yaml:"interpreter"`
-		Timeout     int    `yaml:"timeout"`
-	}
-
-	// conversionCommand gathers all data regarding a conversion command.
-	conversionCommand struct {
-		Template    string   `yaml:"template"`
-		Interpreter string   `yaml:"interpreter"`
-		Timeout     int      `yaml:"timeout"`
-		Extensions  []string `yaml:"extensions"`
-	}
-)
-
-// readFile instantiates a fileConfig instance by reading
-// the given YAML file.
-func readFile(configurationFilePath string) (*fileConfig, error) {
-	c := &fileConfig{}
-
-	data, err := ioutil.ReadFile(configurationFilePath)
-	if err != nil {
-		return nil, err
-	}
-
-	if err := yaml.Unmarshal(data, &c); err != nil {
-		return nil, err
-	}
-
-	return c, nil
-}

app/config/parser_test.go

@@ -1,62 +0,0 @@
-package config
-
-import (
-	"path/filepath"
-	"testing"
-)
-
-func load(configurationFilePath string) error {
-	Reset()
-	return ParseFile(configurationFilePath)
-}
-
-func TestParseFile(t *testing.T) {
-	var path string
-
-	// case 1: uses an empty configuration file path.
-	if err := load(""); err == nil {
-		t.Error("Configuration should not have been populated by using an empty configuration file path")
-	}
-
-	// case 2: uses a broken configuration file.
-	path, _ = filepath.Abs("../../_tests/configurations/broken-gotenberg.yml")
-	if err := load(path); err == nil {
-		t.Errorf("Configuration should not have been populated with '%s'", path)
-	}
-
-	// case 3: uses a configuration file with a wrong logging level.
-	path, _ = filepath.Abs("../../_tests/configurations/wrong-logging-level-gotenberg.yml")
-	if err := load(path); err == nil {
-		t.Errorf("Configuration should not have been populated with '%s'", path)
-	}
-
-	// case 4: uses a configuration file with a wrong logging formatter.
-	path, _ = filepath.Abs("../../_tests/configurations/wrong-logging-formatter-gotenberg.yml")
-	if err := load(path); err == nil {
-		t.Errorf("Configuration should not have been populated with '%s'", path)
-	}
-
-	// case 5: uses a configuration file with a wrong merge command template.
-	path, _ = filepath.Abs("../../_tests/configurations/wrong-merge-command-template-gotenberg.yml")
-	if err := load(path); err == nil {
-		t.Errorf("Configuration should not have been populated with '%s'", path)
-	}
-
-	// case 6: uses a configuration file with a wrong command template.
-	path, _ = filepath.Abs("../../_tests/configurations/wrong-command-template-gotenberg.yml")
-	if err := load(path); err == nil {
-		t.Errorf("Configuration should not have been populated with '%s'", path)
-	}
-
-	// case 7: uses a configuration file with a duplicate command.
-	path, _ = filepath.Abs("../../_tests/configurations/duplicate-command-gotenberg.yml")
-	if err := load(path); err == nil {
-		t.Errorf("Configuration should not have been populated with '%s'", path)
-	}
-
-	// case 8: uses a correct configuration file.
-	path, _ = filepath.Abs("../../_tests/configurations/gotenberg.yml")
-	if err := load(path); err != nil {
-		t.Errorf("Configuration should have been populated with '%s'", path)
-	}
-}

app/context/context.go

@@ -1,105 +0,0 @@
-// Package context provides functions for setting and getting values from
-// a request's context.
-package context
-
-import (
-	"context"
-	"net/http"
-
-	"github.com/thecodingmachine/gotenberg/app/converter"
-)
-
-type key uint32
-
-const (
-	requestIDKey key = iota
-	converterKey
-	resultFilePathKey
-)
-
-// WithRequestID populates a request's context with the given request ID
-// and returns the updated request.
-func WithRequestID(r *http.Request, requestID string) *http.Request {
-	ctx := r.Context()
-	ctx = context.WithValue(ctx, requestIDKey, requestID)
-	r = r.WithContext(ctx)
-
-	return r
-}
-
-type requestIDNotFoundError struct{}
-
-const requestIDNotFoundErrorMessage = "the request ID was not found in request context"
-
-func (e *requestIDNotFoundError) Error() string {
-	return requestIDNotFoundErrorMessage
-}
-
-// GetRequestID returns the request ID if found in
-// the request's context. Otherwise throws an error.
-func GetRequestID(r *http.Request) (string, error) {
-	ID, ok := r.Context().Value(requestIDKey).(string)
-	if !ok {
-		return "", &requestIDNotFoundError{}
-	}
-
-	return ID, nil
-}
-
-// WithConverter populates a request's context with the given converter
-// and returns the updated request.
-func WithConverter(r *http.Request, converter *converter.Converter) *http.Request {
-	ctx := r.Context()
-	ctx = context.WithValue(ctx, converterKey, converter)
-	r = r.WithContext(ctx)
-
-	return r
-}
-
-type converterNotFoundError struct{}
-
-const converterNotFoundErrorMessage = "the converter was not found in request context"
-
-func (e *converterNotFoundError) Error() string {
-	return converterNotFoundErrorMessage
-}
-
-// GetConverter returns the converter if found in
-// the request's context. Otherwise throws an error.
-func GetConverter(r *http.Request) (*converter.Converter, error) {
-	c, ok := r.Context().Value(converterKey).(*converter.Converter)
-	if !ok {
-		return nil, &converterNotFoundError{}
-	}
-
-	return c, nil
-}
-
-// WithResultFilePath populates a request's context with the given result file path
-// and returns the updated request.
-func WithResultFilePath(r *http.Request, resultFilePath string) *http.Request {
-	ctx := r.Context()
-	ctx = context.WithValue(ctx, resultFilePathKey, resultFilePath)
-	r = r.WithContext(ctx)
-
-	return r
-}
-
-type resultFilePathNotFoundError struct{}
-
-const resultFilePathNotFoundErrorMessage = "the result file path was not found in request context"
-
-func (e *resultFilePathNotFoundError) Error() string {
-	return resultFilePathNotFoundErrorMessage
-}
-
-// GetResultFilePath returns the result file path if found in
-// the request's context. Otherwise throws an error.
-func GetResultFilePath(r *http.Request) (string, error) {
-	path, ok := r.Context().Value(resultFilePathKey).(string)
-	if !ok {
-		return "", &resultFilePathNotFoundError{}
-	}
-
-	return path, nil
-}

app/context/context_test.go

@@ -1,100 +0,0 @@
-package context
-
-import (
-	"net/http"
-	"net/http/httptest"
-	"testing"
-
-	"github.com/thecodingmachine/gotenberg/app/converter"
-
-	"github.com/satori/go.uuid"
-)
-
-func TestWithRequestID(t *testing.T) {
-	requestID := uuid.NewV4().String()
-	req := WithRequestID(httptest.NewRequest(http.MethodPost, "/", nil), requestID)
-	if ID, _ := req.Context().Value(requestIDKey).(string); ID != requestID {
-		t.Errorf("Context returned a wrong converter: got '%s' want '%s'", ID, requestID)
-	}
-}
-
-func TestRequestIDNotFoundError(t *testing.T) {
-	err := &requestIDNotFoundError{}
-	if err.Error() != requestIDNotFoundErrorMessage {
-		t.Errorf("Error returned a wrong message: got '%s' want '%s'", err.Error(), requestIDNotFoundErrorMessage)
-	}
-}
-
-func TestGetRequestID(t *testing.T) {
-	req := httptest.NewRequest(http.MethodPost, "/", nil)
-
-	// case 1: uses a request without a request ID entry in its context.
-	if _, err := GetRequestID(req); err == nil {
-		t.Error("Context should not have a request ID entry")
-	}
-
-	// case 2: uses a request with a request ID entry in its context.
-	req = WithRequestID(req, uuid.NewV4().String())
-	if _, err := GetRequestID(req); err != nil {
-		t.Error("Context should have a request ID entry")
-	}
-}
-
-func TestWithConverter(t *testing.T) {
-	req := WithConverter(httptest.NewRequest(http.MethodPost, "/", nil), &converter.Converter{})
-	if c, _ := req.Context().Value(converterKey).(*converter.Converter); c == nil {
-		t.Errorf("Context returned a wrong converter: got '%v' want not nil", c)
-	}
-}
-
-func TestConverterNotFoundError(t *testing.T) {
-	err := &converterNotFoundError{}
-	if err.Error() != converterNotFoundErrorMessage {
-		t.Errorf("Error returned a wrong message: got '%s' want '%s'", err.Error(), converterNotFoundErrorMessage)
-	}
-}
-
-func TestGetConverter(t *testing.T) {
-	req := httptest.NewRequest(http.MethodPost, "/", nil)
-
-	// case 1: uses a request without a converter entry in its context.
-	if _, err := GetConverter(req); err == nil {
-		t.Error("Context should not have a converter entry")
-	}
-
-	// case 2: uses a request with a converter entry in its context.
-	req = WithConverter(req, &converter.Converter{})
-	if _, err := GetConverter(req); err != nil {
-		t.Error("Context should have a converter entry")
-	}
-}
-
-func TestWithResultFilePath(t *testing.T) {
-	filePath := "file.pdf"
-	req := WithResultFilePath(httptest.NewRequest(http.MethodPost, "/", nil), filePath)
-	if path, _ := req.Context().Value(resultFilePathKey).(string); path != filePath {
-		t.Errorf("Context returned a wrong result file path: got '%s' want '%s'", path, filePath)
-	}
-}
-
-func TestResultFilePathNotFoundError(t *testing.T) {
-	err := &resultFilePathNotFoundError{}
-	if err.Error() != resultFilePathNotFoundErrorMessage {
-		t.Errorf("Error returned a wrong message: got '%s' want '%s'", err.Error(), resultFilePathNotFoundErrorMessage)
-	}
-}
-
-func TestGetResultFilePath(t *testing.T) {
-	req := httptest.NewRequest(http.MethodPost, "/", nil)
-
-	// case 1: uses a request without a result file path entry in its context.
-	if _, err := GetResultFilePath(req); err == nil {
-		t.Error("Context should not have a result file path entry")
-	}
-
-	// case 2: uses a request with a result file path entry in its context.
-	req = WithResultFilePath(req, "file.pdf")
-	if _, err := GetResultFilePath(req); err != nil {
-		t.Error("Context should have a result file path entry")
-	}
-}

app/converter/converter.go

@@ -1,114 +0,0 @@
-// Package converter implements a solution for converting one or more files to PDF.
-package converter
-
-import (
-	"fmt"
-	"io"
-	"net/http"
-	"os"
-
-	gfile "github.com/thecodingmachine/gotenberg/app/converter/file"
-	"github.com/thecodingmachine/gotenberg/app/converter/process"
-	"github.com/thecodingmachine/gotenberg/app/logger"
-
-	"github.com/satori/go.uuid"
-)
-
-// Converter handles conversion into PDF of files coming from a request.
-type Converter struct {
-	files      []*gfile.File
-	workingDir string
-}
-
-// NoFileToConvertError is raided when a request has not file attached to it.
-type NoFileToConvertError struct{}
-
-const noFileToConvertErrorMessage = "no file to convert"
-
-func (e *NoFileToConvertError) Error() string {
-	return noFileToConvertErrorMessage
-}
-
-// NewConverter instantiates a converter by parsing a request.
-func NewConverter(r *http.Request) (*Converter, error) {
-	c := &Converter{
-		workingDir: fmt.Sprintf("./%s/", uuid.NewV4().String()),
-	}
-
-	if err := os.Mkdir(c.workingDir, 0666); err != nil {
-		return nil, err
-	}
-
-	logger.Debugf("created working directory %s", c.workingDir)
-
-	reader, err := r.MultipartReader()
-	if err != nil {
-		return c, err
-	}
-
-	for {
-		part, err := reader.NextPart()
-		if err == io.EOF {
-			break
-		}
-
-		fileName := part.FileName()
-		if fileName == "" {
-			continue
-		}
-
-		f, err := gfile.NewFile(c.workingDir, part, fileName)
-		if err != nil {
-			return c, err
-		}
-
-		c.files = append(c.files, f)
-	}
-
-	if len(c.files) == 0 {
-		return c, &NoFileToConvertError{}
-	}
-
-	return c, nil
-}
-
-// Convert converts its associated files to PDF. If more than one file,
-// it will merge all of them into one unique PDF file.
-// Returns the new file path or an error if something bad happened.
-func (c *Converter) Convert() (string, error) {
-	var filesPaths []string
-	for _, f := range c.files {
-		if f.Extension != ".pdf" {
-			path, err := process.Unconv(c.workingDir, f)
-			if err != nil {
-				return "", err
-			}
-
-			filesPaths = append(filesPaths, path)
-		} else {
-			filesPaths = append(filesPaths, f.Path)
-		}
-	}
-
-	if len(filesPaths) == 1 {
-		return filesPaths[0], nil
-	}
-
-	path, err := process.Merge(c.workingDir, filesPaths)
-	if err != nil {
-		return "", err
-	}
-
-	return path, nil
-}
-
-// Clear removes all file inside its working directory.
-func (c *Converter) Clear() error {
-	if err := os.RemoveAll(c.workingDir); err != nil {
-		logger.Error(fmt.Errorf("failed to remove working directory %s", c.workingDir))
-		return err
-	}
-
-	logger.Debugf("removed working directory %s", c.workingDir)
-	return nil
-}

app/converter/converter_test.go

@@ -1,150 +0,0 @@
-package converter
-
-import (
-	"io"
-	"mime/multipart"
-	"net/http"
-	"net/http/httptest"
-	"os"
-	"path/filepath"
-	"testing"
-
-	"github.com/thecodingmachine/gotenberg/app/config"
-)
-
-func makeRequest(filesPaths ...string) *http.Request {
-	r, w := io.Pipe()
-	mpw := multipart.NewWriter(w)
-
-	go func() {
-		var part io.Writer
-		defer w.Close()
-
-		if len(filesPaths) == 0 {
-			part, _ = mpw.CreateFormField("foo")
-			part.Write([]byte("bar"))
-		} else {
-			for _, filePath := range filesPaths {
-				file, _ := os.Open(filePath)
-				defer file.Close()
-
-				fileInfo, _ := file.Stat()
-				part, _ = mpw.CreateFormFile("files", fileInfo.Name())
-				io.Copy(part, file)
-			}
-		}
-
-		mpw.Close()
-	}()
-
-	req := httptest.NewRequest(http.MethodPost, "/", r)
-	req.Header.Set("Content-Type", mpw.FormDataContentType())
-	return req
-}
-
-func load(configurationFilePath string) {
-	config.Reset()
-	path, _ := filepath.Abs(configurationFilePath)
-	config.ParseFile(path)
-}
-
-func TestNoFileToConvertError(t *testing.T) {
-	err := &NoFileToConvertError{}
-	if err.Error() != noFileToConvertErrorMessage {
-		t.Errorf("Error returned a wrong message: got '%s' want '%s'", err.Error(), noFileToConvertErrorMessage)
-	}
-}
-
-func TestNewConverter(t *testing.T) {
-	var (
-		path  string
-		oPath string
-	)
-
-	load("../../_tests/configurations/gotenberg.yml")
-
-	// case 1: uses a request with a single file.
-	path, _ = filepath.Abs("../../_tests/file.docx")
-	if _, err := NewConverter(makeRequest(path)); err != nil {
-		t.Errorf("Converter should have been instantiated with '%s'", path)
-	}
-
-	// case 2: uses a request with wrong file type.
-	path, _ = filepath.Abs("../../_tests/configurations/gotenberg.yml")
-	if _, err := NewConverter(makeRequest(path)); err == nil {
-		t.Errorf("Converter should not have been instantiated with '%s'", path)
-	}
-
-	// case 3: uses a request with two files.
-	path, _ = filepath.Abs("../../_tests/file.pdf")
-	oPath, _ = filepath.Abs("../../_tests/file.docx")
-	if _, err := NewConverter(makeRequest(path, oPath)); err != nil {
-		t.Errorf("Converter should have been instantiated with '%s' and '%s'", path, oPath)
-	}
-
-	// case 4: uses a request with one Office file type and one wrong file type.
-	path, _ = filepath.Abs("../../_tests/configurations/gotenberg.yml")
-	oPath, _ = filepath.Abs("../../_tests/file.docx")
-	if _, err := NewConverter(makeRequest(path, oPath)); err == nil {
-		t.Errorf("Converter should not have been instantiated with '%s' and '%s'", path, oPath)
-	}
-
-	// case 5: uses a request with no file.
-	if _, err := NewConverter(makeRequest()); err == nil {
-		t.Error("Converter should not have been instantiated with no file")
-	}
-}
-
-func TestConvert(t *testing.T) {
-	var (
-		path  string
-		oPath string
-		c     *Converter
-	)
-
-	load("../../_tests/configurations/gotenberg.yml")
-
-	// case 1: uses a request with a single file.
-	path, _ = filepath.Abs("../../_tests/file.docx")
-	c, _ = NewConverter(makeRequest(path))
-	if _, err := c.Convert(); err != nil {
-		t.Errorf("Converter should have been able to convert '%s' to PDF", path)
-	}
-
-	// case 2: uses a request with two files.
-	path, _ = filepath.Abs("../../_tests/file.pdf")
-	oPath, _ = filepath.Abs("../../_tests/file.docx")
-	c, _ = NewConverter(makeRequest(path, oPath))
-	if _, err := c.Convert(); err != nil {
-		t.Errorf("Converter should have been able to convert '%s' and '%s' to PDF", path, oPath)
-	}
-
-	load("../../_tests/configurations/timeout-gotenberg.yml")
-
-	// case 3: uses a request with a single file and a configuration with an unsuitable timeout for the conversion commands.
-	path, _ = filepath.Abs("../../_tests/file.docx")
-	c, _ = NewConverter(makeRequest(path))
-	if _, err := c.Convert(); err == nil {
-		t.Errorf("Converter should not have been able to convert '%s' to PDF", path)
-	}
-
-	load("../../_tests/configurations/merge-timeout-gotenberg.yml")
-
-	// case 4: uses a request with two files and a configuration with an unsuitable timeout for the merge command.
-	path, _ = filepath.Abs("../../_tests/file.pdf")
-	oPath, _ = filepath.Abs("../../_tests/file.docx")
-	c, _ = NewConverter(makeRequest(path, oPath))
-	if _, err := c.Convert(); err == nil {
-		t.Errorf("Converter should not have been able to merge '%s' and '%s' into PDF", path, oPath)
-	}
-}
-
-func TestClear(t *testing.T) {
-	load("../../_tests/configurations/gotenberg.yml")
-
-	path, _ := filepath.Abs("../../_tests/file.docx")
-	c, _ := NewConverter(makeRequest(path))
-	if err := c.Clear(); err != nil {
-		t.Error("Converter should have been able to clear itself")
-	}
-}

app/converter/file/file.go

@@ -1,60 +0,0 @@
-// Package file implements a solution for handling files coming from a request.
-package file
-
-import (
-	"fmt"
-	"io"
-	"os"
-	"path/filepath"
-
-	"github.com/thecodingmachine/gotenberg/app/config"
-	"github.com/thecodingmachine/gotenberg/app/logger"
-
-	"github.com/dustin/go-humanize"
-	"github.com/satori/go.uuid"
-)
-
-// File represents a file which has been created
-// from a request.
-type File struct {
-	// Extension is the extension of the file.
-	Extension string
-	// Path is the file path.
-	Path string
-}
-
-// NewFile creates a file in the considered directory.
-// Returns a *File instance or an error if something bad happened.
-func NewFile(workingDir string, r io.Reader, fileName string) (*File, error) {
-	ext := filepath.Ext(fileName)
-
-	if _, err := config.GetCommand(ext); err != nil {
-		return nil, err
-	}
-
-	f := &File{ext, MakeFilePath(workingDir, ext)}
-
-	file, err := os.Create(f.Path)
-	if err != nil {
-		return nil, err
-	}
-
-	defer file.Close()
-
-	n, err := io.Copy(file, r)
-	if err != nil {
-		return nil, err
-	}
-
-	// resets the read pointer.
-	file.Seek(0, 0)
-
-	logger.Debugf("working file %s has been created from %s (%s copied)", f.Path, fileName, humanize.Bytes(uint64(n)))
-	return f, nil
-}
-
-// MakeFilePath is a simple helper which generates a random file name
-// and associates it with the considered directory to make a path.
-func MakeFilePath(workingDir string, ext string) string {
-	return fmt.Sprintf("%s%s%s", workingDir, uuid.NewV4().String(), ext)
-}

app/converter/file/file_test.go

@@ -1,38 +0,0 @@
-package file
-
-import (
-	"bytes"
-	"os"
-	"path/filepath"
-	"testing"
-
-	"github.com/thecodingmachine/gotenberg/app/config"
-)
-
-func load(configurationFilePath string) {
-	config.Reset()
-	path, _ := filepath.Abs(configurationFilePath)
-	config.ParseFile(path)
-}
-
-func TestNewFile(t *testing.T) {
-	load("../../../_tests/configurations/gotenberg.yml")
-
-	workingDir := "test"
-	os.Mkdir(workingDir, 0666)
-
-	// case 1: uses a wrong file name.
-	if _, err := NewFile(workingDir, new(bytes.Buffer), "file.yml"); err == nil {
-		t.Error("File should not have been instantiated with an empty buffer")
-	}
-
-	// case 2: uses a file name.
-	filePath, _ := filepath.Abs("../../../_tests/file.pdf")
-	r, _ := os.Open(filePath)
-	defer r.Close()
-	if _, err := NewFile(workingDir, r, "file.pdf"); err != nil {
-		t.Errorf("File should have been instantiated using a reader of '%s'", filePath)
-	}
-
-	os.RemoveAll(workingDir)
-}

app/converter/process/process.go

@@ -1,130 +0,0 @@
-// Package process handles all commands executions.
-package process
-
-import (
-	"bytes"
-	"fmt"
-	"os/exec"
-	"sync"
-	"time"
-
-	"github.com/thecodingmachine/gotenberg/app/config"
-	gfile "github.com/thecodingmachine/gotenberg/app/converter/file"
-	"github.com/thecodingmachine/gotenberg/app/logger"
-)
-
-type runner struct {
-	mu sync.Mutex
-}
-
-var forest = &runner{}
-
-type commandTimeoutError struct {
-	command string
-	timeout int
-}
-
-const commandTimeoutErrorMessage = "the command %s has reached the %d second(s) timeout"
-
-func (e *commandTimeoutError) Error() string {
-	return fmt.Sprintf(commandTimeoutErrorMessage, e.command, e.timeout)
-}
-
-// run runs the given command. If timeout is reached or
-// something bad happened, returns an error.
-func (r *runner) run(command string, interpreter []string, timeout int) error {
-	if config.HasLock() {
-		r.mu.Lock()
-		defer r.mu.Unlock()
-	} else {
-		logger.Warn("lock disabled")
-	}
-
-	binary := interpreter[0]
-	parameters := append(interpreter[1:], command)
-	cmd := exec.Command(binary, parameters...)
-	logger.Debugf("executing command %s", cmd.Args)
-
-	if err := cmd.Start(); err != nil {
-		return err
-	}
-
-	done := make(chan error, 1)
-	go func() {
-		done <- cmd.Wait()
-	}()
-
-	// wait for the process to finish or kill it after a timeout.
-	select {
-	case <-time.After(time.Duration(timeout) * time.Second):
-		if err := cmd.Process.Kill(); err != nil {
-			return err
-		}
-
-		return &commandTimeoutError{command, timeout}
-	case err := <-done:
-		if err != nil {
-			return err
-		}
-
-		return nil
-	}
-}
-
-// conversionData will be applied to the data-driven templates of conversions commands.
-type conversionData struct {
-	FilePath       string
-	ResultFilePath string
-}
-
-// Unconv converts a file to PDF and returns the new file path.
-func Unconv(workingDir string, file *gfile.File) (string, error) {
-	cmdData := &conversionData{file.Path, gfile.MakeFilePath(workingDir, ".pdf")}
-
-	cmd, err := config.GetCommand(file.Extension)
-	if err != nil {
-		return "", err
-	}
-
-	var data bytes.Buffer
-	if err := cmd.Template.Execute(&data, cmdData); err != nil {
-		return "", err
-	}
-
-	err = forest.run(data.String(), cmd.Interpreter, cmd.Timeout)
-	if err != nil {
-		return "", err
-	}
-
-	logger.Debugf("created %s from %s", cmdData.ResultFilePath, cmdData.FilePath)
-	return cmdData.ResultFilePath, nil
-}
-
-// mergeData will be applied to the data-driven template of the merge command.
-type mergeData struct {
-	FilesPaths     []string
-	ResultFilePath string
-}
-
-// Merge merges many PDF files to one unique PDF file and returns the new file path.
-func Merge(workingDir string, filesPaths []string) (string, error) {
-	cmdData := &mergeData{filesPaths, gfile.MakeFilePath(workingDir, ".pdf")}
-
-	cmd, err := config.GetCommand(".pdf")
-	if err != nil {
-		return "", err
-	}
-
-	var data bytes.Buffer
-	if err := cmd.Template.Execute(&data, cmdData); err != nil {
-		return "", err
-	}
-
-	err = forest.run(data.String(), cmd.Interpreter, cmd.Timeout)
-	if err != nil {
-		return "", err
-	}
-
-	logger.Debugf("created %s from %+v", cmdData.ResultFilePath, cmdData.FilesPaths)
-	return cmdData.ResultFilePath, nil
-}

app/converter/process/process_test.go

@@ -1,140 +0,0 @@
-package process
-
-import (
-	"fmt"
-	"os"
-	"path/filepath"
-	"strings"
-	"testing"
-
-	"github.com/thecodingmachine/gotenberg/app/config"
-	gfile "github.com/thecodingmachine/gotenberg/app/converter/file"
-)
-
-func makeFile(workingDir string, fileName string) *gfile.File {
-	filePath := fmt.Sprintf("%s%s", "../../../_tests/", fileName)
-	absPath, _ := filepath.Abs(filePath)
-
-	r, _ := os.Open(absPath)
-	defer r.Close()
-
-	f, _ := gfile.NewFile(workingDir, r, fileName)
-
-	return f
-}
-
-func load(configurationFilePath string) {
-	config.Reset()
-	path, _ := filepath.Abs(configurationFilePath)
-	config.ParseFile(path)
-}
-
-func TestCommandTimeoutError(t *testing.T) {
-	err := &commandTimeoutError{"echo hello", 30}
-	expected := fmt.Sprintf(commandTimeoutErrorMessage, err.command, err.timeout)
-
-	if err.Error() != expected {
-		t.Errorf("Error returned a wrong message: got '%s' want '%s'", err.Error(), expected)
-	}
-}
-
-func TestRun(t *testing.T) {
-	var cmd string
-
-	load("../../../_tests/configurations/gotenberg.yml")
-
-	// case 1: uses a simple command.
-	cmd = "echo Hello world"
-	if err := forest.run(cmd, strings.Fields("/bin/sh -c"), 30); err != nil {
-		t.Errorf("Command '%s' should have worked", cmd)
-	}
-
-	// case 2: uses a simple command but with an unsuitable timeout.
-	cmd = "sleep 5"
-	if err := forest.run(cmd, strings.Fields("/bin/sh -c"), 0); err == nil {
-		t.Errorf("Command '%s' should not have worked", cmd)
-	}
-
-	// case 3: uses a broken command.
-	cmd = "helloworld"
-	if err := forest.run(cmd, strings.Fields("/bin/sh -c"), 30); err == nil {
-		t.Errorf("Command '%s' should not have worked", cmd)
-	}
-
-	load("../../../_tests/configurations/no-lock-gotenberg.yml")
-
-	// case 4: uses a configuration with a no lock strategy.
-	cmd = "echo Hello world"
-	if err := forest.run(cmd, strings.Fields("/bin/sh -c"), 30); err != nil {
-		t.Errorf("Command '%s' should have worked", cmd)
-	}
-}
-
-func TestUnconv(t *testing.T) {
-	var file *gfile.File
-
-	workingDir := "test"
-	os.Mkdir(workingDir, 0666)
-
-	load("../../../_tests/configurations/gotenberg.yml")
-
-	// case 1: uses an Markdown file type.
-	file = makeFile(workingDir, "file.md")
-	if _, err := Unconv(workingDir, file); err != nil {
-		t.Errorf("Converting '%s' to PDF should have worked", file.Path)
-	}
-
-	// case 2: uses an HTML file type.
-	file = makeFile(workingDir, "file.html")
-	if _, err := Unconv(workingDir, file); err != nil {
-		t.Errorf("Converting '%s' to PDF should have worked", file.Path)
-	}
-
-	// case 3: uses an Office file type.
-	file = makeFile(workingDir, "file.docx")
-	if _, err := Unconv(workingDir, file); err != nil {
-		t.Errorf("Converting '%s' to PDF should have worked", file.Path)
-	}
-
-	// case 4: uses a PDF file type.
-	file = makeFile(workingDir, "file.pdf")
-	if _, err := Unconv(workingDir, file); err == nil {
-		t.Errorf("Converting '%s' to PDF should not have worked", file.Path)
-	}
-
-	load("../../../_tests/configurations/timeout-gotenberg.yml")
-
-	// case 5: uses a command with an unsuitable timeout.
-	file = makeFile(workingDir, "file.docx")
-	if _, err := Unconv(workingDir, makeFile(workingDir, "file.docx")); err == nil {
-		t.Errorf("Converting '%s' to PDF should have reached timeout", file.Path)
-	}
-
-	os.RemoveAll(workingDir)
-}
-
-func TestMerge(t *testing.T) {
-	workingDir := "test"
-	os.Mkdir(workingDir, 0666)
-
-	load("../../../_tests/configurations/gotenberg.yml")
-
-	var filesPaths []string
-	path, _ := filepath.Abs("../../../_tests/file.pdf")
-	filesPaths = append(filesPaths, path)
-	filesPaths = append(filesPaths, path)
-
-	// case 1: simple merge.
-	if _, err := Merge(workingDir, filesPaths); err != nil {
-		t.Error("Merge should have worked")
-	}
-
-	load("../../../_tests/configurations/timeout-gotenberg.yml")
-
-	// case 2: uses a command with an unsuitable timeout.
-	if _, err := Merge(workingDir, filesPaths); err == nil {
-		t.Error("Merge should have reached timeout")
-	}
-
-	os.RemoveAll(workingDir)
-}

app/handlers.go

@@ -1,170 +0,0 @@
-// Package app implements all functions on which a request will pass through.
-package app
-
-import (
-	"fmt"
-	"io"
-	"net/http"
-	"os"
-
-	"github.com/thecodingmachine/gotenberg/app/context"
-	"github.com/thecodingmachine/gotenberg/app/converter"
-	ghttp "github.com/thecodingmachine/gotenberg/app/http"
-	"github.com/thecodingmachine/gotenberg/app/logger"
-
-	"github.com/dustin/go-humanize"
-	"github.com/justinas/alice"
-	"github.com/satori/go.uuid"
-)
-
-// GetHandlersChain returns the handlers chaining
-// thanks to the alice library.
-func GetHandlersChain() http.Handler {
-	return alice.New(enforceContentLengthHandler, enforceContentTypeHandler, convertHandler).ThenFunc(serveHandler)
-}
-
-type requestHasNoContentError struct{}
-
-const requestHasNoContentErrorMessage = "request has not content"
-
-func (e *requestHasNoContentError) Error() string {
-	return requestHasNoContentErrorMessage
-}
-
-// enforeContentLengthHandler checks if the request has content.
-func enforceContentLengthHandler(next http.Handler) http.Handler {
-	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		if r.ContentLength == 0 {
-			e := &requestHasNoContentError{}
-			http.Error(w, e.Error(), http.StatusBadRequest)
-			logger.Error(e)
-			return
-		}
-
-		requestID := uuid.NewV4().String()
-		r = context.WithRequestID(r, requestID)
-		logger.Infof("identified new request (%s) with %s", humanize.Bytes(uint64(r.ContentLength)), requestID)
-
-		next.ServeHTTP(w, r)
-	})
-}
-
-// enforceContentTypeHandler checks if the "Content-Type" entry
-// from the request's header matches the allowed content type.
-func enforceContentTypeHandler(next http.Handler) http.Handler {
-	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		if err := ghttp.CheckAuthorizedContentType(r.Header); err != nil {
-			http.Error(w, err.Error(), http.StatusUnsupportedMediaType)
-			logger.Error(err)
-			return
-		}
-
-		next.ServeHTTP(w, r)
-	})
-}
-
-// convertHandler is in charge of converting the file(s) from the request to PDF.
-func convertHandler(next http.Handler) http.Handler {
-	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-		c, err := converter.NewConverter(r)
-		if err != nil {
-			if _, ok := err.(*converter.NoFileToConvertError); ok {
-				http.Error(w, err.Error(), http.StatusBadRequest)
-			} else {
-				http.Error(w, err.Error(), http.StatusInternalServerError)
-			}
-
-			logger.Error(err)
-
-			if c != nil {
-				r = context.WithConverter(r, c)
-				cleanup(r)
-			}
-
-			return
-		}
-
-		r = context.WithConverter(r, c)
-
-		path, err := c.Convert()
-		if err != nil {
-			http.Error(w, err.Error(), http.StatusInternalServerError)
-			logger.Error(err)
-			cleanup(r)
-			return
-		}
-
-		r = context.WithResultFilePath(r, path)
-
-		next.ServeHTTP(w, r)
-	})
-}
-
-// serveHandler simply serves the created PDF.
-func serveHandler(w http.ResponseWriter, r *http.Request) {
-	path, err := context.GetResultFilePath(r)
-	if err != nil {
-		http.Error(w, err.Error(), http.StatusInternalServerError)
-		logger.Error(err)
-		cleanup(r)
-		return
-	}
-
-	reader, err := os.Open(path)
-	if err != nil {
-		http.Error(w, err.Error(), http.StatusInternalServerError)
-		logger.Error(err)
-		cleanup(r)
-		return
-	}
-
-	defer reader.Close()
-
-	resultFileInfo, err := reader.Stat()
-	if err != nil {
-		http.Error(w, err.Error(), http.StatusInternalServerError)
-		logger.Error(err)
-		cleanup(r)
-		return
-	}
-
-	requestID, err := context.GetRequestID(r)
-	if err != nil {
-		logger.Error(err)
-	}
-
-	logger.Debugf("serving result file %s for request %s...", path, requestID)
-
-	done := make(chan error, 1)
-	go func() {
-		w.Header().Set("Content-Disposition", fmt.Sprintf("attachment; filename=\"%s\"", resultFileInfo.Name()))
-		w.Header().Set("Content-Type", "application/pdf")
-		w.Header().Set("Content-Length", fmt.Sprintf("%d", resultFileInfo.Size()))
-		_, err := io.Copy(w, reader)
-
-		done <- err
-	}()
-
-	err = <-done
-	if err != nil {
-		http.Error(w, err.Error(), http.StatusInternalServerError)
-		logger.Error(err)
-	} else {
-		logger.Infof("result file %s (%s) sent for request %s", path, humanize.Bytes(uint64(resultFileInfo.Size())), requestID)
-	}
-
-	cleanup(r)
-}
-
-// cleanup removes all files created during the conversion.
-func cleanup(r *http.Request) {
-	c, err := context.GetConverter(r)
-	if err != nil {
-		logger.Error(err)
-		return
-	}
-
-	if err := c.Clear(); err != nil {
-		logger.Error(err)
-	}
-}

app/handlers_test.go

@@ -1,227 +0,0 @@
-package app
-
-import (
-	"io"
-	"mime/multipart"
-	"net/http"
-	"net/http/httptest"
-	"os"
-	"path/filepath"
-	"testing"
-
-	"github.com/thecodingmachine/gotenberg/app/config"
-	"github.com/thecodingmachine/gotenberg/app/context"
-
-	"github.com/justinas/alice"
-)
-
-func makeRequest(filesPaths ...string) *http.Request {
-	r, w := io.Pipe()
-	mpw := multipart.NewWriter(w)
-
-	go func() {
-		var part io.Writer
-		defer w.Close()
-
-		if len(filesPaths) == 0 {
-			part, _ = mpw.CreateFormField("foo")
-			part.Write([]byte("bar"))
-		} else {
-			for _, filePath := range filesPaths {
-				file, _ := os.Open(filePath)
-				defer file.Close()
-
-				fileInfo, _ := file.Stat()
-				part, _ = mpw.CreateFormFile("files", fileInfo.Name())
-				io.Copy(part, file)
-			}
-		}
-
-		mpw.Close()
-	}()
-
-	req := httptest.NewRequest(http.MethodPost, "/", r)
-	req.Header.Set("Content-Type", mpw.FormDataContentType())
-	return req
-}
-
-func load(configurationFilePath string) {
-	config.Reset()
-	path, _ := filepath.Abs(configurationFilePath)
-	config.ParseFile(path)
-}
-
-func fakeSuccessHandler(w http.ResponseWriter, r *http.Request) {
-	w.WriteHeader(http.StatusOK)
-}
-
-func TestGetHandlersChain(t *testing.T) {
-	// dumb test to improve code coverage...
-	if GetHandlersChain() == nil {
-		t.Errorf("Handler chains should not be nil")
-	}
-}
-
-func TestRequestHasNoContentError(t *testing.T) {
-	err := &requestHasNoContentError{}
-	if err.Error() != requestHasNoContentErrorMessage {
-		t.Errorf("Error returned a wrong message: got '%s' want '%s'", err.Error(), requestHasNoContentErrorMessage)
-	}
-}
-
-func TestEnforceContentLengthHandler(t *testing.T) {
-	var (
-		req *http.Request
-		rr  *httptest.ResponseRecorder
-	)
-
-	h := alice.New(enforceContentLengthHandler).ThenFunc(fakeSuccessHandler)
-
-	// case 1: sends an empty request.
-	req = httptest.NewRequest(http.MethodPost, "/", nil)
-	rr = httptest.NewRecorder()
-	h.ServeHTTP(rr, req)
-	if status := rr.Code; status != http.StatusBadRequest {
-		t.Errorf("Handler returned a wrong status code: got '%v' want '%v'", status, http.StatusBadRequest)
-	}
-
-	// case 2: sends a real body.
-	path, _ := filepath.Abs("../_tests/file.docx")
-	rr = httptest.NewRecorder()
-	h.ServeHTTP(rr, makeRequest(path))
-	if status := rr.Code; status != http.StatusOK {
-		t.Errorf("Handler returned a wrong status code: got '%v' want '%v'", status, http.StatusOK)
-	}
-}
-
-func TestEnforceContentTypeHandler(t *testing.T) {
-	var (
-		req *http.Request
-		rr  *httptest.ResponseRecorder
-	)
-
-	h := alice.New(enforceContentTypeHandler).ThenFunc(fakeSuccessHandler)
-
-	// case 1: sends a wrong content type.
-	req = httptest.NewRequest(http.MethodPost, "/", nil)
-	req.Header.Set("Content-Type", "application/pdf")
-	rr = httptest.NewRecorder()
-	h.ServeHTTP(rr, req)
-	if status := rr.Code; status != http.StatusUnsupportedMediaType {
-		t.Errorf("Handler returned a wrong status code: got '%v' want '%v'", status, http.StatusUnsupportedMediaType)
-	}
-
-	// case 2: sends a good content type.
-	path, _ := filepath.Abs("../_tests/file.docx")
-	rr = httptest.NewRecorder()
-	h.ServeHTTP(rr, makeRequest(path))
-	if status := rr.Code; status != http.StatusOK {
-		t.Errorf("Handler returned wrong a status code: got '%v' want '%v'", status, http.StatusOK)
-	}
-}
-
-func TestConvertHandler(t *testing.T) {
-	var (
-		req   *http.Request
-		rr    *httptest.ResponseRecorder
-		path  string
-		oPath string
-	)
-
-	h := alice.New(convertHandler).ThenFunc(fakeSuccessHandler)
-
-	// case 1: sends a request without body.
-	req = httptest.NewRequest(http.MethodPost, "/", nil)
-	rr = httptest.NewRecorder()
-	h.ServeHTTP(rr, req)
-	if status := rr.Code; status != http.StatusInternalServerError {
-		t.Errorf("Handler returned a wrong status code: got '%v' want '%v'", status, http.StatusInternalServerError)
-	}
-
-	// case 2: sends a request with no file.
-	req = makeRequest()
-	rr = httptest.NewRecorder()
-	h.ServeHTTP(rr, req)
-	if status := rr.Code; status != http.StatusBadRequest {
-		t.Errorf("Handler returned a wrong status code: got '%v' want '%v'", status, http.StatusBadRequest)
-	}
-
-	load("../_tests/configurations/merge-timeout-gotenberg.yml")
-
-	// case 3: sends a request with two files and using an unsuitable timeout for merge commande.
-	path, _ = filepath.Abs("../_tests/file.pdf")
-	oPath, _ = filepath.Abs("../_tests/file.docx")
-	req = makeRequest(path, oPath)
-	rr = httptest.NewRecorder()
-	h.ServeHTTP(rr, req)
-	if status := rr.Code; status != http.StatusInternalServerError {
-		t.Errorf("Handler returned a wrong status code: got '%v' want '%v'", status, http.StatusInternalServerError)
-	}
-
-	load("../_tests/configurations/gotenberg.yml")
-
-	// case 4: sends a request with two files.
-	path, _ = filepath.Abs("../_tests/file.pdf")
-	oPath, _ = filepath.Abs("../_tests/file.docx")
-	req = makeRequest(path, oPath)
-	rr = httptest.NewRecorder()
-	h.ServeHTTP(rr, req)
-	if status := rr.Code; status != http.StatusOK {
-		t.Errorf("Handler returned a wrong status code: got '%v' want '%v'", status, http.StatusOK)
-	}
-
-	// case 5: sends five requests (almost) simultany.
-	path, _ = filepath.Abs("../_tests/file.docx")
-	filesPaths := []string{
-		path,
-		path,
-		path,
-		path,
-		path,
-	}
-
-	for i := 0; i < len(filesPaths); i++ {
-		go func(i int) {
-			req := makeRequest(filesPaths[i])
-			rr := httptest.NewRecorder()
-			h.ServeHTTP(rr, req)
-			if status := rr.Code; status != http.StatusOK {
-				t.Errorf("Handler returned a wrong status code: got '%v' want '%v'", status, http.StatusOK)
-			}
-		}(i)
-	}
-}
-
-func TestServeHandler(t *testing.T) {
-	var (
-		req *http.Request
-		rr  *httptest.ResponseRecorder
-	)
-
-	h := alice.New().ThenFunc(serveHandler)
-
-	// case 1: sends a request without a result file path entry in its context.
-	req = httptest.NewRequest(http.MethodPost, "/", nil)
-	rr = httptest.NewRecorder()
-	h.ServeHTTP(rr, req)
-	if status := rr.Code; status != http.StatusInternalServerError {
-		t.Errorf("Handler returned a wrong status code: got '%v' want '%v'", status, http.StatusInternalServerError)
-	}
-
-	// case 2: sends a request with a wrong result file path entry in its context.
-	req = context.WithResultFilePath(httptest.NewRequest(http.MethodPost, "/", nil), "file")
-	rr = httptest.NewRecorder()
-	h.ServeHTTP(rr, req)
-	if status := rr.Code; status != http.StatusInternalServerError {
-		t.Errorf("Handler returned a wrong status code: got '%v' want '%v'", status, http.StatusInternalServerError)
-	}
-
-	// case 3: sends a request with a correct result file path entry in its context.
-	path, _ := filepath.Abs("../_tests/file.pdf")
-	req = context.WithResultFilePath(httptest.NewRequest(http.MethodPost, "/", nil), path)
-	rr = httptest.NewRecorder()
-	h.ServeHTTP(rr, req)
-	if status := rr.Code; status != http.StatusOK {
-		t.Errorf("Handler returned a wrong status code: got '%v' want '%v'", status, http.StatusOK)
-	}
-}

app/http/http.go

@@ -1,49 +0,0 @@
-// Package http provides functions for detecting a request content type.
-package http
-
-import (
-	"fmt"
-	"net/http"
-	"strings"
-)
-
-// ContentType is a string which represents a content type.
-type ContentType string
-
-// MultipartFormDataContentType represents... the multipart form data content type.
-const MultipartFormDataContentType ContentType = "multipart/form-data"
-
-type notAuthorizedContentTypeError struct{}
-
-const notAuthorizedContentTypeErrorMessage = "accepted value for 'Content-Type': %s"
-
-func (e *notAuthorizedContentTypeError) Error() string {
-	return fmt.Sprintf(notAuthorizedContentTypeErrorMessage, MultipartFormDataContentType)
-}
-
-// CheckAuthorizedContentType checks if the request header header has an authorized content type.
-// If no authorized content type found, throws an error.
-func CheckAuthorizedContentType(h http.Header) error {
-	ct := findContentType(h.Get("Content-Type"), MultipartFormDataContentType)
-	if ct == "" {
-		return &notAuthorizedContentTypeError{}
-	}
-
-	return nil
-}
-
-// findContentType parses a string representing a content type and tries to find
-// one of the given content types.
-func findContentType(requestContentType string, contentTypes ...ContentType) ContentType {
-	for _, ct := range contentTypes {
-		if i := strings.IndexRune(requestContentType, ';'); i != -1 {
-			requestContentType = requestContentType[0:i]
-		}
-
-		if requestContentType == string(ct) {
-			return ct
-		}
-	}
-
-	return ""
-}

app/http/http_test.go

@@ -1,39 +0,0 @@
-package http
-
-import (
-	"fmt"
-	"net/http"
-	"net/http/httptest"
-	"testing"
-)
-
-func TestCheckAuthorizedContentType(t *testing.T) {
-	req := httptest.NewRequest(http.MethodPost, "/", nil)
-
-	// case 1: uses a request without a content type entry in its header.
-	if err := CheckAuthorizedContentType(req.Header); err == nil {
-		t.Error("Function should not have been able to retrieve an authorized content type from request's header")
-	}
-
-	// case 2: uses a request with a content type entry in its header.
-	req.Header.Set("Content-Type", string(MultipartFormDataContentType))
-	if err := CheckAuthorizedContentType(req.Header); err != nil {
-		t.Error("Function should have been able to retrieve an authorized content type from request's header")
-	}
-
-	// case 3: uses a request with a composed content type entry in its header.
-	req.Header.Set("Content-Type", "multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW")
-	if err := CheckAuthorizedContentType(req.Header); err != nil {
-		t.Error("Function should have been able to retrieve an authorized content type from request's header")
-	}
-
-}
-
-func TestNotAuthorizedContentTypeError(t *testing.T) {
-	err := &notAuthorizedContentTypeError{}
-	expected := fmt.Sprintf(notAuthorizedContentTypeErrorMessage, MultipartFormDataContentType)
-
-	if err.Error() != expected {
-		t.Errorf("Error returned a wrong message: got '%s' want '%s'", err.Error(), expected)
-	}
-}

app/logger/logger.go

@@ -1,81 +0,0 @@
-// Package logger implements a simple wrapper of the logrus library.
-package logger
-
-import (
-	"os"
-
-	"github.com/sirupsen/logrus"
-)
-
-// logger wraps a logrus.Logger instance.
-type logger struct {
-	logger *logrus.Logger
-}
-
-// log is our logger instance used across the application.
-var log = newLogger()
-
-// newLogger instantiates a logger instance with default values.
-func newLogger() *logger {
-	l := &logger{logrus.New()}
-	l.logger.Out = os.Stdout
-	l.logger.Level = logrus.InfoLevel
-
-	return l
-}
-
-// SetLevel updates the level of messages which will be logged.
-func SetLevel(level logrus.Level) {
-	log.logger.SetLevel(level)
-}
-
-// SetFormatter updates the output format.
-// When a TTY is not attached, the output will be in the defined format.
-func SetFormatter(formatter logrus.Formatter) {
-	log.logger.Formatter = formatter
-}
-
-// Debug is a wrapper of the logrus Debug function.
-func Debug(message string) {
-	log.logger.Debug(message)
-}
-
-// Debugf is a wrapper of the logrus Debugf function.
-func Debugf(format string, args ...interface{}) {
-	log.logger.Debugf(format, args...)
-}
-
-// Info is a wrapper of the logrus Info function.
-func Info(message string) {
-	log.logger.Info(message)
-}
-
-// Infof is a wrapper of the logrus Infof function.
-func Infof(format string, args ...interface{}) {
-	log.logger.Infof(format, args...)
-}
-
-// Warn is a wrapper of the logrus Warn function.
-func Warn(message string) {
-	log.logger.Warn(message)
-}
-
-// Warnf is wrapper of the logrus Warnf function.
-func Warnf(format string, args ...interface{}) {
-	log.logger.Warnf(format, args...)
-}
-
-// Error is a wrapper of the logrus Error function.
-func Error(err error) {
-	log.logger.Error(err.Error())
-}
-
-// Fatal is a wrapper of the logrus Fatal function.
-func Fatal(err error) {
-	log.logger.Fatal(err.Error())
-}
-
-// Panic is a wrapper of the logrus Panic function.
-func Panic(err error) {
-	log.logger.Panic(err.Error())
-}

build/base/Dockerfile

@@ -0,0 +1,110 @@
+FROM debian:buster-slim
+
+# |--------------------------------------------------------------------------
+# | Common libraries
+# |--------------------------------------------------------------------------
+# |
+# | Libraries used in the build process of this image.
+# |
+
+RUN echo "deb http://httpredir.debian.org/debian/ buster main contrib non-free" > /etc/apt/sources.list &&\
+    apt-get update &&\
+    apt-get install -y curl wget gnupg ttf-mscorefonts-installer procps
+
+# |--------------------------------------------------------------------------
+# | Chrome
+# |--------------------------------------------------------------------------
+# |
+# | Installs Chrome.
+# |
+
+RUN wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | apt-key add - &&\
+    echo "deb http://dl.google.com/linux/chrome/deb/ stable main" | tee /etc/apt/sources.list.d/google-chrome.list &&\
+    apt-get update &&\
+    apt-get -y --allow-unauthenticated install google-chrome-stable
+
+# |--------------------------------------------------------------------------
+# | LibreOffice
+# |--------------------------------------------------------------------------
+# |
+# | Installs LibreOffice.
+# |
+
+# https://github.com/nextcloud/docker/issues/380
+RUN mkdir -p /usr/share/man/man1mkdir -p /usr/share/man/man1 &&\ 
+    echo "deb http://httpredir.debian.org/debian/ buster-backports main contrib non-free" >> /etc/apt/sources.list &&\
+    apt-get update &&\
+    apt-get -t buster-backports -y install libreoffice
+
+# |--------------------------------------------------------------------------
+# | Unoconv
+# |--------------------------------------------------------------------------
+# |
+# | Installs unoconv.
+# |
+
+ENV UNO_URL=https://raw.githubusercontent.com/dagwieers/unoconv/master/unoconv
+
+RUN curl -Ls $UNO_URL -o /usr/bin/unoconv &&\
+    chmod +x /usr/bin/unoconv &&\
+    ln -s /usr/bin/python3 /usr/bin/python &&\
+    unoconv --version
+
+# |--------------------------------------------------------------------------
+# | PDFtk
+# |--------------------------------------------------------------------------
+# |
+# | Installs PDFtk as an alternative to pdfcpu for merging PDFs.
+# | https://github.com/thecodingmachine/gotenberg/issues/29
+# |
+
+RUN apt-get -y install pdftk
+
+# |--------------------------------------------------------------------------
+# | Fonts
+# |--------------------------------------------------------------------------
+# |
+# | Installs a handful of fonts.
+# | Note: ttf-mscorefonts-installer are installed on top of this Dockerfile.
+# |
+
+# Credits: 
+# https://github.com/arachnys/athenapdf/blob/master/cli/Dockerfile
+# https://help.accusoft.com/PrizmDoc/v12.1/HTML/Installing_Asian_Fonts_on_Ubuntu_and_Debian.html
+RUN apt-get install -y \
+    culmus \
+    fonts-beng \
+    fonts-hosny-amiri \
+    fonts-lklug-sinhala \
+    fonts-lohit-guru \
+    fonts-lohit-knda \
+    fonts-samyak-gujr \
+    fonts-samyak-mlym \
+    fonts-samyak-taml \
+    fonts-sarai \
+    fonts-sil-abyssinica \
+    fonts-sil-padauk \
+    fonts-telu \
+    fonts-thai-tlwg \
+    fonts-liberation \
+    ttf-wqy-zenhei \
+    fonts-arphic-uming \
+    fonts-ipafont-mincho \
+    fonts-ipafont-gothic \
+    fonts-unfonts-core
+
+COPY build/base/fonts/* /usr/local/share/fonts/
+COPY build/base/fonts.conf /etc/fonts/conf.d/100-gotenberg.conf
+
+# |--------------------------------------------------------------------------
+# | Default user
+# |--------------------------------------------------------------------------
+# |
+# | All processes in the Docker container will run as a dedicated 
+# | non-root user.
+# |
+
+RUN groupadd --gid 1001 gotenberg \
+  && useradd --uid 1001 --gid gotenberg --shell /bin/bash --home /gotenberg --no-create-home gotenberg \
+  && mkdir /gotenberg \
+  && chown gotenberg: /gotenberg

build/base/fonts.conf

@@ -0,0 +1,29 @@
+<?xml version='1.0'?>
+<!DOCTYPE fontconfig SYSTEM 'fonts.dtd'>
+<fontconfig>
+ <match target="font">
+  <edit mode="assign" name="rgba">
+   <const>rgb</const>
+  </edit>
+ </match>
+ <match target="font">
+  <edit mode="assign" name="hinting">
+   <bool>true</bool>
+  </edit>
+ </match>
+ <match target="font">
+  <edit mode="assign" name="hintstyle">
+   <const>hintslight</const>
+  </edit>
+ </match>
+ <match target="font">
+  <edit mode="assign" name="antialias">
+   <bool>true</bool>
+  </edit>
+ </match>
+  <match target="font">
+    <edit mode="assign" name="lcdfilter">
+      <const>lcddefault</const>
+    </edit>
+  </match>
+</fontconfig>

build/docs/Dockerfile

@@ -0,0 +1,22 @@
+FROM thecodingmachine/gotenberg:workspace
+
+# |--------------------------------------------------------------------------
+# | static
+# |--------------------------------------------------------------------------
+# |
+# | Installs the static site anti-framework – general-purpose library, 
+# | purpose-built commands for various domains.
+# |
+
+RUN go get github.com/apex/static/cmd/static-docs
+
+# |--------------------------------------------------------------------------
+# | Final touch
+# |--------------------------------------------------------------------------
+# |
+# | Last instructions of this build.
+# |
+
+WORKDIR /gotenberg/docs
+
+CMD [ "static-docs", "--in", "build/docs/content", "--out", "docs", "--theme", "gotenberg", "--title", "Gotenberg", "--subtitle", "A Docker-powered stateless API for converting HTML, Markdown and Office documents to PDF." ]

build/docs/content/00-introduction.md

@@ -0,0 +1,10 @@
+---
+title: Introduction
+---
+
+[Gotenberg](https://github.com/thecodingmachine/gotenberg/) is a Docker-powered stateless API for converting HTML, Markdown and Office documents to PDF.
+
+* HTML and Markdown conversions using Google Chrome headless
+* Office conversions (.txt, .rtf, .docx, .doc, .odt, .pptx, .ppt, .odp and so on) using [unoconv](https://github.com/dagwieers/unoconv)
+* Assets: send your header, footer, images, fonts, stylesheets and so on for converting your HTML and Markdown to beaufitul PDFs!
+* Easily interact with the API using our [Go](https://github.com/thecodingmachine/gotenberg-go-client) and [PHP](https://github.com/thecodingmachine/gotenberg-php-client) libraries

build/docs/content/01-install.md

@@ -0,0 +1,51 @@
+---
+title: Install
+---
+
+Gotenberg is shipped within a Docker image.
+
+> It uses a dedicated non-root user called `gotenberg` with uid and gid `1001`.
+
+You may start it with:
+
+```bash
+$ docker run --rm -p 3000:3000 thecodingmachine/gotenberg:6
+```
+
+> The API will be available at [http://localhost:3000](http://localhost:3000).
+
+## Docker Compose
+
+You may also add it in your Docker Compose stack:
+
+```yaml
+version: '3'
+
+services:
+
+  # your others services
+
+  gotenberg:
+    image: thecodingmachine/gotenberg:6
+```
+
+> The API will be available under `gotenberg:3000` in your Docker Compose network.
+
+## Kubernetes
+
+It may also be deployed with Kubernetes.
+
+Make sure to provide enough memory and CPU requests (for instance `512Mi` and `0.2` CPU).
+
+> The more resources are granted, the quicker will be the conversions.
+
+In the deployment specification of the pod, also specify the uid `1001` of the user `gotenberg`:
+
+```
+securityContext:
+  privileged: false
+  runAsUser: 1001
+```
+
+In the following examples, we will assume your
+Gotenberg API is available at [http://localhost:3000](http://localhost:3000).

build/docs/content/02-clients.md

@@ -0,0 +1,25 @@
+---
+title: Clients
+---
+
+We provide clients in various languages for easing the interactions with the API.
+
+## Go client
+
+```bash
+$ go get -u github.com/thecodingmachine/gotenberg-go-client/v6
+```
+
+## PHP client
+
+Unless your project already has a PSR7 `HttpClient`, install `php-http/guzzle6-adapter`:
+
+```bash
+$ composer require php-http/guzzle6-adapter
+```
+
+Then the PHP client:
+
+```bash
+$ composer require thecodingmachine/gotenberg-php-client
+```

build/docs/content/03-environment-variables.md

@@ -0,0 +1,92 @@
+---
+title: Environment variables
+---
+
+You may customize the API behaviour thanks to environment variables.
+
+## Log level
+
+The API provides structured logging allowing you to have relevant information
+about what's going on.
+
+> If a TTY is attached, the log entries are displayed in text format with colors, otherwise in JSON format.
+
+You may customize the severity of the log entries thanks to the environment variable `LOG_LEVEL`.
+
+It accepts one of the following severities: `"DEBUG"`, `"INFO"` (default) and `"ERROR"`.
+
+## Default listen port
+
+By default, the API will listen on port `3000`.
+
+You may customize this value with the environment variable `DEFAULT_LISTEN_PORT`.
+
+This environment variable accepts any string that can be turned into a port number.
+
+## Disable Google Chrome
+
+In order to save some resources, the Gotenberg image accepts the environment variable `DISABLE_GOOGLE_CHROME`
+for disabling Google Chrome.
+
+It takes the strings `"0"` or `"1"` as value where `1` means `true`
+
+> If Google Chrome is disabled, the following conversions will **not** be available anymore:
+> [HTML](#html), [URL](#url) and [Markdown](#markdown)
+
+## Disable LibreOffice (unoconv)
+
+You may also disable LibreOffice (unoconv) with `DISABLE_UNOCONV`.
+
+> If LibreOffice (unoconv) is disabled, the following conversion will **not** be available anymore:
+> [Office](#office)
+
+## Default wait timeout
+
+By default, the API will wait 10 seconds before it considers the conversion to be unsuccessful.
+If unsucessful, it returns a `504` HTTP code.
+
+You may customize this timeout thanks to the environment variable `DEFAULT_WAIT_TIMEOUT`.
+
+It takes a string representation of a float as value (e.g `"2.5"` for 2.5 seconds).
+
+> The default timeout may also be overridden per request thanks to the form field `waitTimeout`.
+> See the [timeout section](#timeout).
+
+## Maximum wait timeout
+
+By default, the value of the form field `waitTimeout` cannot be more than 30 seconds.
+
+You may increase or decrease this limit thanks to the environment variable `MAXIMUM_WAIT_TIMEOUT`.
+
+It takes a string representation of a float as value (e.g `"2.5"` for 2.5 seconds).
+
+## Default webhook URL timeout
+
+By default, the API will wait 10 seconds before it considers the sending of the resulting PDF to be unsuccessful.
+
+> See the [webhook section](#webhook).
+
+You may customize this timeout thanks to the environment variable `DEFAULT_WEBHOOK_URL_TIMEOUT`.
+
+It takes a string representation of a float as value (e.g `"2.5"` for 2.5 seconds).
+
+> The default timeout may also be overridden per request thanks to the form field `webhookURLTimeout`.
+> See the [webhook timeout section](#webhook.timeout).
+
+## Maximum webhook URL timeout
+
+By default, the value of the form field `webhookURLTimeout` cannot be more than 30 seconds.
+
+You may increase or decrease this limit thanks to the environment variable `MAXIMUM_WEBHOOK_URL_TIMEOUT`.
+
+It takes a string representation of a float as value (e.g `"2.5"` for 2.5 seconds).
+
+## Maximum wait delay
+
+By default, the value of the form field `waitDelay` cannot be more than 10 seconds.
+
+> See the [wait delay section](#html.wait_delay).
+
+You may increase or decrease this limit thanks to the environment variable `MAXIMUM_WAIT_DELAY`.
+
+It takes a string representation of a float as value (e.g `"2.5"` for 2.5 seconds).

build/docs/content/04-html.md

@@ -0,0 +1,349 @@
+---
+title: HTML
+---
+
+Gotenberg provides the endpoint `/convert/html` for HTML conversions.
+
+It accepts `POST` requests with a `multipart/form-data` Content-Type.
+
+## Basic
+
+The only requirement is to send a file named `index.html`: it is the file
+which will be converted to PDF.
+
+For instance:
+
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>My PDF</title>
+  </head>
+  <body>
+    <h1>Hello world!</h1>
+  </body>
+</html>
+```
+
+### cURL
+
+```bash
+$ curl --request POST \
+    --url http://localhost:3000/convert/html \
+    --header 'Content-Type: multipart/form-data' \
+    --form files=@index.html \
+    -o result.pdf
+```
+
+### Go
+
+```golang
+import "github.com/thecodingmachine/gotenberg-go-client/v6"
+
+func main() {
+    c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+    req, _ := gotenberg.NewHTMLRequest("index.html")
+    dest := "result.pdf"
+    c.Store(req, dest)
+}
+```
+
+### 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', 'index.html');
+$request = new HTMLRequest($index);
+$dirPath = "/foo";
+$filename = $client->store($request, $dirPath);
+```
+
+## Header and footer
+
+You may also add a header and/or a footer in the resulting PDF.
+Respectively, a file named `header.html` and `footer.html`.
+
+Each of them **has to be a complete HTML document**:
+
+```html
+<html>
+    <head>
+        <style>
+            body {
+                font-size: 8rem;
+                margin: 4rem auto;
+            }
+        </style>
+    </head>
+    <body>
+        <p>
+            <span class="pageNumber"></span> of <span class="totalPages"></span>
+        </p>
+    </body>
+</html>
+```
+
+The following classes allow you to inject printing values:
+
+* `date`: formatted print date
+* `title`: document title
+* `pageNumber`: current page number
+* `totalPage`: total pages in the document
+
+> **Attention:** the CSS properties are independant of the ones used in the `index.html` file.
+> Also, `footer.html` CSS properties override the ones from `header.html`.
+
+For images, the only solution currently is to use a `base64` encoded source:
+
+```html
+<img src="data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUA AAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO 9TXL0Y4OHwAAAABJRU5ErkJggg==" alt="Red dot" />
+```
+
+### cURL
+
+```bash
+$ curl --request POST \
+    --url http://localhost:3000/convert/html \
+    --header 'Content-Type: multipart/form-data' \
+    --form files=@index.html \
+    --form files=@header.html \
+    --form files=@footer.html \
+    -o result.pdf
+```
+
+### Go
+
+```golang
+import "github.com/thecodingmachine/gotenberg-go-client/v6"
+
+func main() {
+    c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+    req, _ := gotenberg.NewHTMLRequest("index.html")
+    req.Header("header.html")
+    req.Footer("footer.html")
+    dest := "result.pdf"
+    c.Store(req, dest)
+}
+```
+
+### 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', 'index.html');
+$header = DocumentFactory::makeFromPath('header.html', 'header.html');
+$footer = DocumentFactory::makeFromPath('footer.html', 'footer.html');
+$request = new HTMLRequest($index);
+$request->setHeader($header);
+$request->setFooter($footer);
+$dirPath = "/foo";
+$filename = $client->store($request, $dirPath);
+```
+
+## Assets
+
+You may also send additional files. For instance: images, fonts, stylesheets and so on.
+
+The only requirement is to make sure that their paths
+are on the same level as the `index.html` file.
+
+In others words, this will work:
+
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>My PDF</title>
+  </head>
+  <body>
+    <h1>Hello world!</h1>
+    <img src="img.png">
+  </body>
+</html>
+```
+
+But this won't:
+
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>My PDF</title>
+  </head>
+  <body>
+    <h1>Hello world!</h1>
+    <img src="/foo/img.png">
+  </body>
+</html>
+```
+
+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).
+
+### cURL
+
+```bash
+$ curl --request POST \
+    --url http://localhost:3000/convert/html \
+    --header 'Content-Type: multipart/form-data' \
+    --form files=@index.html \
+    --form files=@style.css \
+    --form files=@img.png \
+    --form files=@font.woff \
+    -o result.pdf
+```
+
+### Go
+
+```golang
+import "github.com/thecodingmachine/gotenberg-go-client/v6"
+
+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)
+}
+```
+
+### 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', 'index.html');
+$assets = [
+    DocumentFactory::makeFromPath('style.css', 'style.css'),
+    DocumentFactory::makeFromPath('img.png', 'img.png'),
+    DocumentFactory::makeFromPath('font.woff', 'font.woff'),
+];
+$request = new HTMLRequest($index);
+$request->setAssets($assets);
+$dest = "result.pdf";
+$client->store($request, $dest);
+```
+
+## Paper size, margins, orientation
+
+You may also customize the resulting PDF format.
+
+By default, it will be rendered with `A4` size, `1 inch` margins and `portrait` orientation.
+
+> Paper size and margins have to be provided in `inches`. Same for margins.
+
+### cURL
+
+```bash
+$ curl --request POST \
+    --url http://localhost:3000/convert/html \
+    --header 'Content-Type: multipart/form-data' \
+    --form files=@index.html \
+    --form paperWidth=8.27 \
+    --form paperHeight=11.27 \
+    --form marginTop=0 \
+    --form marginBottom=0 \
+    --form marginLeft=0 \
+    --form marginRight=0 \
+    --form landscape=true \
+    -o result.pdf
+```
+
+### Go
+
+```golang
+import "github.com/thecodingmachine/gotenberg-go-client/v6"
+
+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)
+}
+```
+
+### 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', 'index.html');
+$request = new HTMLRequest($index);
+$request->setPaperSize(Request::A4);
+$request->setMargins(Request::NO_MARGINS);
+$request->setLandscape(true);
+$dest = "result.pdf";
+$client->store($request, $dest);
+```
+
+## Wait delay
+
+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.5` for 2.5 seconds).
+
+### cURL
+
+```bash
+$ 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
+```
+
+### Go
+
+```golang
+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)
+}
+```
+
+### 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', 'index.html');
+$request = new HTMLRequest($index);
+$request->setWaitDelay(5.5);
+$dest = "result.pdf";
+$client->store($request, $dest);
+```

build/docs/content/05-url.md

@@ -0,0 +1,56 @@
+---
+title: URL
+---
+
+Gotenberg provides the endpoint `/convert/url` for remote URL conversions.
+
+It accepts `POST` requests with a `multipart/form-data` Content-Type.
+
+## Basic
+
+This endpoint does not accept an `index.html` file nor assets files but a form field
+named `remoteURL` instead. Otherwise, URL conversions work the same as HTML conversions.
+
+> **Attention:** when converting a website to PDF, you should remove all margins.
+> If not, some of the content of the page might be hidden.
+
+### cURL
+
+```bash
+$ curl --request POST \
+    --url http://localhost:3000/convert/url \
+    --header 'Content-Type: multipart/form-data' \
+    --form remoteURL=https://google.com \
+    --form marginTop=0 \
+    --form marginBottom=0 \
+    --form marginLeft=0 \
+    --form marginRight=0 \
+    -o result.pdf
+```
+
+### Go
+
+```golang
+import "github.com/thecodingmachine/gotenberg-go-client/v6"
+
+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)
+}
+```
+
+### 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->setMargins(Request::NO_MARGINS);
+$dest = "result.pdf";
+$client->store($request, $dest);
+```

build/docs/content/06-markdown.md

@@ -0,0 +1,70 @@
+---
+title: Markdown
+---
+
+Gotenberg provides the endpoint `/convert/markdown` for Markdown conversions.
+
+It accepts `POST` requests with a `multipart/form-data` Content-Type.
+
+## Basic
+
+Markdown conversions work the same as HTML conversions.
+
+Only difference is that you have access to the Go template function `toHTML`
+in the file `index.html`. This function will convert a given markdown file to HTML.
+
+For instance:
+
+```html
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>My PDF</title>
+  </head>
+  <body>
+    {{ toHTML .DirPath "file.md" }}
+  </body>
+</html>
+```
+
+### cURL
+
+```bash
+$ curl --request POST \
+    --url http://localhost:3000/convert/markdown \
+    --header 'Content-Type: multipart/form-data' \
+    --form files=@index.html \
+    --form files=@file.md \
+    -o result.pdf
+```
+
+### Go
+
+```golang
+import "github.com/thecodingmachine/gotenberg-go-client/v6"
+
+func main() {
+    c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+    req, _ := gotenberg.NewMarkdownRequest("index.html", "file.md")
+    dest := "result.pdf"
+    c.Store(req, dest)
+}
+```
+
+### PHP
+
+```php
+use TheCodingMachine\Gotenberg\Client;
+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');
+$markdowns = [
+    DocumentFactory::makeFromPath('file.md', 'file.md'),
+];
+$request = new MarkdownRequest($index, $markdowns);
+$dest = "result.pdf";
+$client->store($request, $dest);
+```

build/docs/content/07-office.md

@@ -0,0 +1,117 @@
+---
+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`
+* `.fodt`
+* `.doc`
+* `.docx`
+* `.odt`
+* `.xls`
+* `.xlsx`
+* `.ods`
+* `.ppt`
+* `.pptx`
+* `.odp`
+
+All files will be merged into a single resulting PDF.
+
+> **Attention:** Gotenberg merges the PDF files alphabetically.
+
+### 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-go-client/v6"
+
+func main() {
+    c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+    req, _ := gotenberg.NewOfficeRequest("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);
+$dest = "result.pdf";
+$client->store($request, $dest);
+```
+
+## Orientation
+
+You may also customize the resulting PDF format.
+
+By default, it will be rendered with `portrait` orientation.
+
+### cURL
+
+```bash
+$ curl --request POST \
+    --url http://localhost:3000/convert/office \
+    --header 'Content-Type: multipart/form-data' \
+    --form files=@document.docx \
+    --form landscape=true \
+    -o result.pdf
+```
+
+### Go
+
+```golang
+import "github.com/thecodingmachine/gotenberg-go-client/v6"
+
+func main() {
+    c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+    req, _ := gotenberg.NewOfficeRequest("document.docx")
+    req.Landscape(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->setLandscape(true);
+$dest = "result.pdf";
+$client->store($request, $dest);
+```

build/docs/content/08-merge.md

@@ -0,0 +1,55 @@
+---
+title: Merge
+---
+
+Gotenberg provides the endpoint `/merge` for merging PDFs.
+
+It accepts `POST` requests with a `multipart/form-data` Content-Type.
+
+## Basic
+
+Nothing fancy here: you may send one or more PDF files and the API
+will merge them and return the resulting PDF file.
+
+> **Attention:** Gotenberg merges the PDF files alphabetically.
+
+### cURL
+
+```bash
+$ curl --request POST \
+    --url http://localhost:3000/merge \
+    --header 'Content-Type: multipart/form-data' \
+    --form files=@file.pdf \
+    --form files=@file2.pdf \
+    -o result.pdf
+```
+
+### Go
+
+```golang
+import "github.com/thecodingmachine/gotenberg-go-client/v6"
+
+func main() {
+    c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+    req, _ := gotenberg.NewMergeRequest("file.pdf", "file2.pdf")
+    dest := "result.pdf"
+    c.Store(req, dest)
+}
+```
+
+### PHP
+
+```php
+use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+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'),
+];
+$request = new MergeRequest($files);
+$dest = "result.pdf";
+$client->store($request, $dest);
+```

build/docs/content/09-timeout.md

@@ -0,0 +1,53 @@
+---
+title: Timeout
+---
+
+All endpoints accept a form field named `waitTimeout`.
+
+The API will wait the given **seconds** before it considers the conversion to be unsucessful.
+If unsucessful, it returns a `504` HTTP code.
+
+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_wait_timeout) section.
+
+## Examples
+
+### cURL
+
+```bash
+$ curl --request POST \
+    --url http://localhost:3000/convert/html \
+    --header 'Content-Type: multipart/form-data' \
+    --form files=@index.html \
+    --form waitTimeout=2.5
+```
+
+### Go
+
+```golang
+import "github.com/thecodingmachine/gotenberg-go-client/v6"
+
+func main() {
+    c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+    req, _ := gotenberg.NewHTMLRequest("index.html")
+    req.WaitTimeout(2.5)
+    resp, _ := c.Post(req)
+}
+```
+
+### 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', 'index.html');
+$request = new HTMLRequest($index);
+$request->setWaitTimeout(2.5);
+$dest = "result.pdf";
+$client->store($request, $dest);
+```

build/docs/content/10-webhook.md

@@ -0,0 +1,101 @@
+---
+title: Webhook
+---
+
+All endpoints accept a form field named `webhookURL`.
+
+If provided, the API will send the resulting PDF file in a `POST` request with the `application/pdf` Content-Type
+to given URL.
+
+By doing so, your requests to the API will be over before the conversions are actually done!
+
+## Examples
+
+### cURL
+
+```bash
+$ curl --request POST \
+    --url http://localhost:3000/convert/html \
+    --header 'Content-Type: multipart/form-data' \
+    --form files=@index.html \
+    --form webhookURL='http://myapp.com/webhook/'
+```
+
+### Go
+
+```golang
+import "github.com/thecodingmachine/gotenberg-go-client/v6"
+
+func main() {
+    c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+    req, _ := gotenberg.NewHTMLRequest("index.html")
+    req.WebhookURL("http://myapp.com/webhook/")
+    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', 'index.html');
+$request = new HTMLRequest($index);
+$request->setWebhookURL('http://myapp.com/webhook/');
+$resp = $client->post($request);
+```
+
+## Timeout
+
+If a `webhookURL` is provided, you may also send a form field named `webhookURLTimeout`.
+
+The API will wait the given **seconds** before it considers the sending of the resulting PDF to be unsucessful.
+
+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
+
+```bash
+$ curl --request POST \
+    --url http://localhost:3000/convert/html \
+    --header 'Content-Type: multipart/form-data' \
+    --form files=@index.html \
+    --form webhookURL='http://myapp.com/webhook/' \
+    --form webhookURLTimeout=2.5
+```
+
+#### Go
+
+```golang
+import "github.com/thecodingmachine/gotenberg-go-client/v6"
+
+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)
+}
+```
+
+#### 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', 'index.html');
+$request = new HTMLRequest($index);
+$request->setWebhookURL('http://myapp.com/webhook/');
+$request->setWebhookURLTimeout(2.5);
+$resp = $client->post($request);
+```

build/docs/content/11-result-filename.md

@@ -0,0 +1,50 @@
+---
+title: Result filename
+---
+
+All endpoints accept a form field named `resultFilename`.
+
+If provided, the API will return the resulting PDF file with the given filename.
+Otherwise a random filename is used.
+
+> **Attention:** this feature does not work if the form field `webhookURL` is given.
+
+## Examples
+
+### cURL
+
+```bash
+$ curl --request POST \
+    --url http://localhost:3000/convert/html \
+    --header 'Content-Type: multipart/form-data' \
+    --form files=@index.html \
+    --form resultFilename='foo.pdf'
+```
+
+### Go
+
+```golang
+import "github.com/thecodingmachine/gotenberg-go-client/v6"
+
+func main() {
+    c := &gotenberg.Client{Hostname: "http://localhost:3000"}
+    req, _ := gotenberg.NewHTMLRequest("index.html")
+    req.ResultFilename("foo.pdf")
+    resp, _ := c.Post(req)
+}
+```
+
+### 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', 'index.html');
+$request = new HTMLRequest($index);
+$request->setResultFilename('foo.pdf');
+$resp = $client->post($request);
+```

build/docs/content/12-scalability.md

@@ -0,0 +1,53 @@
+---
+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.
+
+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.
+
+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.
+
+**The more concurrent requests, the more `504` HTTP codes the API will return.**
+
+> See our [load testing use case](../loadtesting) for more details about the API behaviour under heavy load.
+
+## Strategies
+
+### Increase timeout
+
+You may increase the conversion timeout. In other words, you accept that a conversion takes more time
+if the API is under heavy load.
+
+> See [timeout section](#timeout).
+
+### Scaling
+
+The API being stateless, you may scale it as much as you want.
+
+For instance, using the following Docker Compose file:
+
+```yaml
+version: '3'
+
+services:
+
+  # your others services
+
+  gotenberg:
+    image: thecodingmachine/gotenberg:6
+```
+
+You may now launch your services using:
+
+```bash
+$ docker-compose up --scale gotenberg=your_number_of_instances
+```
+
+When requesting the Gotenberg service with your client(s), Docker will automatically
+redirect a request to a Gotenberg container according to the round-robin strategy.

build/docs/content/13-ping.md

@@ -0,0 +1,12 @@
+---
+title: Ping
+---
+
+Gotenberg provides the endpoint `/ping` for checking the API availability with
+a simple `GET` request.
+
+Currently this endpoint does nothing special. A better way to monitor
+Gotenberg would be by checking the memory usage.
+
+Also, as the API uses under the hood intricate programs, you should
+restart your Gotenberg instances from time to time to ensure a nominal behaviour.

build/docs/content/14-fonts.md

@@ -0,0 +1,13 @@
+---
+title: Fonts
+---
+
+By default, a handful of fonts are installed. Asian characters are also supported out of the box.
+
+If you wish to use more fonts, you will have to create your own image:
+
+```Dockerfile
+FROM thecodingmachine/gotenberg:6
+
+RUN apt-get -y install yourfonts
+```

build/docs/content/15-links.md

@@ -0,0 +1,9 @@
+---
+title: Links
+---
+
+* Follow the progress on the [GitHub repository](https://github.com/thecodingmachine/gotenberg)
+* Follow [@gulnap](https://twitter.com/gulnap) on Twitter
+* Thanks to [@mafredri](https://github.com/mafredri) for its help and its wonderful [cdp](https://github.com/mafredri/cdp) library
+
+Psst: TheCodingMachine is always looking for [talented coders](https://coders.thecodingmachine.com).

build/lint/Dockerfile

@@ -0,0 +1,36 @@
+FROM thecodingmachine/gotenberg:workspace
+
+# |--------------------------------------------------------------------------
+# | GolangCI-Lint
+# |--------------------------------------------------------------------------
+# |
+# | Installs GolangCI-Lint, a linters Runner for Go. 5x faster 
+# | than gometalinter.
+# |
+
+ARG GOLANGCI_LINT_VERSION
+
+RUN curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b /usr/local/bin v${GOLANGCI_LINT_VERSION} &&\
+    golangci-lint --version
+
+# |--------------------------------------------------------------------------
+# | Final touch
+# |--------------------------------------------------------------------------
+# |
+# | Last instructions of this build.
+# |
+
+# Define our working directory outside of $GOPATH (we're using go modules).
+USER gotenberg
+WORKDIR /gotenberg/lint
+
+# Install module dependencies.
+COPY --chown=gotenberg:gotenberg go.mod go.sum ./
+
+RUN go mod download &&\
+    go mod verify
+
+# Copy our code source.
+COPY --chown=gotenberg:gotenberg . .
+
+CMD ["golangci-lint", "run" ,"--tests=false", "--enable-all", "--disable=dupl", "--disable=funlen" ]

build/package/Dockerfile

@@ -0,0 +1,62 @@
+# |--------------------------------------------------------------------------
+# | Binary
+# |--------------------------------------------------------------------------
+# |
+# | Buils Gotenberg binary.
+# |
+
+FROM thecodingmachine/gotenberg:workspace AS workspace
+
+ARG VERSION
+
+ENV GOOS=linux \
+    GOARCH=amd64 \
+    CGO_ENABLED=0
+
+# Define our workding outside of $GOPATH (we're using go modules).
+WORKDIR /gotenberg/package
+
+# Install module dependencies.
+COPY go.mod go.sum ./
+
+RUN go mod download &&\
+    go mod verify
+
+# Copy our source code.
+COPY internal ./internal
+COPY cmd ./cmd
+
+# Build our binary.
+RUN go build -o gotenberg -ldflags "-X main.version=${VERSION}" cmd/gotenberg/main.go
+
+FROM thecodingmachine/gotenberg:base
+
+LABEL authors="Julien Neuhart <j.neuhart@thecodingmachine.com>"
+
+# |--------------------------------------------------------------------------
+# | Tini
+# |--------------------------------------------------------------------------
+# |
+# | An helper for reaping zombie processes.
+# |
+
+ARG TINI_VERSION
+
+ADD https://github.com/krallin/tini/releases/download/v${TINI_VERSION}/tini /tini
+RUN chmod +x /tini
+ENTRYPOINT [ "/tini", "--" ]
+
+# |--------------------------------------------------------------------------
+# | Final touch
+# |--------------------------------------------------------------------------
+# |
+# | Last instructions of this build.
+# |
+
+COPY --from=workspace /gotenberg/package/gotenberg /usr/local/bin/
+
+USER gotenberg
+WORKDIR /gotenberg
+
+EXPOSE 3000
+CMD [ "gotenberg" ]

build/tests/Dockerfile

@@ -0,0 +1,16 @@
+FROM thecodingmachine/gotenberg:workspace
+
+# Define our workding outside of $GOPATH (we're using go modules).
+USER gotenberg
+WORKDIR /gotenberg/tests
+
+# Install module dependencies.
+COPY --chown=gotenberg:gotenberg go.mod go.sum ./
+
+RUN go mod download &&\
+    go mod verify
+
+# Copy our code source.
+COPY --chown=gotenberg:gotenberg . .
+
+ENTRYPOINT [ "build/tests/docker-entrypoint.sh" ]

build/tests/docker-entrypoint.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+set -xe
+
+# Make sure the user running the
+# tests is the Gotenberg user.
+CURRENT_USER=$(whoami)
+if [ "$CURRENT_USER" != "gotenberg" ]; then
+    exit 1
+fi
+
+# Start Google Chrome headless.
+go run test/cmd/chrome.go
+
+# Run our tests.
+if [ "$CODE_COVERAGE" = "1" ]; then
+    go test -race -coverprofile=coverage.txt -covermode=atomic ./...
+else
+    go test -race -cover ./...
+fi

build/workspace/Dockerfile

@@ -0,0 +1,52 @@
+ARG GOLANG_VERSION
+
+FROM golang:${GOLANG_VERSION}-stretch as golang
+
+FROM thecodingmachine/gotenberg:base
+
+# |--------------------------------------------------------------------------
+# | Common libraries
+# |--------------------------------------------------------------------------
+# |
+# | Libraries used in the build process of this image.
+# |
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+        git \
+		g++ \
+		gcc \
+		libc6-dev \
+		make \
+		pkg-config \
+	&& rm -rf /var/lib/apt/lists/*
+
+# |--------------------------------------------------------------------------
+# | Golang
+# |--------------------------------------------------------------------------
+# |
+# | Installs Golang.
+# |
+
+COPY --from=golang /usr/local/go /usr/local/go
+
+ENV GOPATH /gotenberg/go
+ENV PATH $GOPATH/bin:/usr/local/go/bin:$PATH
+
+RUN mkdir -p "$GOPATH/src" "$GOPATH/bin" &&\
+    chmod -R 777 "$GOPATH"
+
+# |--------------------------------------------------------------------------
+# | Final touch
+# |--------------------------------------------------------------------------
+# |
+# | Last instructions of this build.
+# |
+
+# Make sure the Gotenber user is able to
+# call the Go binary.
+USER gotenberg
+
+RUN go version &&\
+    go env
+
+USER root

cmd/gotenberg/main.go

@@ -0,0 +1,63 @@
+package main
+
+import (
+	"fmt"
+	"net/http"
+	"os"
+	"os/signal"
+
+	"github.com/thecodingmachine/gotenberg/internal/app/xhttp"
+	"github.com/thecodingmachine/gotenberg/internal/pkg/chrome"
+	"github.com/thecodingmachine/gotenberg/internal/pkg/conf"
+	"github.com/thecodingmachine/gotenberg/internal/pkg/xcontext"
+	"github.com/thecodingmachine/gotenberg/internal/pkg/xlog"
+)
+
+// version will be set on build time.
+// nolint: gochecknoglobals
+var version = "snapshot"
+
+func main() {
+	const op string = "main"
+	config, err := conf.FromEnv()
+	systemLogger := xlog.New(config.LogLevel(), "system")
+	if err != nil {
+		systemLogger.FatalOp(op, err)
+	}
+	systemLogger.InfofOp(op, "Gotenberg %s", version)
+	systemLogger.DebugfOp(op, "configuration: %+v", config)
+	if !config.DisableGoogleChrome() {
+		// start Google Chrome headless.
+		if err := chrome.Start(systemLogger); err != nil {
+			systemLogger.FatalOp(op, err)
+		}
+	}
+	// create our API.
+	srv := xhttp.New(config)
+	// run our API in a goroutine so that it doesn't block.
+	go func() {
+		systemLogger.InfofOp(op, "http server started on port '%d'", config.DefaultListenPort())
+		if err := srv.Start(fmt.Sprintf(":%d", config.DefaultListenPort())); err != nil {
+			if err != http.ErrServerClosed {
+				systemLogger.FatalOp(op, err)
+			}
+		}
+	}()
+	quit := make(chan os.Signal, 1)
+	// we'll accept graceful shutdowns when quit via SIGINT (Ctrl+C)
+	// SIGKILL, SIGQUIT or SIGTERM (Ctrl+/) will not be caught.
+	signal.Notify(quit, os.Interrupt)
+	// block until we receive our signal.
+	<-quit
+	// create a deadline to wait for.
+	ctx, cancel := xcontext.WithTimeout(systemLogger, 120)
+	defer cancel()
+	// doesn't block if no connections, but will otherwise wait
+	// until the timeout deadline.
+	systemLogger.InfoOp(op, "shutting down http server...")
+	if err := srv.Shutdown(ctx); err != nil {
+		systemLogger.FatalOp(op, err)
+	}
+	systemLogger.InfoOp(op, "bye!")
+	os.Exit(0)
+}

docs/theme/gotenberg/css/index.css

@@ -0,0 +1,342 @@
+:root {
+  --ease: cubic-bezier(.82, 0, .12, 1);
+  --width: 800px;
+  --header-height: 400px;
+
+  --tracking: 0.05rem;
+  --tracking-medium: 0.5rem;
+  --tracking-large: 0.8rem;
+
+  --dark: #000;
+  --blue: #33A9FF;
+  --light-gray: #fafafa;
+
+  --bg: #fff;
+  --fg: #868E96;
+  --fg-dark: #212529;
+
+  --selection-bg: var(--blue);
+  --selection-fg: white;
+}
+
+* {
+  box-sizing: border-box;
+}
+
+html, body {
+  font-family: -apple-system, BlinkMacSystemFont,
+    "Segoe UI", "Roboto", "Oxygen",
+    "Ubuntu", "Cantarell", "Fira Sans",
+    "Droid Sans", "Helvetica Neue", sans-serif;
+  -webkit-font-smoothing: antialiased;
+  font-size: 16px;
+  font-weight: 300;
+  background: var(--bg);
+  color: var(--fg-dark);
+  line-height: 1;
+  margin: 0;
+  padding: 0;
+}
+
+::selection {
+  background: var(--selection-bg);
+  color: var(--selection-fg);
+}
+
+h1, h2, h3, h4 {
+  margin-top: 75px;
+  margin-bottom: 0;
+  font-size: 1.2rem;
+  font-weight: 600;
+  line-height: 1.5rem;
+  color: var(--fg-dark);
+}
+
+h1 {
+  margin-top: 0;
+  font-size: 1.5rem;
+}
+
+h1 + p {
+  font-size: 1.5rem;
+  line-height: 1.6;
+}
+
+h3 {
+  font-size: 1.0rem;
+  font-style: italic;
+}
+
+a {
+  color: inherit;
+  text-decoration: none;
+}
+
+p {
+  margin: 25px 0;
+  line-height: 1.6;
+  color: var(--fg-color-light);
+}
+
+li strong,
+p strong {
+  color: var(--fg-dark);
+  font-weight: 500;
+}
+
+li a,
+p a {
+  color: var(--fg-dark);
+  font-weight: 400;
+  padding-bottom: 3px;
+  border-bottom: 1px dotted #ddd;
+}
+
+li a:hover,
+p a:hover {
+  color: var(--blue);
+  border-bottom: none;
+}
+
+p a:hover {
+  border-bottom-color: var(--color);
+}
+
+ul {
+  margin: 50px 0 50px 30px;
+  padding: 0;
+}
+
+ul ul {
+  margin: 10px 0 10px 30px;
+}
+
+ul li {
+  margin: 5px 0;
+  color: var(--fg-color-light);
+  line-height: 1.5em;
+}
+
+ul li strong {
+  color: var(--fg-color);
+  font-weight: 500;
+}
+
+pre {
+  background: var(--light-gray);
+  color: var(--dark);
+  padding: 30px;
+  border-radius: 2px;
+  overflow: auto;
+  font: "Source Code Pro", Menlo, monospace;
+  font-size: .8em;
+  line-height: 1.5em;
+}
+
+blockquote {
+  margin: 0;
+  padding: 0 1em;
+  color: var(--fg-dark);
+  border-left: 0.25em solid var(--dark);
+}
+
+li > code,
+p > code {
+  border: 1px solid #DEE2E6;
+  font-size: 0.75rem;
+  padding: 3px 10px;
+  border-radius: 3px;
+  white-space: nowrap;
+  font-weight: 600;
+  font-family: inherit;
+}
+
+details > summary {
+  cursor: pointer;
+  outline: none;
+  user-select: none;
+}
+
+details > p {
+  border-left: 3px solid var(--dark);
+  padding-left: 15px;
+}
+
+.Wrapper {
+  display: flex;
+  justify-content: center;
+}
+
+.Container {
+  width: var(--width);
+  display: flex;
+  flex-direction: column;
+}
+
+.Content-wrapper {
+  display: flex;
+}
+
+.Header {
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  height: var(--header-height);
+}
+
+.Sidebar {
+  flex: 1 1 auto;
+}
+
+.Content {
+  width: 75%;
+}
+
+.Content img {
+  max-width: 100%;
+}
+
+.Menu {
+  position: -webkit-sticky;
+  position: sticky;
+  top: 50px;
+  color: var(--fg-dark);
+}
+
+.Menu > .item {
+  padding-bottom: 15px;
+}
+
+.Menu > .item > a {
+  position: relative;
+  user-select: none;
+  font-weight: 400;
+  transition: color 200ms;
+  color: var(--fg);
+}
+
+.Menu > .item > a.active {
+  color: var(--fg-dark);
+}
+
+.Menu > .item > a:before {
+  content: "";
+  position: absolute;
+  width: 100%;
+  height: 1px;
+  bottom: -5px;
+  left: 0;
+  background-color: var(--fg-dark);
+  visibility: hidden;
+  transform: scaleX(0);
+  transform-origin: left center;
+  transition: all 250ms var(--ease);
+}
+
+.Menu > .item > a:hover {
+  color: var(--fg-dark);
+}
+
+.Menu > .item > a:hover:before {
+  visibility: visible;
+  transform: scaleX(1);
+}
+
+.Page {
+  margin-top: 100px;
+  padding-top: 50px;
+}
+
+.Page:first-child {
+  margin-top: 0;
+  padding-top: 0;
+}
+
+.Title {
+  margin: 5px 0;
+  line-height: 2.2em;
+}
+
+.Title.center {
+  margin-left: auto;
+  margin-right: auto;
+  text-align: center;
+  max-width: 500px;
+}
+
+.Title.margin {
+  margin-bottom: 80px;
+}
+
+.Title > span {
+  display: block;
+}
+
+.Title .subtext {
+  color: var(--fg-color-light);
+  font-size: 0.8rem;
+  text-transform: uppercase;
+  display: none;
+}
+
+.Title .text {
+  letter-spacing: var(--tracking);
+  text-transform: uppercase;
+  font-weight: bold;
+  font-size: 16px;
+}
+
+.Title.small .text {
+  font-size: 14px;
+  text-transform: none;
+  letter-spacing: normal;
+  line-height: 2rem;
+}
+
+.Anchor {
+  position: relative;
+  margin-left: -14px;
+  opacity: 0.15;
+  display: inline-block;
+  width: 14px;
+  height: 14px;
+}
+
+.Anchor svg {
+  position: absolute;
+  right: 5px;
+  top: 0;
+}
+
+.Anchor svg path {
+  pointer-events: all
+}
+
+.Anchor:hover {
+  opacity: 1;
+}
+
+.Footer {
+  height: 100px;
+}
+
+@media screen and (max-width: 850px) {
+  html, body {
+    --header-height: 300px;
+    --width: 80%;
+    font-size: 14px;
+  }
+
+  .Content-wrapper {
+    display: flex;
+    flex-direction: column;
+  }
+
+  .Sidebar {
+    margin-bottom: 30px;
+  }
+
+  .Content {
+    width: 100%;
+  }
+}

docs/theme/gotenberg/js/index.js

@@ -0,0 +1,46 @@
+/**
+ * Setup.
+ */
+
+const items = document.querySelectorAll('.Page')
+const links = document.querySelectorAll('.Menu a')
+
+/**
+ * Check if `el` is out out of view.
+ */
+
+function isBelowScroll(el) {
+  return el.getBoundingClientRect().bottom > 0
+}
+
+/**
+ * Activate item `i`.
+ */
+
+function activateItem(i) {
+  links.forEach(e => e.classList.remove('active'))
+  links[i].classList.add('active')
+}
+
+/**
+ * Activate the correct menu item for the
+ * contents in the viewport.
+ */
+
+function activate() {
+  let i = 0
+
+  for (; i < items.length; i++) {
+    if (isBelowScroll(items[i])) {
+      break
+    }
+  }
+
+  activateItem(i)
+}
+
+/**
+ * Activate scroll spy thingy.
+ */
+
+window.addEventListener('scroll', e => activate())

docs/theme/gotenberg/views/index.html

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <!-- Global site tag (gtag.js) - Google Analytics -->
+    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-10196481-9"></script>
+    <script>
+      window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+
+      gtag('config', 'UA-10196481-9');
+    </script>
+    <meta charset="utf-8">
+    <meta http-equiv="x-ua-compatible" content="ie=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>{{.Title}} &#183; {{.Subtitle}}</title>
+    <link rel="apple-touch-icon-precomposed" sizes="57x57" href="theme/gotenberg/img/apple-touch-icon-57x57.png" />
+    <link rel="apple-touch-icon-precomposed" sizes="114x114" href="theme/gotenberg/img/apple-touch-icon-114x114.png" />
+    <link rel="apple-touch-icon-precomposed" sizes="72x72" href="theme/gotenberg/img/apple-touch-icon-72x72.png" />
+    <link rel="apple-touch-icon-precomposed" sizes="144x144" href="theme/gotenberg/img/apple-touch-icon-144x144.png" />
+    <link rel="apple-touch-icon-precomposed" sizes="60x60" href="theme/gotenberg/img/apple-touch-icon-60x60.png" />
+    <link rel="apple-touch-icon-precomposed" sizes="120x120" href="theme/gotenberg/img/apple-touch-icon-120x120.png" />
+    <link rel="apple-touch-icon-precomposed" sizes="76x76" href="theme/gotenberg/img/apple-touch-icon-76x76.png" />
+    <link rel="apple-touch-icon-precomposed" sizes="152x152" href="theme/gotenberg/img/apple-touch-icon-152x152.png" />
+    <link rel="icon" type="image/png" href="theme/gotenberg/img/favicon-196x196.png" sizes="196x196" />
+    <link rel="icon" type="image/png" href="theme/gotenberg/img/favicon-96x96.png" sizes="96x96" />
+    <link rel="icon" type="image/png" href="theme/gotenberg/img/favicon-32x32.png" sizes="32x32" />
+    <link rel="icon" type="image/png" href="theme/gotenberg/img/favicon-16x16.png" sizes="16x16" />
+    <link rel="icon" type="image/png" href="theme/gotenberg/img/favicon-128.png" sizes="128x128" />
+    <link rel="stylesheet" href="theme/gotenberg/css/index.css">
+  </head>
+  <body>
+    <div class="Wrapper">
+      <div class="Container">
+        <div class="Header">
+          <div class="Title center">
+            <img src="https://user-images.githubusercontent.com/8983173/50009948-84b01e00-ffb8-11e8-850b-fc240382c626.png" alt="Gotenberg logo" width="250" height="250" />
+            <span class="text">{{.Title}}</span>
+            <span class="subtext">{{.Subtitle}}</span>
+          </div>
+        </div>
+
+        <div class="Content-wrapper">
+          <div class="Sidebar">
+            <div class="Menu">
+              {{range .Pages}}
+                <div class="item">
+                  <a href="#{{.Slug}}">{{.Title}}</a>
+                </div>
+              {{end}}
+            </div>
+          </div>
+
+          <div class="Content">
+            {{range .Pages}}
+              <div class="Page" id="{{.Slug}}">
+                <h1>{{.Title}}</h1>
+                {{.Content}}
+              </div>
+            {{end}}
+            <div class="Footer"></div>
+            <script src="theme/gotenberg/js/index.js"></script>
+          </div>
+        </div>
+    </div>
+  </body>
+</html>

go.mod

@@ -0,0 +1,27 @@
+module github.com/thecodingmachine/gotenberg
+
+go 1.13
+
+require (
+	github.com/dustin/go-humanize v1.0.0
+	github.com/google/go-cmp v0.3.1 // indirect
+	github.com/gorilla/websocket v1.4.1 // indirect
+	github.com/konsorten/go-windows-terminal-sequences v1.0.2 // indirect
+	github.com/kr/pretty v0.1.0 // indirect
+	github.com/labstack/echo/v4 v4.1.10
+	github.com/labstack/gommon v0.3.0
+	github.com/mafredri/cdp v0.24.2
+	github.com/mattn/go-isatty v0.0.9
+	github.com/microcosm-cc/bluemonday v1.0.2
+	github.com/phayes/freeport v0.0.0-20180830031419-95f893ade6f2
+	github.com/russross/blackfriday/v2 v2.0.1
+	github.com/shurcooL/sanitized_anchor_name v1.0.0 // indirect
+	github.com/sirupsen/logrus v1.4.2
+	github.com/stretchr/testify v1.4.0
+	golang.org/x/crypto v0.0.0-20190927123631-a832865fa7ad // indirect
+	golang.org/x/net v0.0.0-20190930134127-c5a3c61f89f3 // indirect
+	golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e
+	golang.org/x/sys v0.0.0-20190927073244-c990c680b611 // indirect
+	golang.org/x/text v0.3.2
+	gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect
+)