Leitfaden zur Installation von JupyterLab auf Debian 12

Jupyter ist eine kostenlose und Open-Source-Webanwendung für interaktive Berechnungen und Datenwissenschaft. Jupyter unterstützt alle Programmiersprachen und bietet mehrere Softwarelösungen, wie JupyterLab, das eine funktionsreiche und tabbed Multi-Notebook-Bearbeitungsumgebung bereitstellt, Notebook als leichtgewichtige und vereinfachte Notizbuchautoren, Qtconsole und viele mehr.

In diesem Leitfaden führen wir Sie Schritt für Schritt durch die Installation von JupyterLab auf Debian 12. Sie werden JupyterLab in einer Python-virtuellen Umgebung installieren, JupyterLab als systemd-Dienst ausführen und dann Nginx als Reverse-Proxy für JupyterLab installieren und einrichten.

Voraussetzungen

Bevor Sie beginnen, stellen Sie sicher, dass Sie Folgendes haben:

• Einen Debian 12-Server.
• Einen Nicht-Root-Benutzer mit Administratorrechten.

Abhängigkeiten installieren

Jupyter ist ein Ökosystem von kostenlosen und Open-Source-Python-Software für interaktive Berechnungen in allen Programmiersprachen. Um Jupyter zu installieren, müssen Sie sicherstellen, dass Python auf Ihrem System installiert ist.

In diesem Abschnitt installieren Sie die Paketabhängigkeiten für Jupyter, die Python3, Pip-Paketmanager, Python venv virtuelle Umgebung und Node.js umfassen.

Bevor Sie beginnen, aktualisieren und aktualisieren Sie Ihr Debian-Paket-Index mit dem folgenden Befehl.

sudo apt update

Jetzt installieren Sie die Abhängigkeiten, indem Sie den folgenden apt install-Befehl ausführen. Damit installieren Sie Python3, Pip-Paketmanager, venv-Verwaltung der virtuellen Umgebung und Node.js.

sudo apt install python3 python3-pip python3-venv nodejs

Geben Sie y ein, um zu bestätigen und mit der Installation fortzufahren.

Nachdem die Abhängigkeiten installiert sind, führen Sie den folgenden Befehl aus, um die Version jeder Abhängigkeit zu überprüfen, einschließlich Python3, Pip und Node.js

python3 --version  
pip3 --version  
node --version

Die folgende Ausgabe zeigt Ihnen, dass Python 3.11, Pip 23 und Node.js 18.13 installiert sind.

Jupyter installieren

Nach der Installation der Abhängigkeiten installieren Sie als Nächstes die Jupyter-Metapakete mithilfe der Python-virtuellen Umgebung auf der Debian 12-Maschine. Um dies zu erreichen, müssen Sie Folgendes abschließen:

• Erstellen einer Python-virtuellen Umgebung
• Installieren von Jupyter
• Konfigurieren von JupyterLab

Lassen Sie uns beginnen.

Erstellen einer Python-virtuellen Umgebung

In diesem Abschnitt erstellen Sie eine neue Python-virtuelle Umgebung, die für die Jupyter-Installation verwendet wird. Mit diesem Szenario haben Sie eine isolierte Entwicklungsumgebung, die Ihr gesamtes System nicht beeinträchtigt. Außerdem können Sie dies im Laufe der Zeit erneut erstellen.

Melden Sie sich mit dem folgenden Befehl bei Ihrem Nicht-Root-Benutzer an.

su - user

Erstellen Sie jetzt ein neues Verzeichnis ~/project und wechseln Sie in dieses. Erstellen Sie dann eine neue virtuelle Umgebung namens venv mit dem folgenden Befehl. Nach der Ausführung des Befehls wird das neue Verzeichnis venv erstellt.

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

Führen Sie als Nächstes den folgenden Befehl aus, um die venv-virtuelle Umgebung zu aktivieren. Sobald sie aktiviert ist, wird Ihre Shell-Eingabeaufforderung wie „ (venv) user@hostname:#… “ aussehen.

source venv/bin/activate

Jupyter installieren

Nachdem Sie eine Python-virtuelle Umgebung erstellt haben, installieren Sie das Jupyter-Paket über Pip. Das Jupyter-Paket ist ein Metapaket des Jupyter-Ökosystems, das IPython, JupyterLab, Jupyter Server, Jupyter Notebook, qtconsole und viele mehr umfasst.

Führen Sie den folgenden pip3-Befehl aus, um Jupyter auf Ihrem Debian-System zu installieren.

pip3 install jupyter

Während der Installation wird die folgende Ausgabe in Ihrem Terminal angezeigt:

Nachdem die Installation abgeschlossen ist, überprüfen Sie den Speicherort der Jupyter-Binärdatei und die Version mit dem folgenden Befehl.

which jupyter  
jupyter --version

