Skip to content

Commit 725d06b

Browse files
authored
Merge pull request #532 from yuvipanda/update-openrefine-command
Fix openrefine example commands
2 parents a7cd9da + 61fa4e3 commit 725d06b

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

docs/source/server-process.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ of the argument. For example, if your function is:
236236

237237
```python
238238
def _openrefine_cmd():
239-
return ["openrefine", "-p", "{port}"]
239+
return ["refine", "-p", "{port}"]
240240
```
241241

242242
The `{port}` will be replaced with the appropriate port before
@@ -262,16 +262,18 @@ if we want tighter control over what process is spawned.
262262
```python
263263
c.ServerProxy.servers = {
264264
"openrefine": {
265-
"command": ["refine", "-p", "{port}"]
265+
"command": ["refine", "-p", "{port}", "-H", "*"]
266266
}
267267
}
268268
```
269269

270270
This will start [OpenRefine](https://openrefine.org/) with the
271271
`refine` command (which must be in \$PATH) on a randomly
272272
generated port, and make it available under `/openrefine`
273-
in your notebook url. The URL path is specified by the key,
274-
but this should be made more configurable in the future.
273+
in your notebook url. The URL path is specified by the key.
274+
The `-H *` tells OpenRefine to accept requests with any Host
275+
header, as `jupyter-server-proxy` will be doing auth checks for
276+
it instead.
275277

276278
(server-process:package)=
277279

@@ -289,7 +291,7 @@ above.
289291
```python
290292
def setup_openrefine():
291293
return {
292-
"command": ["refine", "-p", "{port}"]
294+
"command": ["refine", "-p", "{port}", "-H", "*"]
293295
}
294296
```
295297

0 commit comments

Comments
 (0)