Skip to content

Commit d0afda3

Browse files
committed
document configuration setting plotly.io.orca.config.server_url
1 parent 277b9c9 commit d0afda3

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

doc/python/orca-management.md

+1
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,7 @@ If this happens, follow the instructions in the error message and specify the fu
193193
### Other Configuration Settings
194194
In addition to the `executable` property, the `plotly.io.orca.config` object can also be used to configure the following options:
195195

196+
- **`server_url`**: The URL to an externally running instance of Orca. When this is set, plotly.py will not launch an orca server process and instead use the one provided.
196197
- **`port`**: The specific port to use to communicate with the orca server, or `None` if the port will be chosen automatically.
197198
- **`timeout`**: The number of seconds of inactivity required before the orca server is shut down. For example, if timeout is set to 20, then the orca server will shutdown once is has not been used for at least 20 seconds. If timeout is set to `None` (the defualt), then the server will not be automatically shut down due to inactivity.
198199
- **`default_width`**: The default pixel width to use on image export.

0 commit comments

Comments
 (0)