In der folgenden Ausgabe sollten Sie sehen, dass die Jupyter-Binärdatei sich im venv-Verzeichnis befindet. Außerdem sollten Sie die Version des Jupyter-Pakets sehen, das auf Ihrem System installiert ist.

JupyterLab konfigurieren

JupyterLab ist die nächste Generation der webbasierten Benutzeroberfläche für das Jupyter-Ökosystem. Mit JupyterLab können Sie mit Dokumenten und Aktivitäten wie Jupyter Notebook, Texteditor und Terminal in einem Fenster arbeiten. JupyterLab bietet Ihnen eine IDE-ähnliche Erfahrung für die Verwaltung und Entwicklung von Jupyter-Projekten.

In diesem Abschnitt richten Sie JupyterLab für Ihr Jupyter-Projekt ein. Aber bevor Sie das tun, müssen Sie zuerst den Jupyter-Server konfigurieren, um Ihre Installation zu sichern.

Führen Sie zuerst den folgenden Befehl aus, um die Jupyter-Server-Konfigurationsdatei zu generieren und das Passwort einzurichten. Geben Sie Ihr Passwort ein und wiederholen Sie es.

jupyter server --generate-config  
jupyter server password

Nach der Ausführung des Befehls wird die Jupyter-Serverkonfiguration im Verzeichnis ~/.jupyter/ generiert.

Sie können den Inhalt der Jupyter-Serverkonfiguration mit dem folgenden Befehl überprüfen.

jupyter server --show-config

Die ähnliche Ausgabe wird unten angezeigt:

Führen Sie als Nächstes den folgenden Befehl aus, um eine neue Konfiguration für JupyterLab zu generieren. Die JupyterLab-Konfiguration wird im Verzeichnis ~/.jupyter/ generiert.

jupyter lab --generate-config

Nachdem die Konfiguration generiert wurde, überprüfen Sie die JupyterLab-Konfiguration mit dem folgenden Befehl.

jupyter lab --show-config

Unten ist ein Beispiel für die JupyterLab-Konfiguration:

Jetzt können Sie die JupyterLab-Installation mit dem folgenden Befehl ausführen. Stellen Sie sicher, dass Sie die IP-Adresse durch Ihre Server-IP-Adresse ersetzen.

jupyter lab --ip 192.168.10.15

Die JupyterLab wird auf Ihrer Server-IP-Adresse mit dem Standardport 8888 ausgeführt. Die JupyterLab ist über den URL-Pfad /lab zugänglich.

Öffnen Sie Ihren Webbrowser und besuchen Sie Ihre Server-IP-Adresse, gefolgt von Port 8888 und dem Pfad /lab, wie http://192.168.10.15:8888/lab. Geben Sie Ihr Jupyter-Server-Passwort ein und klicken Sie auf Anmelden, um fortzufahren.

Wenn Sie das richtige Passwort haben, sollten Sie das JupyterLab-Benutzer-Dashboard wie folgt sehen:

Sie können jetzt Ctrl+c zweimal drücken, um den JupyterLab-Prozess zu beenden.

JupyterLab als Systemd-Dienst ausführen

Im nächsten Schritt erstellen Sie eine neue systemd-Dienstdatei, die verwendet wird, um JupyterLab auszuführen. Auf diese Weise wird Ihre JupyterLab-Installation im Hintergrund als systemd-Dienst ausgeführt, und Sie können JupyterLab einfach über das systemctl-Dienstprogramm verwalten.

Erstellen Sie eine neue systemd-Dienstdatei /etc/systemd/system/jupyterlab.service mit dem folgenden nano-Editor-Befehl.

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

Fügen Sie die folgende Konfiguration ein und stellen Sie sicher, dass Sie den Benutzernamen bob ändern.

