mirror of
https://github.com/gotenberg/gotenberg.git
synced 2026-08-18 13:12:17 +01:00
keep working on README
This commit is contained in:
@@ -62,9 +62,9 @@ There are two use cases:
|
|||||||
* If you send one file, it will convert it and return the resulting PDF
|
* 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
|
* If many files, it will convert them to PDF, merge the resulting PDFs into a single PDF and return it
|
||||||
|
|
||||||
### Examples
|
### Examples:
|
||||||
|
|
||||||
* One file:
|
* One file
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$ curl --request POST \
|
$ curl --request POST \
|
||||||
@@ -75,7 +75,7 @@ $ curl --request POST \
|
|||||||
> result.pdf
|
> result.pdf
|
||||||
```
|
```
|
||||||
|
|
||||||
* Many files:
|
* Many files
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$ curl --request POST \
|
$ curl --request POST \
|
||||||
@@ -108,33 +108,18 @@ version: '3'
|
|||||||
|
|
||||||
services:
|
services:
|
||||||
|
|
||||||
# your other services
|
|
||||||
|
|
||||||
gotenberg-proxy:
|
|
||||||
# Traefik is a powerful HTTP reverse proxy which allows us to do some load-balancing.
|
|
||||||
# It provides various methods of load-balancing which are not described here.
|
|
||||||
# More information: https://traefik.io/
|
|
||||||
image: traefik:1.5-alpine
|
|
||||||
command: --docker --logLevel=DEBUG
|
|
||||||
volumes:
|
|
||||||
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
||||||
|
|
||||||
gotenberg:
|
gotenberg:
|
||||||
image: gotenberg:1.0.0
|
image: gotenberg:1.0.0
|
||||||
labels:
|
|
||||||
- traefik.backend=gotenberg
|
|
||||||
- traefik.frontend.rule=Host:gotenberg.yourdomain.com
|
|
||||||
- traefik.port=3000
|
|
||||||
```
|
```
|
||||||
|
|
||||||
You may now launch your services using:
|
You may now launch your services using:
|
||||||
|
|
||||||
```sh
|
```bash
|
||||||
docker-compose up --scale gotenberg=your_number_of_instances
|
docker-compose up --scale gotenberg=your_number_of_instances
|
||||||
```
|
```
|
||||||
|
|
||||||
When requesting `gotenberg.yourdomain.com` with your client(s), Traefik will automatically redirect a request to a Gotenberg container
|
When requesting `gotenberg.yourdomain.com` with your client(s), Docker will automatically redirect a request to a Gotenberg container
|
||||||
according to the load-balancing strategy you have defined.
|
according to the round-robin strategy.
|
||||||
|
|
||||||
## Custom implementation
|
## Custom implementation
|
||||||
|
|
||||||
|
|||||||
27
README.md
27
README.md
@@ -62,9 +62,9 @@ There are two use cases:
|
|||||||
* If you send one file, it will convert it and return the resulting PDF
|
* 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
|
* If many files, it will convert them to PDF, merge the resulting PDFs into a single PDF and return it
|
||||||
|
|
||||||
### Examples
|
### Examples:
|
||||||
|
|
||||||
* One file:
|
* One file
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$ curl --request POST \
|
$ curl --request POST \
|
||||||
@@ -75,7 +75,7 @@ $ curl --request POST \
|
|||||||
> result.pdf
|
> result.pdf
|
||||||
```
|
```
|
||||||
|
|
||||||
* Many files:
|
* Many files
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$ curl --request POST \
|
$ curl --request POST \
|
||||||
@@ -108,33 +108,18 @@ version: '3'
|
|||||||
|
|
||||||
services:
|
services:
|
||||||
|
|
||||||
# your other services
|
|
||||||
|
|
||||||
gotenberg-proxy:
|
|
||||||
# Traefik is a powerful HTTP reverse proxy which allows us to do some load-balancing.
|
|
||||||
# It provides various methods of load-balancing which are not described here.
|
|
||||||
# More information: https://traefik.io/
|
|
||||||
image: traefik:1.5-alpine
|
|
||||||
command: --docker --logLevel=DEBUG
|
|
||||||
volumes:
|
|
||||||
- /var/run/docker.sock:/var/run/docker.sock:ro
|
|
||||||
|
|
||||||
gotenberg:
|
gotenberg:
|
||||||
image: gotenberg:1.0.0
|
image: gotenberg:1.0.0
|
||||||
labels:
|
|
||||||
- traefik.backend=gotenberg
|
|
||||||
- traefik.frontend.rule=Host:gotenberg.yourdomain.com
|
|
||||||
- traefik.port=3000
|
|
||||||
```
|
```
|
||||||
|
|
||||||
You may now launch your services using:
|
You may now launch your services using:
|
||||||
|
|
||||||
```sh
|
```bash
|
||||||
docker-compose up --scale gotenberg=your_number_of_instances
|
docker-compose up --scale gotenberg=your_number_of_instances
|
||||||
```
|
```
|
||||||
|
|
||||||
When requesting `gotenberg.yourdomain.com` with your client(s), Traefik will automatically redirect a request to a Gotenberg container
|
When requesting `gotenberg.yourdomain.com` with your client(s), Docker will automatically redirect a request to a Gotenberg container
|
||||||
according to the load-balancing strategy you have defined.
|
according to the round-robin strategy.
|
||||||
|
|
||||||
## Custom implementation
|
## Custom implementation
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user