Skip to content

Commit d3ee450

Browse files
committed
simplify README
1 parent 704e2e2 commit d3ee450

File tree

1 file changed

+2
-47
lines changed

1 file changed

+2
-47
lines changed

registry/coder/modules/jupyterlab/README.md

Lines changed: 2 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -25,56 +25,11 @@ module "jupyterlab" {
2525

2626
You can customize JupyterLab server settings by providing a JSON configuration:
2727

28-
```tf
29-
module "jupyterlab" {
30-
count = data.coder_workspace.me.start_count
31-
source = "registry.coder.com/coder/jupyterlab/coder"
32-
version = "1.1.1"
33-
agent_id = coder_agent.example.id
34-
config = {
35-
ServerApp = {
36-
port = 8888
37-
token = ""
38-
password = ""
39-
allow_origin = "*"
40-
base_url = "/lab"
41-
}
42-
}
43-
}
44-
```
45-
4628
The `config` parameter accepts a map of configuration settings that will be written to `~/.jupyter/jupyter_server_config.json` before JupyterLab starts. This allows you to configure any JupyterLab server settings according to the [JupyterLab configuration documentation](https://jupyter-server.readthedocs.io/en/latest/users/configuration.html).
4729

48-
### Common Configuration Examples
30+
### Frame Embedding Configuration
4931

50-
**Disable authentication:**
51-
```tf
52-
config = {
53-
ServerApp = {
54-
token = ""
55-
password = ""
56-
}
57-
}
58-
```
59-
60-
**Set custom port and allow all origins:**
61-
```tf
62-
config = {
63-
ServerApp = {
64-
port = 9999
65-
allow_origin = "*"
66-
}
67-
}
68-
```
69-
70-
**Configure notebook directory:**
71-
```tf
72-
config = {
73-
ServerApp = {
74-
root_dir = "/workspace/notebooks"
75-
}
76-
}
77-
```
32+
To allow JupyterLab to be embedded in Coder's iframe:
7833

7934
**Set Content-Security-Policy for iframe embedding in Coder:**
8035
```tf

0 commit comments

Comments
 (0)