[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

Wenn Sie fertig sind, speichern Sie die Datei und schließen Sie sie.

Führen Sie jetzt den folgenden systemctl-Befehl aus, um den systemd-Manager neu zu laden und die Änderungen anzuwenden.

sudo systemctl daemon-reload

Starten Sie dann den jupyterlab-Dienst und aktivieren Sie ihn mit dem folgenden Befehl.

sudo systemctl start jupyterlab  
sudo systemctl enable jupyterlab

Überprüfen Sie zuletzt den jupyterlab-Dienst, um sicherzustellen, dass der Dienst läuft.

sudo systemctl status jupyterlab

Die folgende Ausgabe bestätigt, dass der jupyterlab-Dienst läuft.

Nginx als Reverse-Proxy für Jupyter konfigurieren

In diesem Leitfaden werden Sie JupyterLab mit Nginx als Reverse-Proxy ausführen. Um dies zu erreichen, müssen Sie Folgendes abschließen:

• Erlauben des Remote-Zugriffs auf JupyterLab
• Installieren und Konfigurieren von Nginx als Reverse-Proxy

Erlauben des Remote-Zugriffs auf JupyterLab

Standardmäßig ist die JupyterLab-Installation nur über eine lokale IP-Adresse zugänglich. Um eine Remote-Verbindung zu ermöglichen, müssen Sie die Standardkonfiguration von JupyterLab ändern.

Öffnen Sie die JupyterLab-Konfiguration ~/.jupyter/jupyter_lab_config.py mit dem folgenden nano-Editor-Befehl.

nano ~/.jupyter/jupyter_lab_config.py

Kommentieren Sie die Option c.ServerApp.allow_remote_access aus und ändern Sie den Wert in True. Dadurch wird JupyterLab von einer Remote-Verbindung aus zugänglich, was das Ausführen von JupyterLab hinter einem Reverse-Proxy umfasst.

c.ServerApp.allow_remote_access = True

Speichern Sie die Datei und beenden Sie den Editor, wenn Sie fertig sind.

Führen Sie jetzt den folgenden systemctl-Befehl aus, um den jupyterlab-Dienst neu zu starten und die Änderungen anzuwenden.

sudo systemctl restart jupyterlab

Überprüfen Sie dann den jupyterlab-Dienst mit dem folgenden Befehl.

sudo systemctl status jupyterlab

Am Ende der Ausgabe sollten Sie das generierte Token für den Zugriff auf Ihre JupyterLab-Installation sehen, und stellen Sie sicher, dass Sie es für den nächsten Abschnitt kopieren.

Installieren und Konfigurieren von Nginx als Reverse-Proxy

Nachdem Sie den Remote-Zugriff auf JupyterLab erlaubt haben, installieren Sie als Nächstes Nginx und konfigurieren Sie es als Reverse-Proxy für Ihre JupyterLab-Installation.

Installieren Sie Nginx, indem Sie den folgenden apt install-Befehl ausführen.

sudo apt install nginx -y

Unten ist die Ausgabe während der Nginx-Installation.

Nachdem Nginx installiert ist, erstellen Sie eine neue Serverblockkonfiguration /etc/nginx/sites-available/jupyterlab mit dem folgenden nano-Editor.

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

Fügen Sie die folgende Konfiguration ein und stellen Sie sicher, dass Sie den Domainnamen innerhalb der Option server_name ändern.

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;  
    }  
}

Speichern Sie die Datei und schließen Sie sie, wenn Sie fertig sind.

Führen Sie jetzt den folgenden Befehl aus, um die Serverblockdatei /etc/nginx/sites-available/jupyterlab zu aktivieren und die Nginx-Konfiguration zu überprüfen.

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

Wenn Sie eine korrekte Nginx-Syntax haben, sollten Sie die Ausgabe „ Syntax ist ok - Test war erfolgreich “ erhalten.

Führen Sie schließlich den systemctl-Befehl unten aus, um den nginx-Dienst neu zu starten und die Änderungen anzuwenden. Überprüfen Sie es dann, um sicherzustellen, dass der Dienst läuft.

sudo systemctl restart nginx  
sudo systemctl status nginx

Wenn Nginx läuft, sollten Sie die Ausgabe aktiv (laufend) erhalten.

Zugriff auf die JupyterLab-Installation über den lokalen Computer

Um auf JupyterLab über den Domainnamen zuzugreifen, können Sie die Datei /etc/hosts für Linux-Clients oder die Datei C:\Windows\System32\drivers\etc\hosts für Windows-Benutzer verwenden.

Öffnen Sie die Datei /etc/hosts auf Ihrem Linux-Client mit dem nano-Editor.

sudo nano /etc/hosts

Fügen Sie die folgende Konfiguration in die Datei ein und stellen Sie sicher, dass Sie die IP-Adresse und den Domainnamen mit Ihren Informationen ändern.

192.168.10.15   jupyterlab.howtoforge.local

Speichern Sie die Datei und schließen Sie sie, wenn Sie fertig sind.

Öffnen Sie als Nächstes Ihren Webbrowser und besuchen Sie den Domainnamen Ihrer JupyterLab-Installation, wie http://jupyterlab.howtoforge.local. Wenn Ihre Installation erfolgreich ist, sollten Sie die Anmeldeseite von JupyterLab erhalten.

Am unteren Rand der Seite geben Sie das generierte und das neue Passwort für Ihre JupyterLab-Installation ein. Klicken Sie dann auf die Schaltfläche Anmelden und ein neues Passwort festlegen.

Wenn alles gut geht, sollten Sie zum JupyterLab-Dashboard wie folgt weitergeleitet werden.

Damit ist Ihre JupyterLab-Installation abgeschlossen.

Fazit

Durch das Abschließen dieses schrittweisen Leitfadens haben Sie die Installation von JupyterLab auf dem Debian 12-Server erfolgreich durchgeführt. Sie haben JupyterLab in einer Python-virtuellen Umgebung installiert, JupyterLab im Hintergrund als systemd-Dienst ausgeführt und Nginx als Reverse-Proxy für JupyterLab konfiguriert. Jetzt können Sie Ihr Jupyter-Projekt erstellen und verwalten.