Docker中Jupyter Lab的--ip=0.0.0.0参数不生效问题求助

问题 #

已在/etc/jupyter/jupyter_server_config.py中配置c.ServerApp.ip = "0.0.0.0"，启动命令也添加了--ip="0.0.0.0"，执行命令为：

jupyter lab --ip="0.0.0.0" --debug --config=dir=/etc/jupyter

但Jupyter Lab始终仅运行在127.0.0.1而非0.0.0.0。该Docker镜像将用于JupyterHub，但在Hub中问题依旧，由于代理无法访问127.0.0.1，需解决Jupyter Lab绑定0.0.0.0的问题。

启动日志如下：

jovyan@ac08ae367d58:~$ jupyter lab --ip="0.0.0.0" --debug --config=dir=/etc/jupyter                                                                                                                                                                                            
[D 2022-09-22 23:25:57.952 ServerApp] Searching ['/home/jovyan', '/home/jovyan/.jupyter', '/home/jovyan/.local/etc/jupyter', '/usr/local/etc/jupyter', '/etc/jupyter'] for config files                                                                                        
[D 2022-09-22 23:25:57.952 ServerApp] Looking for jupyter_config in /etc/jupyter                                                                                                                                                                                               
[D 2022-09-22 23:25:57.952 ServerApp] Looking for jupyter_config in /usr/local/etc/jupyter                                                                                                                                                                                     
[D 2022-09-22 23:25:57.952 ServerApp] Looking for jupyter_config in /home/jovyan/.local/etc/jupyter                                                                                                                                                                            
[D 2022-09-22 23:25:57.953 ServerApp] Looking for jupyter_config in /home/jovyan/.jupyter                                                                                                                                                                                      
[D 2022-09-22 23:25:57.953 ServerApp] Looking for jupyter_config in /home/jovyan                                                                                                                                                                                               
[D 2022-09-22 23:25:57.955 ServerApp] Looking for jupyter in dir=/etc                                                                                                                                                                                                          
[D 2022-09-22 23:25:57.958 ServerApp] Paths used for configuration of jupyter_server_config:                                                                                                                                                                                   
        /etc/jupyter/jupyter_server_config.json                                                                                                                                                                                                                                
[D 2022-09-22 23:25:57.958 ServerApp] Paths used for configuration of jupyter_server_config:                                                                                                                                                                                   
        /usr/local/etc/jupyter/jupyter_server_config.d/jupyterlab.json                                                                                                                                                                                                         
        /usr/local/etc/jupyter/jupyter_server_config.d/nbclassic.json                                                                                                                                                                                                          
        /usr/local/etc/jupyter/jupyter_server_config.d/notebook_shim.json
        /usr/local/etc/jupyter/jupyter_server_config.json
[D 2022-09-22 23:25:57.959 ServerApp] Paths used for configuration of jupyter_server_config: 
        /home/jovyan/.local/etc/jupyter/jupyter_server_config.json
[D 2022-09-22 23:25:57.960 ServerApp] Paths used for configuration of jupyter_server_config: 
        /home/jovyan/.jupyter/jupyter_server_config.json
[D 2022-09-22 23:25:57.960 ServerApp] Paths used for configuration of jupyter_server_config: 
        /home/jovyan/jupyter_server_config.json
