How to Publish a Jupyter Notebook to Connect

This guide walks you through creating and publishing a new Jupyter Notebook to Posit Connect.


Before you begin, you must:

For more information about requesting permission to publish your content, please see the Publishing section of the User Guide.

Step 1. Install the Jupyter Notebook extension

First, you need to install the rsconnect-jupyter package for the Jupyter Notebook that enables you to publish Jupyter Notebooks to Connect.


Depending on your environment, root permissions are usually required for system-wide installations which might be necessary to install the rsconnect-jupyter extension. For example, the --sys-prefix flag needs write permissions to the Python installation path.

To do this, the commands might need to be run as root or prefixed with sudo. For example:

sudo pip install rsconnect_jupyter

  • Open a new terminal window and run:

    pip install rsconnect_jupyter
  • Now, we need to enable the Jupyter Notebook extension:

    jupyter-nbextension install --sys-prefix --py rsconnect_jupyter
    jupyter-nbextension enable --sys-prefix --py rsconnect_jupyter
    jupyter-serverextension enable --sys-prefix --py rsconnect_jupyter
  • To verify that the installation was successful, run:

    jupyter notebook
  • If the Jupyter Notebook interface doesn’t automatically display in your browser, then copy and paste the URL(s) provided in the output of your terminal.

Step 2. Create a new Jupyter Notebook

We are going to create a sample notebook to publish to Connect.

  • Open your browser window displaying the main Jupyter Notebook interface, if applicable.

  • At the top of the page, click New, then select Python 3.

    An image of the New drop-down menu

  • Click the title field.

    The title field is located at the top of the page and to the right of the jupyter logo

  • In the Rename Notebook window, give your notebook a name, then click Rename.

    The Rename Notebook window is shown and it also highlights the Rename button

  • In the cell, copy and paste the following:

    import pandas as pd
    dF = pd.read_csv(
        names=["sl", "sw", "pl", "pw", "class"])
  • Press Shift + Enter. The first five rows of the dataset display.

    An image displaying the first five rows of the dataset

  • In the new cell, type:

    import matplotlib
    %matplotlib inline
    dF.plot(x="sl", y="sw", kind="scatter")
  • Press Shift + Enter. A scatter plot displays.

    An image displaying the example scatter plot

Step 3. Connect Jupyter Notebook to your Connect Server


This is a one-time configuration step that is required to publish Jupyter Notebooks to Connect.

To publish our notebook to Connect, we need to generate an API Key.

  • Navigate and log into Connect.

  • Click your username or profile icon.

    The icon is located in the upper-right corner of your browser page on the Connect navigation/menu bar

  • Click API Keys.

    Once you click your profile, a Profile menu displays. The API Keys option is located under the first option, which is Profile

  • Click + New API Key.

    The NEW API Key button is located on the right side of the page

  • Enter a name for your API Key, then click OK.

    The OK button is on the lower-right side of the window

  • To copy your API Key, click Copy.

    The Copy button is located under the API Key

Step 4. Publish to Connect

  • Return to your Jupyter Notebook that you wish to publish.

  • Click Publish, then select Publish to Connect.

    The button is located on the right side of the menu-button bar

  • Add your Connect Server:

    • In the Server Address field, enter the public URL used to access Connect.

    • In the API Key field, paste the API Key that you generated in Connect.

    • In the Server Name field, type a name for your server.

    • If you require an option other than the default Use System TLS Certificates option, then select one of the Secure Connection Settings.

    • Click Add Server.

      This is a screen capture of the Add Connect Server

  • In the Publish to Connect window, do the following:

    • In the Publish to field, confirm that your Connect Server Address (the public URL) is correct.

    • Optionally, update the title of your Jupyter Notebook that will display in Connect.

    • Leave the default option for Publish Source Code selected.

    • Click Publish.

      This is an image of the Publish to Connect menu

  • Select the radio button for your notebook and click Next.

    The button is located on the left side of the page and the Next button is located on the lower-right side of the window

  • Click Publish.

    The button is located on the lower-right side of the window

  • At the top of the interface, click the Successfully published content button.

    The button is on the right-side of the menu bar

A Connect browser window opens and displays your published Jupyter Notebook.


Your Jupyter Notebook is running Python code because we have reconstructed the Python environment in Connect.

Here is an example of a Jupyter Notebook that was published to Connect:

A screen capture of the notebook that was
published to Connect