Manage Jupyter notebook servers

1. Go to Tools | Add Jupyter Connection...

   Alternatively, right-click the project directory and select New | Jupyter connection from the context menu.

2. In the window that opens, click Add Jupyter Connection or press AltInsert.

   

3. Choose the type of server you want to create. For more information on configuring specific servers, refer to Set up a managed server and Set up a configured server.

4. Click Apply if you want the newly created server to be automatically selected for your current notebook.

   Alternatively, click OK to save the changes without selecting the new server.

tip

Added configured servers are shown in the Project View.

1. Click the list of servers on the Jupyter notebook toolbar and select Configure Jupyter Server from the context menu.

   

2. In the window that opens, choose Managed server.

3. In the Name field, set the name for your managed server.

4. Set the server settings using the Command line arguments field.

5. Set Environment variables and assign values to them.

6. Jupyter servers can be secured either with a token (included in the URL) or a user-defined password. If the Jupyter server is secured with a password, enter it in the Password field.

   For more information, refer to Security in the Jupyter notebook server.

7. Click OK to apply the changes and close the window, or click Apply to keep the window open.

note

1. Click the list of servers on the Jupyter notebook toolbar and select Configure Jupyter Server from the context menu.

   

   Alternatively, right-click the server in the Project view Alt01 and select Configure Jupyter Server from the context menu.

2. In the window that opens, choose Configured server.

3. In the Name field, set the name for your remote server.

4. In the Server URL field, specify the address to establish a connection to a remote Jupyter server. The target URL should contain a server name or its address and the access token.

   Alternatively, click Discover local servers to automatically detect available Jupyter instances on the local machine. If a server is found, the URL and token will be filled in automatically.

5. Under Type, select the required server type.

   Notebook/Lab

   Hub

   AWS SageMaker

   Use this option to connect to a standard Jupyter Notebook or JupyterLab instance, running locally or on a remote machine.

   Provide the required authentication token or password.

   

   note

   If you leave the field empty, the token will be extracted from the URI.

   Use this option to connect to a JupyterHub instance.

   Provide one of the following:

   • Your username, password, and the URL of the hub, if authentication is done by using login credentials.

   • Direct URL to a running Jupyter notebook server that includes the access token if token-based authentication is used.

   

   Use this option to connect to an AWS SageMaker instance or another cloud solution.

   No token is required, you can use the presigned URL directly.

   

6. If the server requires a proxy connection, select the Use IDE Proxy checkbox.

   Refer to the HTTP proxy page to configure the corresponding settings.

7. Click Test connection to verify the setup.

8. Click OK to apply the changes and close the window, or click Apply to keep the window open.

When a configured Jupyter server is connected, its files appear in the Project View. You can create, open, edit, and delete files from the remote Jupyter server as if they were part of your local project. For example:

• To add a file, right-click the Remote server directory or a package within it and select New from the context menu. Select the required file type.

  For more information, refer to Create new items.

  

• To delete a file, right-click it in the Remote server directory and select Delete Delete from the context menu.

  

• Go to Settings | Languages & Frameworks | Jupyter | Jupyter Servers.

  In the window that opens, select the server you want to remove and click Remove Configured Server or press Delete.

  

• Alternatively, to remove a remote server, right-click the server in the Project view Alt01 and select Delete Delete from the context menu.

1. Click the list of servers on the Jupyter notebook toolbar and select the server that you want to launch from the context menu.

2. To run a Jupyter server, execute any code cell. When you initiate cell execution, IntelliJ IDEA launches a Jupyter server on the local host using any available port (by default, it is the 8888 port). You can switch to the Jupyter Server tool window to preview the server's configuration details.

Once the server is launched, it is shown as a managed server in the list of the servers in the Jupyter notebook toolbar.

To stop any running server, switch to the Jupyter Server tool window and click Stop Jupyter server. Preview the status in the Server Log window.

Once you have shut down the server, the current session is terminated. When you start the server next time, execution results for all previous sessions and all notebooks will be lost.