[D 2022-09-22 23:25:57.977 LabApp] Config changed: {'NotebookApp': {}, 'ServerApp': {'ip': '0.0.0.0', 'config_file': 'dir=/etc/jupyter', 'log_level': 'DEBUG', 'jpserver_extensions': <LazyConfigValue {'update': {'nbclassic': True, 'notebook_shim': True}}>, 'ExtensionApp'
: {'log_level': 'DEBUG'}}
[I 2022-09-22 23:25:57.978 ServerApp] jupyterlab | extension was successfully linked.
[D 2022-09-22 23:25:57.990 NotebookApp] Config changed: {'NotebookApp': {}, 'ServerApp': {'ip': '0.0.0.0', 'config_file': 'dir=/etc/jupyter', 'log_level': 'DEBUG', 'jpserver_extensions': <LazyConfigValue value={'jupyterlab': True, 'nbclassic': True, 'notebook_shim': True
}>, 'ExtensionApp': {'log_level': 'DEBUG'}}
[I 2022-09-22 23:25:57.991 ServerApp] nbclassic | extension was successfully linked.
[D 2022-09-22 23:25:58.260 ServerApp] Paths used for configuration of jupyter_notebook_config: 
        /home/jovyan/.jupyter/jupyter_notebook_config.json
[D 2022-09-22 23:25:58.261 ServerApp] Paths used for configuration of jupyter_notebook_config: 
        /etc/jupyter/jupyter_notebook_config.json
[D 2022-09-22 23:25:58.261 ServerApp] Paths used for configuration of jupyter_notebook_config: 
        /usr/local/etc/jupyter/jupyter_notebook_config.d/jupyterlab.json
        /usr/local/etc/jupyter/jupyter_notebook_config.json
[D 2022-09-22 23:25:58.262 ServerApp] Paths used for configuration of jupyter_notebook_config: 
        /home/jovyan/.local/etc/jupyter/jupyter_notebook_config.json
[D 2022-09-22 23:25:58.263 ServerApp] Paths used for configuration of jupyter_notebook_config: 
        /home/jovyan/.jupyter/jupyter_notebook_config.json
[I 2022-09-22 23:25:58.263 ServerApp] notebook_shim | extension was successfully linked.
[D 2022-09-22 23:25:58.265 ServerApp] Config changed: {'ExtensionApp': {'log_level': 'DEBUG'}, 'NotebookApp': {}, 'ServerApp': {'ip': '0.0.0.0', 'config_file': 'dir=/etc/jupyter', 'log_level': 'DEBUG', 'jpserver_extensions': <LazyConfigValue value={'jupyterlab': True, 'nbclassic': True, 'notebook_shim': True}>}}
[I 2022-09-22 23:25:58.282 ServerApp] notebook_shim | extension was successfully loaded.
[I 2022-09-22 23:25:58.283 LabApp] JupyterLab extension loaded from /usr/local/lib/python3.10/site-packages/jupyterlab
[I 2022-09-22 23:25:58.283 LabApp] JupyterLab application directory is /usr/local/share/jupyter/lab
[I 2022-09-22 23:25:58.286 ServerApp] jupyterlab | extension was successfully loaded.
[I 2022-09-22 23:25:58.289 ServerApp] nbclassic | extension was successfully loaded.
[I 2022-09-22 23:25:58.290 ServerApp] Serving notebooks from local directory: /home/jovyan
[I 2022-09-22 23:25:58.290 ServerApp] Jupyter Server 1.18.1 is running at:
[I 2022-09-22 23:25:58.290 ServerApp] http://ac08ae367d58:8888/lab?token=e2e2ac0e0ccf1f2c0a72b5d625e2f1ba3ada18d3bc177df5
[I 2022-09-22 23:25:58.290 ServerApp]  or http://127.0.0.1:8888/lab?token=e2e2ac0e0ccf1f2c0a72b5d625e2f1ba3ada18d3bc177df5
[I 2022-09-22 23:25:58.290 ServerApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).
[W 2022-09-22 23:25:58.295 ServerApp] No web browser found: could not locate runnable browser.
[C 2022-09-22 23:25:58.295 ServerApp] 
    
    To access the server, open this file in a browser:
        file:///home/jovyan/.local/share/jupyter/runtime/jpserver-252-open.html
    Or copy and paste one of these URLs:
        http://ac08ae367d58:8888/lab?token=e2e2ac0e0ccf1f2c0a72b5d625e2f1ba3ada18d3bc177df5
     or http://127.0.0.1:8888/lab?token=e2e2ac0e0ccf1f2c0a72b5d625e2f1ba3ada18d3bc177df5
[D 2022-09-22 23:26:03.300 ServerApp] 200 GET /api (127.0.0.1) 0.84ms
^C[I 2022-09-22 23:26:07.953 ServerApp] interrupted
Serving notebooks from local directory: /home/jovyan
0 active kernels
Jupyter Server 1.18.1 is running at:
http://ac08ae367d58:8888/lab?token=e2e2ac0e0ccf1f2c0a72b5d625e2f1ba3ada18d3bc177df5
 or http://127.0.0.1:8888/lab?token=e2e2ac0e0ccf1f2c0a72b5d625e2f1ba3ada18d3bc177df5

解决方案 #

1. 修正启动命令的配置目录参数 #

你当前使用的--config=dir=/etc/jupyter参数有误，--config用于指定单个配置文件，指定配置目录需用--config-dir。正确启动命令：

jupyter lab --ip="0.0.0.0" --debug --config-dir=/etc/jupyter

2. 处理JSON配置文件的覆盖问题 #

从日志可见，Jupyter优先加载了/etc/jupyter/jupyter_server_config.json，其优先级高于Python配置文件，若该JSON中设置了ServerApp.ip会覆盖.py文件的配置：

• 查看JSON内容：

  cat /etc/jupyter/jupyter_server_config.json
  

• 若存在"ip": "127.0.0.1"，修改为"ip": "0.0.0.0"；若无该条目，添加如下内容：

  {
    "ServerApp": {
      "ip": "0.0.0.0"
    }
  }
  

3. 排查其他配置文件干扰 #

检查/usr/local/etc/jupyter目录下的配置文件（如jupyter_server_config.json、jupyter_server_config.d下的文件），确认是否有ServerApp.ip被设为127.0.0.1，如有则修改或注释该配置。

4. 验证实际监听地址 #

启动Jupyter Lab后，用以下命令检查实际监听的地址：

netstat -tulpn | grep 8888
# 若netstat未安装，用ss命令
ss -tulpn | grep 8888

若输出显示0.0.0.0:8888，说明已成功绑定所有接口。日志中http://ac08ae367d58:8888是容器主机名对应的访问地址，并非仅绑定容器内部IP，此时代理可正常访问。

5. JupyterHub环境额外配置 #

若在JupyterHub中使用，需确保Spawner配置指定正确ip参数。在JupyterHub配置文件中添加：

c.Spawner.args = ['--ip=0.0.0.0']

或通过环境变量传递：

c.Spawner.env = {'JUPYTER_SERVER_IP': '0.0.0.0'}

内容的提问来源于stack exchange，提问作者jinserk