Debian 12にJupyterLabをインストールするためのガイド

Jupyterは、インタラクティブなコンピューティングとデータサイエンスのための無料でオープンソースのWebアプリケーションです。Jupyterはすべてのプログラミング言語をサポートし、JupyterLabのような複数のソフトウェアを提供します。JupyterLabは、機能豊富でタブ付きのマルチノートブック編集環境を提供し、Notebookは軽量で簡素化されたノートブック作成を提供し、Qtconsoleなどもあります。

このガイドでは、Debian 12にJupyterLabをステップバイステップでインストールする方法を説明します。Python仮想環境にJupyterLabをインストールし、systemdサービスとしてJupyterLabを実行し、その後、JupyterLabのリバースプロキシとしてNginxをインストールして設定します。

前提条件

開始する前に、次のことを確認してください：

• Debian 12サーバー。
• 管理者権限を持つ非ルートユーザー。

依存関係のインストール

Jupyterは、すべてのプログラミング言語でインタラクティブなコンピューティングのための無料でオープンソースのPythonソフトウェアのエコシステムです。Jupyterをインストールするには、システムにPythonがインストールされていることを確認する必要があります。

このセクションでは、Jupyterのためのパッケージ依存関係をインストールします。これには、Python3、Pipパッケージマネージャ、Python venv仮想環境、およびNode.jsが含まれます。

始める前に、次のコマンドを使用してDebianパッケージインデックスを更新およびリフレッシュします。

sudo apt update

次に、以下のapt installコマンドを実行して依存関係をインストールします。これにより、Python3、Pipパッケージマネージャ、venv仮想環境管理、およびNode.jsがインストールされます。

sudo apt install python3 python3-pip python3-venv nodejs

yと入力して、インストールを確認し、続行します。

依存関係がインストールされたら、次のコマンドを実行して、Python3、Pip、およびNode.jsを含む各依存関係のバージョンを確認します。

python3 --version  
pip3 --version  
ode --version

以下の出力は、Python 3.11、Pip 23、およびNode.js 18.13がインストールされていることを示しています。

Jupyterのインストール

依存関係をインストールした後、次にDebian 12マシンのPython仮想環境を使用してJupyterメタパッケージをインストールします。そのためには、次のことを完了する必要があります：

• Python仮想環境の作成
• Jupyterのインストール
• JupyterLabの設定

始めましょう。

Python仮想環境の作成

このセクションでは、Jupyterのインストールに使用される新しいPython仮想環境を作成します。このシナリオでは、システム全体に影響を与えない隔離された開発環境を持つことができます。また、時間が経つにつれてこれを再作成することもできます。

次のコマンドを使用して非ルートユーザーにログインします。

su - user

次に、新しいディレクトリ~/projectを作成し、その中に移動します。そして、次のコマンドを使用してvenvという名前の新しい仮想環境を作成します。コマンドを実行すると、新しいディレクトリvenvが作成されます。

mkdir -p ~/project; cd ~/project  
python3 -m venv venv

次に、次のコマンドを実行してvenv仮想環境をアクティブにします。アクティブになると、シェルプロンプトは「 (venv) user@hostname:#… 」のようになります。

source venv/bin/activate

Jupyterのインストール

Python仮想環境を作成した後、Pipを介してJupyterパッケージをインストールします。Jupyterパッケージは、IPython、JupyterLab、Jupyter Server、Jupyter Notebook、qtconsoleなどを含むJupyterエコシステムのメタパッケージです。

以下のpip3コマンドを実行して、JupyterをDebianシステムにインストールします。

pip3 install jupyter

インストール中、以下の出力がターミナルに表示されます：

インストールが完了したら、次のコマンドを使用してJupyterバイナリファイルの場所とバージョンを確認します。

which jupyter  
jupyter --version

次の出力では、Jupyterバイナリファイルがvenvディレクトリ内にあることがわかります。また、システムにインストールされているJupyterパッケージのバージョンも表示されます。

JupyterLabの設定

JupyterLabは、Jupyterエコシステムの次世代Webベースのユーザーインターフェースです。JupyterLabを使用すると、Jupyter Notebook、テキストエディタ、ターミナルなどのドキュメントやアクティビティを1つのウィンドウで操作できます。JupyterLabは、Jupyterプロジェクトの管理と開発のためのIDEのような体験を提供します。

