Ubuntu18.04でJupyterLab環境をセットアップする方法

著者は、 Write for DOnations プログラムの一環として、国連財団を選択して寄付を受け取りました。

序章

JupyterLab は、機能が豊富なUIであり、特にデータサイエンスとAIの分野で、ユーザーがタスクを簡単に実行できるようにします。 JupyterLab環境は、 JupyterNotebookの生産性を重視した再設計を提供します。組み込みのHTMLビューアやCSVビューアなどのツールと、JupyterNotebookのいくつかの個別の機能を同じ画面に統合する機能を紹介します。

このチュートリアルでは、Ubuntu18.04サーバーにJupyterLabをインストールしてセットアップします。また、ドメイン名を使用して、任意のWebブラウザーからリモートでJupyterLabインスタンスに安全に接続できるようにサーバーを構成します。

前提条件

このチュートリアルを完了するには、次のものが必要です。

この初期サーバーセットアップガイドを使用して、sudo権限を持つ非rootユーザーアカウントを持つUbuntu18.04サーバー。
サーバーへのPythonAnacondaディストリビューションのインストール。 Ubuntu18.04チュートリアルにAnacondaPythonディストリビューションをインストールする方法を使用できます。
DNSレコードを編集するためにアクセスできる登録済みドメイン名またはサブドメイン。このチュートリアルでは、全体を通してyour_domainを使用します。 Namecheap でドメインを購入するか、 Freenom で無料ドメインを取得するか、任意のレジストラに新しいドメインを登録できます。
ドメインに設定されている次のDNSレコード：サーバーのパブリックIPアドレスを指すyour_domainを持つAレコード。サーバーのパブリックIPアドレスを指すwww.your_domainを含むAレコード。このDNSレコードの作成、編集、および削除の方法に関するドキュメントは、これらのレコードの設定に役立ちます。

ステップ1—パスワードの設定

このステップでは、JupyterLabインストールでパスワードを設定します。インスタンスは一般公開されているため、パスワードを設定しておくことが重要です。

まず、Anaconda環境がアクティブ化されていることを確認します。前提条件のチュートリアルに従って、環境はbaseと呼ばれます。

環境をアクティブ化するには、次のコマンドを使用します。

conda activate base

プロンプトは、デフォルトのAnaconda環境baseを反映するようにターミナルで変更されます。

sammy@your_server:~$

このチュートリアルの今後のすべてのコマンドは、base環境内で実行されます。

Anaconda環境をアクティブにすると、サーバーでJupyterLabのパスワードを設定する準備が整います。

まず、Jupyterの構成ファイルを生成しましょう。

jupyter notebook --generate-config

次の出力が表示されます。

OutputWriting default config to: /home/sammy/.jupyter/jupyter_notebook_config.py

JupyterLabとJupyterNotebookの両方が同じ構成ファイルを共有します。

次に、次のコマンドを使用して、JupyterLabインスタンスにリモートでアクセスするためのパスワードを設定します。

jupyter notebook password

Jupyterは、選択したパスワードを入力するように求めます。

OutputEnter password:
Verify password:
[NotebookPasswordApp] Wrote hashed password to /home/sammy/.jupyter/jupyter_notebook_config.json

Jupyterは、パスワードをハッシュ形式で/home/sammy/.jupyter/jupyter_notebook_config.jsonに保存します。将来、このハッシュ値が必要になります。

最後に、前のコマンドで生成されたファイルに対してcatコマンドを使用して、ハッシュされたパスワードを表示します。

cat /home/sammy/.jupyter/jupyter_notebook_config.json

次のような出力が表示されます。

/home/sammy/.jupyter/jupyter_notebook_config.json

{
  "NotebookApp": {
    "password": "sha1:your_hashed_password"
  }
}

JSONのpasswordキーの値をコピーして、一時的に保存します。

JupyterLabインスタンスのパスワードを設定しました。次のステップでは、サーバーのLet'sEncrypt証明書を作成します。

ステップ2—Let'sEncryptの構成

このステップでは、ドメインのLet'sEncrypt証明書を作成します。これにより、ブラウザからJupyterLab環境にアクセスするときにデータが保護されます。

まず、Certbotをサーバーにインストールします。リポジトリをaptソースに追加することから始めます。

sudo add-apt-repository ppa:certbot/certbot

コマンドを実行すると、ENTERを押してPPAの追加を完了するように求められます。

OutputThis is the PPA for packages prepared by Debian Let's Encrypt Team and backported for Ubuntu.

