Skip to content

Commit c9daa2e

Browse files
authored
Lint and add reference to plans for a better solution
1 parent e9a3816 commit c9daa2e

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -164,25 +164,28 @@ Use of a python `virtualenv` or a conda env is also recommended.
164164
or permanently by setting `c.Completer.use_jedi = False` in your
165165
[`ipython_config.py` file](https://ipython.readthedocs.io/en/stable/config/intro.html?highlight=ipython_config.py#systemwide-configuration).
166166

167-
1. (Linux/OSX-only) As a security measure Jupyter limits file access to the Jupyter root
168-
directory (the place where you launch the Jupyter server). Thus, in order to
169-
allow `jupyterlab-lsp` to navigate to external files such as packages
167+
1. (Optional, Linux/OSX-only) As a security measure by default Jupyter serve only allows
168+
access to files under the Jupyter root directory (the place where you launch the Jupyter server).
169+
Thus, in order to allow `jupyterlab-lsp` to navigate to external files such as packages
170170
installed system-wide or to libraries inside a virtual environment (`conda`,
171-
`pip`, ...) this access control mechanism needs to be circumvented: Inside your Jupyter
172-
root directory create a symlink named *.lsp_symlink* pointing to your system root */*.
171+
`pip`, ...) this access control mechanism needs to be circumvented: inside your Jupyter
172+
root directory create a symlink named _.lsp_symlink_ pointing to your system root `/`.
173173

174174
```
175175
ln -s / .lsp_symlink
176176
```
177177

178178
As this symlink is a hidden file the Jupyter server must be instructed to
179-
serve hidden files. Either use the appropriate commandline flag:
179+
serve hidden files. Either use the appropriate command line flag:
180180

181181
```
182182
jupyter lab --ContentsManager.allow_hidden=True
183183
```
184184

185-
or, alternatively, set the corresponding setting inside your *jupyter_server_config.py*.
185+
or, alternatively, set the corresponding setting inside your `jupyter_server_config.py`.
186+
187+
Help in implementing a custom [`ContentsManager`](https://github.com/jupyter-lsp/jupyterlab-lsp/issues/850)
188+
which will enable navigating to external files without the symlink is welcome.
186189

187190
### Configuring the servers
188191

0 commit comments

Comments
 (0)