このセクションでは、JupyterプロジェクトのためにJupyterLabを設定します。しかし、その前に、インストールを保護するために最初にJupyter Serverを設定する必要があります。

最初に、次のコマンドを実行してJupyter Serverの設定ファイルを生成し、パスワードを設定します。パスワードを入力し、再度入力します。

jupyter server --generate-config  
jupyter server password

コマンドを実行すると、Jupyter Serverの設定が~/.jupyter/ディレクトリに生成されます。

次のコマンドを使用してJupyter Serverの設定内容を確認できます。

jupyter server --show-config

以下のような出力が表示されます：

次に、次のコマンドを実行してJupyterLabの新しい設定を生成します。JupyterLabの設定は~/.jupyter/ディレクトリに生成されます。

jupyter lab --generate-config

設定が生成されたら、次のコマンドを使用してJupyterLabの設定を確認します。

jupyter lab --show-config

以下はJupyterLab設定の例です：

次に、次のコマンドを使用してJupyterLabのインストールを実行できます。必ずIPアドレスをサーバーのIPアドレスに変更してください。

jupyter lab --ip 192.168.10.15

JupyterLabは、デフォルトのポート8888でサーバーのIPアドレスで実行されます。JupyterLabはURLパス/labを介してアクセス可能です。

Webブラウザを開き、サーバーのIPアドレスにポート8888とパス/labを続けて訪問します。例えば、http://192.168.10.15:8888/lab。Jupyter Serverのパスワードを入力し、ログインをクリックして続行します。

正しいパスワードがあれば、以下のようなJupyterLabユーザーダッシュボードが表示されます：

これで、Ctrl+cを2回押してJupyterLabプロセスを終了できます。

JupyterLabをSystemdサービスとして実行する

次のステップでは、JupyterLabを実行するために使用される新しいsystemdサービスファイルを作成します。この方法で、JupyterLabのインストールはバックグラウンドでsystemdサービスとして実行され、systemctlユーティリティを介してJupyterLabを簡単に管理できます。

次のnanoエディタコマンドを使用して新しいsystemdサービスファイル/etc/systemd/system/jupyterlab.serviceを作成します。

sudo nano /etc/systemd/system/jupyterlab.service

次の設定を挿入し、ユーザー名bobを変更してください。

[Unit]  
Description=JupyterLab Service  
  
[Service]  
Type=simple  
PIDFile=/run/jupyter.pid  
ExecStart=/home/bob/project/venv/bin/jupyter lab --config=/home/bob/.jupyter/jupyter_lab_config.py  
User=bob  
Group=bob  
WorkingDirectory=/home/bob/project  
Restart=always  
RestartSec=10  
  
[Install]  
WantedBy=multi-user.target

完了したら、ファイルを保存して閉じます。

次に、以下のsystemctlコマンドを実行してsystemdマネージャをリロードし、変更を適用します。

sudo systemctl daemon-reload

次に、以下のコマンドを使用してjupyterlabサービスを開始および有効にします。

sudo systemctl start jupyterlab  
sudo systemctl enable jupyterlab

最後に、jupyterlabサービスを確認して、サービスが実行中であることを確認します。

sudo systemctl status jupyterlab

以下の出力は、jupyterlabサービスが実行中であることを確認します。

JupyterのリバースプロキシとしてNginxを設定する

このガイドでは、Nginxをリバースプロキシとして使用してJupyterLabを実行します。それを達成するためには、次のことを完了する必要があります：

• JupyterLabへのリモートアクセスを許可する
• Nginxをリバースプロキシとしてインストールおよび設定する

JupyterLabへのリモートアクセスを許可する

デフォルトでは、JupyterLabのインストールはローカルIPアドレスを介してのみアクセス可能です。リモート接続を許可するには、デフォルトのJupyterLab設定を変更する必要があります。

次のnanoエディタコマンドを使用してJupyterLab設定~/.jupyter/jupyter_lab_config.pyを開きます。

nano ~/.jupyter/jupyter_lab_config.py

