You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Significant changes have been made to the API for using the server as a Node.js
12
12
13
13
An important note is that the Export Server now requires `Node.js v18.12.0` or a higher version.
14
14
15
-
Additionally, with the v3 release, we transitioned from HTTP to HTTPS for export.highcharts.com, so all requests sent to our public server now must use the HTTPS protocol.
15
+
Additionally, with the v3 release, we transitioned from HTTP to HTTPS for `export.highcharts.com`, so all requests sent to our public server now must use the HTTPS protocol.
16
16
17
17
## Changelog
18
18
@@ -111,6 +111,10 @@ This flexibility is particularly useful for deciding whether global options shou
111
111
112
112
The `singleExport()`, `batchExport()`, and `startExport()` functions must be provided with at least partial options that include one of the following options from the `export` section: `infile`, `instr`, `svg`, or `batch`. Any missing values in the provided options object will automatically default to those specified in the global options object. Unlike other API functions, options provided to the export functions will not be merged into the global options object, as these options represent a specific export process. To make the export options global, you can use the `updateOptions()` function before initiating the export.
113
113
114
+
### Options Setting
115
+
116
+
Essentially, all options can be configured through `.env`, the CLI, and prompts, with one exception: the `HIGHCHARTS_ADMIN_TOKEN`, which is only available as an environment variable.
117
+
114
118
## Default JSON Config
115
119
116
120
The JSON below represents the default configuration stored in the `./lib/schemas/config.js` file. If no `.env` file is found (more details on the file and environment variables below), these options will be used. The configuration is not recommended to be modified directly, as it can typically be managed through other sources.
@@ -932,7 +936,7 @@ The Export Server attaches event listeners to `process.exit`, `uncaughtException
932
936
933
937
Listeners are also attached to handle `uncaught exceptions`. If an exception occurs, the entire pool and browser instance are terminated, and the application is shut down.
934
938
935
-
If you do not want this behavior, start the server with `--listenToProcessExits 0` or `--listenToProcessExits false`.
939
+
If you do not want this behavior, start the server with `--listenToProcessExits false`.
936
940
937
941
Be aware though, that if you disable this and you do not take great care to manually kill the pool of resources along with a browser instance, your server will bleed memory when the app is terminated.
0 commit comments