@@ -18,7 +18,8 @@ Server Process options
18
18
Server Processes are configured with a dictionary of key value
19
19
pairs.
20
20
21
- #. **command **
21
+ ``command ``
22
+ ^^^^^^^^^^^
22
23
23
24
One of:
24
25
@@ -37,14 +38,16 @@ pairs.
37
38
38
39
This key is required.
39
40
40
- #. **timeout **
41
+ ``timeout ``
42
+ ^^^^^^^^^^^
41
43
42
44
Timeout in seconds for the process to become ready, default ``5 ``.
43
45
44
46
A process is considered 'ready' when it can return a valid HTTP response on the
45
47
port it is supposed to start at.
46
48
47
- #. **environment **
49
+ ``environment ``
50
+ ^^^^^^^^^^^^^^^
48
51
49
52
One of:
50
53
56
59
* A callable that takes any :ref: `callable arguments <server-process/callable-argument >`,
57
60
and returns a dictionary of strings that are used & treated same as above.
58
61
59
- #. **absolute_url **
62
+ ``absolute_url ``
63
+ ^^^^^^^^^^^^^^^^
60
64
61
65
*True * if the URL as seen by the proxied application should be the full URL
62
66
sent by the user. *False * if the URL as seen by the proxied application should
@@ -84,20 +88,23 @@ pairs.
84
88
Defaults to *False *.
85
89
86
90
87
- #. **port **
91
+ ``port ``
92
+ ^^^^^^^^
88
93
89
94
Set the port that the service will listen on. The default is to
90
95
automatically select an unused port.
91
96
92
97
93
- #. **mappath **
98
+ ``mappath ``
99
+ ^^^^^^^^^^^
94
100
95
101
Map request paths to proxied paths.
96
102
Either a dictionary of request paths to proxied paths,
97
103
or a callable that takes parameter ``path `` and returns the proxied path.
98
104
99
105
100
- #. **launcher_entry **
106
+ ``launcher_entry ``
107
+ ^^^^^^^^^^^^^^^^^^
101
108
102
109
A dictionary with options on if / how an entry in the classic Jupyter Notebook
103
110
'New' dropdown or the JupyterLab launcher should be added. It can contain
@@ -115,7 +122,8 @@ pairs.
115
122
Title to be used for the launcher entry. Defaults to the name of the server if missing.
116
123
117
124
118
- #. **new_browser_tab **
125
+ ``new_browser_tab ``
126
+ ^^^^^^^^^^^^^^^^^^^
119
127
120
128
*JupyterLab only * - *True * if the proxied server URL should be opened in a new browser tab.
121
129
*False * (default) if the proxied server URL should be opened in a new JupyterLab tab.
0 commit comments