Note: Packages are only provided for currently supported Ubuntu releases.
 More info: https://launchpad.net/~certbot/+archive/ubuntu/certbot
Press [ENTER] to continue or Ctrl-c to cancel adding it.

ENTERを押して、PPAの追加を続行します。

コマンドの実行が終了したら、apt updateコマンドを使用してaptソースを更新します。

sudo apt update

次に、Certbotをインストールします。

sudo apt install certbot

Certbotの実行を開始してインスタンスの証明書を生成する前に、サーバーのポート:80とポート:443でのアクセスを許可して、Certbotがこれらのポートを使用してドメイン名を確認できるようにします。。ポート:80はサーバーへのhttp要求に対してチェックされ、ポート:443はhttps要求に対して使用されます。 Certbotは最初にhttpリクエストを作成し、サーバーの証明書を取得した後、httpsリクエストを作成します。これは、ポート:443を介してプロセスにプロキシされます。 :80ポートでリッスンしています。これにより、証明書のインストールが成功したことが確認されます。

まず、ポート:80へのアクセスを許可します。

sudo ufw allow 80

次の出力が表示されます。

OutputRule added
Rule added (v6)

次に、ポート:443へのアクセスを許可します。

sudo ufw allow 443

OutputRule added
Rule added (v6)

最後に、Certbotを実行して、次のコマンドを使用してインスタンスの証明書を生成します。

sudo certbot certonly --standalone

standaloneフラグは、certbotに、検証プロセスの間、一時サーバーを実行するように指示します。

メールの入力を求められます。

OutputSaving debug log to /var/log/letsencrypt/letsencrypt.log
Plugins selected: Authenticator standalone, Installer None
Enter email address (used for urgent renewal and security notices) (Enter 'c' to
cancel): your_email

有効なメールアドレスを入力して、ENTERを押します。

次に、CertbotとLet'sEncryptの利用規約を確認して同意するように求められます。利用規約を確認し、同意する場合はAと入力して、ENTERを押します。

Output- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Please read the Terms of Service at
https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf. You must
agree in order to register with the ACME server at
https://acme-v02.api.letsencrypt.org/directory
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
(A)gree/(C)ancel: A

これで、電子メールをElectronicFrontierFoundationと共有するように求められます。答えを入力してENTERを押します。

Output- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Would you be willing to share your email address with the Electronic Frontier
Foundation, a founding partner of the Let's Encrypt project and the non-profit
organization that develops Certbot? We'd like to send you email about our work
encrypting the web, EFF news, campaigns, and ways to support digital freedom.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
(Y)es/(N)o: Y/N

最後に、ドメイン名の入力を求められます。プロトコルを指定せずにドメイン名を入力します。

OutputPlease enter in your domain name(s) (comma and/or space separated)  (Enter 'c'
to cancel): your_domain
Obtaining a new certificate
Performing the following challenges:
http-01 challenge for your_domain
Waiting for verification...
Cleaning up challenges

IMPORTANT NOTES:
 - Congratulations! Your certificate and chain have been saved at:
   /etc/letsencrypt/live/your_domain/fullchain.pem
   Your key file has been saved at:
   /etc/letsencrypt/live/your_domain/privkey.pem
   Your cert will expire on 2020-09-28. To obtain a new or tweaked
   version of this certificate in the future, simply run certbot
   again. To non-interactively renew *all* of your certificates, run
   "certbot renew"
 - Your account credentials have been saved in your Certbot
   configuration directory at /etc/letsencrypt. You should make a
   secure backup of this folder now. This configuration directory will
   also contain certificates and private keys obtained by Certbot so
   making regular backups of this folder is ideal.
 - If you like Certbot, please consider supporting our work by:

   Donating to ISRG / Let's Encrypt:   https://letsencrypt.org/donate
   Donating to EFF:                    https://eff.org/donate-le

Certbotはドメイン検証を実行し、ドメインの証明書とキーを生成して/etc/letsencrypt/live/your_domainに保存します。

Let's Encrypt証明書を設定したので、JupyterLab構成ファイルを更新します。

ステップ3—JupyterLabの構成

このステップでは、JupyterLab構成を編集して、ステップ2で生成したLet'sEncrypt証明書が使用されていることを確認します。また、手順1で設定したパスワードを使用してアクセスできるようにします。

まず、/home/sammy/.jupyter/jupyter_notebook_config.pyでJupyterLab構成ファイルを編集する必要があります。

nano /home/sammy/.jupyter/jupyter_notebook_config.py

次に、c.NotebookApp.certfileの値を定義する行に移動し、次のように更新します。