Skip to content

docs: add chromium-max-concurrency and update changed default for chromium-restart-after #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TomBrouws wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add chromium-max-concurrency and update changed default for chromium-restart-after #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ The following flags allow you to configure the API module:
The Chromium module interacts with the Chromium browser to convert HTML documents to PDF.

A single Chromium browser manages the conversions in a stateful mode, enabling quicker single conversions.
However, due to a lock mechanism, a Chromium browser cannot execute parallel operations.
A Chromium browser can handle up to 6 parallel operations.

During periods of heavy load, incoming requests will accumulate in the queue until they are processed, time out, or the
queue reaches its maximum capacity. In the latter case, the request will be terminated prematurely.
Expand All @@ -107,8 +107,9 @@ The following flags allow you to configure the Chromium module:

| Flag | Environment variable | Description | Default |
|-------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|
| <span class="badge badge--secondary">--chromium-restart-after</span> | <span class="badge badge--secondary">CHROMIUM_RESTART_AFTER</span> | Number of conversions after which Chromium will automatically restart. Set to 0 to disable this feature. | 10<span style={{color: 'red'}}>*</span> |
| <span class="badge badge--secondary">--chromium-restart-after</span> | <span class="badge badge--secondary">CHROMIUM_RESTART_AFTER</span> | Number of conversions after which Chromium will automatically restart. Set to 0 to disable this feature. | 100<span style={{color: 'red'}}>*</span> |
| <span class="badge badge--secondary">--chromium-max-queue-size</span> | <span class="badge badge--secondary">CHROMIUM_MAX_QUEUE_SIZE</span> | Maximum request queue size for Chromium. Set to 0 to disable this feature. | 0 |
| <span class="badge badge--secondary">--chromium-max-concurrency</span> | <span class="badge badge--secondary">CHROMIUM_MAX_CONCURRENCY</span> | Maximum number of concurrent conversions. Chromium supports up to 6. | 6 |
| <span class="badge badge--secondary">--chromium-auto-start</span> | <span class="badge badge--secondary">CHROMIUM_AUTO_START</span> | Automatically launch Chromium upon initialization if set to true; otherwise, Chromium will start at the time of the first conversion. | false |
| <span class="badge badge--secondary">--chromium-start-timeout</span> | <span class="badge badge--secondary">CHROMIUM_START_TIMEOUT</span> | Maximum duration to wait for Chromium to start or restart. | 20s |
| <span class="badge badge--secondary">--chromium-allow-file-access-from-files</span> | <span class="badge badge--secondary">CHROMIUM_ALLOW_FILE_ACCESS_FROM_FILES</span> | Allow file:// URIs to read other file:// URIs. | false |
Expand Down