Skip to content

Commit f3bbbae

Browse files
committed
pre-commit: run all hooks
1 parent b619add commit f3bbbae

File tree

3 files changed

+21
-20
lines changed

3 files changed

+21
-20
lines changed

docs/source/arbitrary-ports-hosts.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,11 @@ For security reasons the host must match an entry in the `host_allowlist` in you
2020

2121
## With JupyterHub
2222

23-
Let's say you are using a JupyterHub set up on a remote machine,
24-
and you have a process running on that machine listening on port
25-
8080. If your hub URL is `myhub.org`, each user can
26-
access the service running on port 8080 with the URL
27-
`myhub.org/hub/user-redirect/proxy/8080`. The `user-redirect`
28-
will make sure that:
23+
Let's say you are using a JupyterHub set up on a remote machine, and you have a
24+
process running on that machine listening on port 8080. If your hub URL is
25+
`myhub.org`, each user can access the service running on port 8080 with the URL
26+
`myhub.org/hub/user-redirect/proxy/8080`. The `user-redirect` will make sure
27+
that:
2928

3029
1. It provides a redirect to the correct URL for the particular
3130
user who is logged in.
@@ -55,12 +54,12 @@ interface (nbextension), you can construct the URL for accessing
5554
your service in this way:
5655

5756
```js
58-
define(['base/js/utils'], function(utils) {
57+
define(["base/js/utils"], function (utils) {
5958
// Get base URL of current notebook server
60-
var base_url = utils.get_body_data('baseUrl');
59+
var base_url = utils.get_body_data("baseUrl");
6160

6261
// Construct URL of our proxied service
63-
var service_url = base_url + 'proxy/' + port;
62+
var service_url = base_url + "proxy/" + port;
6463

6564
// Do stuff with your service_url
6665
});
@@ -75,13 +74,13 @@ Accessing your service from a JupyterLab extension is similar to
7574
accessing it from a classic notebook extension.
7675

7776
```typescript
78-
import { PageConfig } from '@jupyterlab/coreutils';
77+
import { PageConfig } from "@jupyterlab/coreutils";
7978

8079
// Get base URL of current notebook server
81-
let base_url = PageConfig.getBaseUrl()
80+
let base_url = PageConfig.getBaseUrl();
8281

8382
// Construct URL of our proxied service
84-
let service_url = base_url + 'proxy/' + port;
83+
let service_url = base_url + "proxy/" + port;
8584

8685
// Do stuff with your service_url
8786
```

docs/source/launchers.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ is **not** launched every time you click an item - if the process
1414
is already running, it is reused.
1515

1616
```{image} _static/images/nbextension-tree.png
17+
1718
```
1819

1920
## JupyterLab Launcher Extension
@@ -29,6 +30,7 @@ This should provide icons for each registered process in the main
2930
JupyterLab launcher
3031

3132
```{image} _static/images/labextension-launcher.png
33+
3234
```
3335

3436
Clicking on them will open the application in a new window.

docs/source/server-process.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ One of:
5858

5959
### `absolute_url`
6060

61-
*True* if the URL as seen by the proxied application should be the full URL
62-
sent by the user. *False* if the URL as seen by the proxied application should
61+
_True_ if the URL as seen by the proxied application should be the full URL
62+
sent by the user. _False_ if the URL as seen by the proxied application should
6363
see the URL after the parts specific to jupyter-server-proxy have been stripped.
6464

6565
For example, with the following config:
@@ -81,7 +81,7 @@ as a request for `/test-server/some-url` instead - without any stripping.
8181

8282
This is very useful with applications that require a `base_url` to be set.
8383

84-
Defaults to *False*.
84+
Defaults to _False_.
8585

8686
### `port`
8787

@@ -93,7 +93,7 @@ automatically select an unused port.
9393
### `unix_socket`
9494

9595
This option uses a Unix socket on a filesystem path, instead of a TCP
96-
port. It can be passed as a string specifying the socket path, or *True* for
96+
port. It can be passed as a string specifying the socket path, or _True_ for
9797
Jupyter Server Proxy to create a temporary directory to hold the socket,
9898
ensuring that only the user running Jupyter can connect to it.
9999

@@ -129,16 +129,16 @@ the following keys:
129129

130130
### `new_browser_tab`
131131

132-
*JupyterLab only* - *True* if the proxied server URL should be opened in a new browser tab.
133-
*False* (default) if the proxied server URL should be opened in a new JupyterLab tab.
132+
_JupyterLab only_ - _True_ if the proxied server URL should be opened in a new browser tab.
133+
_False_ (default) if the proxied server URL should be opened in a new JupyterLab tab.
134134

135-
If *False*, the proxied server needs to allow its pages to be rendered in an iframe. This
135+
If _False_, the proxied server needs to allow its pages to be rendered in an iframe. This
136136
is generally done by configuring the web server `X-Frame-Options` to `SAMEORIGIN`.
137137
For more information, refer to
138138
[MDN Web docs on X-Frame-Options](https://developer.mozilla.org/docs/Web/HTTP/Headers/X-Frame-Options).
139139

140140
Note that applications might use a different terminology to refer to frame options.
141-
For example, RStudio uses the term *frame origin* and require the flag
141+
For example, RStudio uses the term _frame origin_ and require the flag
142142
`--www-frame-origin=same` to allow rendering of its pages in an iframe.
143143

144144
### `request_headers_override`

0 commit comments

Comments
 (0)