オプションc.ServerApp.allow_remote_accessのコメントを解除し、値をTrueに変更します。これにより、JupyterLabはリモート接続からアクセス可能になり、リバースプロキシの背後でJupyterLabを実行できます。

c.ServerApp.allow_remote_access = True

ファイルを保存して、完了したらエディタを終了します。

次に、以下のsystemctlコマンドを実行してjupyterlabサービスを再起動し、変更を適用します。

sudo systemctl restart jupyterlab

次に、以下のコマンドを使用してjupyterlabサービスを確認します。

sudo systemctl status jupyterlab

出力の下部には、JupyterLabインストールにアクセスするための生成されたトークンが表示されるはずです。次のセクションのためにそれをコピーしてください。

Nginxをリバースプロキシとしてインストールおよび設定する

JupyterLabへのリモートアクセスを許可した後、次にNginxをインストールし、JupyterLabインストールのリバースプロキシとして設定します。

以下のapt installコマンドを実行してNginxをインストールします。

sudo apt install nginx -y

以下はNginxインストール中の出力です。

Nginxがインストールされたら、次のnanoエディタを使用して新しいサーバーブロック設定/etc/nginx/sites-available/jupyterlabを作成します。

sudo nano /etc/nginx/sites-available/jupyterlab

次の設定を挿入し、server_nameオプション内のドメイン名を変更してください。

server {  
    listen 80;  
    server_name jupyterlab.howtoforge.local;  
      
    access_log /var/log/nginx/howtoforge.local.access.log;  
    error_log /var/log/nginx/howtoforge.local.error.log;  
   
    location / {  
        proxy_pass http://127.0.0.1:8888;  
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;  
        proxy_set_header X-Real-IP $remote_addr;  
        proxy_set_header Host $http_host;  
        proxy_http_version 1.1;  
        proxy_redirect off;  
        proxy_buffering off;  
        proxy_set_header Upgrade $http_upgrade;  
        proxy_set_header Connection "upgrade";  
        proxy_read_timeout 86400;  
    }  
}

完了したら、ファイルを保存して終了します。

次に、以下のコマンドを実行してサーバーブロックファイル/etc/nginx/sites-available/jupyterlabを有効にし、Nginx設定を確認します。

sudo ln -s /etc/nginx/sites-available/jupyterlab /etc/nginx/sites-enabled/  
sudo nginx -t

Nginxの構文が正しければ、「 syntax is ok - test is successful 」という出力が得られるはずです。

最後に、以下のsystemctlコマンドを実行してnginxサービスを再起動し、変更を適用します。その後、サービスが実行中であることを確認します。

sudo systemctl restart nginx  
sudo systemctl status nginx

Nginxが実行中であれば、出力はactive (running)となります。

ローカルマシンからJupyterLabインストールにアクセスする

ドメイン名を介してJupyterLabにアクセスするには、Linuxクライアントの場合は/etc/hostsファイルを、Windowsユーザーの場合はC:\Windows\System32\drivers\etc\hostsファイルを利用できます。

Linuxクライアントで/etc/hostsファイルをnanoエディタで開きます。

sudo nano /etc/hosts

ファイルに次の設定を挿入し、IPアドレスとドメイン名を自分の情報に変更してください。

192.168.10.15   jupyterlab.howtoforge.local

完了したら、ファイルを保存して終了します。

次に、Webブラウザを開き、JupyterLabインストールのドメイン名にアクセスします。例えば、http://jupyterlab.howtoforge.local。インストールが成功していれば、JupyterLabのログインページが表示されるはずです。

ページの下部に、JupyterLabインストールのために生成された新しいパスワードを入力します。次に、ログインして新しいパスワードを設定ボタンをクリックします。

すべてがうまくいけば、以下のようなJupyterLabダッシュボードにリダイレクトされるはずです。

これで、JupyterLabのインストールが完了しました。

結論

このステップバイステップのガイドを完了することで、Debian 12サーバーにJupyterLabをインストールすることができました。Python仮想環境を使用してJupyterLabをインストールし、バックグラウンドでsystemdサービスとしてJupyterLabを実行し、JupyterLabのリバースプロキシとしてNginxを設定しました。これで、Jupyterプロジェクトを作成および管理できます。