Как в systemD запустить программу на Python в виртуальном окружении?

Question

[Vova316]

Как правильно создать Unit для запуска сервиса в systemD?
Мне нужно запустить программу на Python, но в виртуальном окружении.
Создаю файл: /etc/systemd/system/my_prog.service:

[Unit]
Description=my_prog
After=network-online.target nss-user-lookup.target
[Service]
User=pi  # Имя пользователя, от имени которого будет запускаться команда, указанная в ExecStart
Group=pi
WorkingDirectory=/home/pi/www  # Директория, в которую будет осуществлён переход перед запуском
ExecStart=/home/pi/www/env/bin/python3 /home/pi/www/run.py
RestartSec=10
Restart=always  # Всегда перезапускать скрипт при его падениях
StandardOutput=journal
StandardError=journal

[Install]
WantedBy=multi-user.target

Потом я запускаю последовательно команды:

sudo systemctl daemon-reload
sudo systemctl enable --now my_prog.service
systemctl status my_prog.service

И получаю ошибку:

× my_prog.service - my_prog
     Loaded: loaded (/etc/systemd/system/my_prog.service; enabled; preset: enabled)
     Active: failed (Result: exit-code) since Thu 2024-09-19 12:48:53 MSK; 4s ago
   Duration: 22ms
    Process: 2598 ExecStart=/home/pi/www/env/bin/python3 /home/pi/www/run.py (code=exited, status=217/USER)
   Main PID: 2598 (code=exited, status=217/USER)
        CPU: 9ms

Если же я вручную пройдусь по командам этого файла systemD, то моя программа тоже не работает из-за отсутствия пакета. Хотя этот пакет установлен в виртуальном окружении.

pi@server3:~$ cd /home/pi/www
pi@server3:~/www$ /home/pi/www/env/bin/python3 /home/pi/www/run.py
            Traceback (most recent call last):
            File "/home/pi/www/run.py", line 3, in <module>
            import mysql.connector as db
pi@server3:~/www$

При этом моя программа работает нормально если я вручную запускаю виртуальное окружение:

pi@server3:~$ cd www
pi@server3:~/www$ source env/bin/activate
(env) pi@server3:~/www$ python run.py
             78.10.222.186 - - [19/Sep/2024 12:58:11] "GET /run.py HTTP/1.1" 200

Что я делаю не так?
И как в systemD запустить программу на Python в виртуальном окружении?

Answer 1

[Алексей Черемисин]

Как-то так работает

....
Environment=VIRTUAL_ENV=/home/leah/myapp/.venv
Environment=PYTHONPATH=/home/leah/myapp
ExecStart=/home/leah/myapp/.venv//bin/python /home/leah/myapp/run.py
....

Comments

[Vova316]

Это не помогло. Мой файл:

[Unit]
Description=www-Nero
After=network-online.target nss-user-lookup.target

[Service]
User=pi # Имя пользователя, от имени которого будет запускаться команда, указанная в ExecStart
Group=pi
WorkingDirectory=/home/pi/www # Директория, в которую будет осуществлён переход перед запуском

Environment=VIRTUAL_ENV=/home/pi/www/env
Environment=PYTHONPATH=/home/pi/www
ExecStart=/home/pi/www/env/bin/python3 /home/pi/www/run.py

RestartSec=10
Restart=always # Всегда перезапускать скрипт при его падениях
StandardOutput=journal
StandardError=journal

[Install]
WantedBy=multi-user.target

Я получаю ошибку:

× my_prog.service - my_prog
Loaded: loaded (/etc/systemd/system/my_prog.service; enabled; preset: enabled)
Active: failed (Result: exit-code) since Thu 2024-09-19 13:54:17 MSK; 6s ago
Duration: 16ms
Process: 1665 ExecStart=/home/pi/www/env/bin/python3 /home/pi/www/run.py (code=exited, status=217/USER)
Main PID: 1665 (code=exited, status=217/USER)
CPU: 8ms

[Алексей Черемисин]

Vova316, А что пишет journalctl -u my_prog.service?

[Vova316]

Алексей Черемисин, в другой ветке подсказали как написать:

...
WorkingDirectory=/home/pi/www
Environment="PYTHONPATH=/home/pi/www/env/lib/python3.12/site-packages"
ExecStart=/home/pi/www/env/bin/python3 /home/pi/www/run.py
...

Это работает. Вот объяснение:

Добавление PYTHONPATH в конфигурацию systemd гарантировало, что Python всегда видит путь к модулям в виртуальном окружении, даже при запуске через systemd.
Проще говоря, без этого пути Python "не знал", где искать установленные библиотеки, поэтому и возникала ошибка ModuleNotFoundError.

Answer 2

[Данила]

Пропишите просто Environment для активации виртуального окружения в вашем юнит файле:

[Unit]
Description=my_prog
After=network-online.target nss-user-lookup.target

[Service]
User=pi
Group=pi
WorkingDirectory=/home/pi/www
ExecStart=/home/pi/www/env/bin/python3 /home/pi/www/run.py
Environment="PATH=/home/pi/www/env/bin:/usr/bin:/bin"
RestartSec=10
Restart=always
StandardOutput=journal
StandardError=journal

[Install]
WantedBy=multi-user.target

Не забудьте перезагрузить конфигурацию

Comments

[Vova316]

Я попробовал, но получаю туже ошибку. Проблема не решилась. Мой файл Юнита:

[Unit]
Description=my_prog
After=network-online.target nss-user-lookup.target

[Service]
User=pi # Имя пользователя, от имени которого будет запускаться команда, указанная в ExecStart
Group=pi
WorkingDirectory=/home/pi/www # Директория, в которую будет осуществлён переход перед запуском
Environment="PATH=/home/pi/www/env/bin:/usr/bin:/bin"
ExecStart=/home/pi/www/env/bin/python3 /home/pi/www/run.py
RestartSec=10
Restart=always # Всегда перезапускать скрипт при его падениях
StandardOutput=journal
StandardError=journal

[Install]
WantedBy=multi-user.target

[Данила]

Vova316, а сама команда вручную у вас корректно выполняется от имени пользователя pi?
sudo -u pi /home/pi/www/env/bin/python3 /home/pi/www/run.py

Возможно проблема с правами доступа к скрипту.

Вы также можете переназначить группу и права для вашей директории:

sudo chown -R pi:pi /home/pi/www
sudo chmod -R 755 /home/pi/www

Чтобы уж точно проверить, что проблема связана с правами пользователя, попробуйте временно запустить сервис от имени root:

[Service]
User=root

Если это работает, проблема, скорее всего, связана с правами пользователя pi.

[Vova316]

Данила, я запускаю комаду из папки www:

sudo -u pi /home/pi/www/env/bin/python3 /home/pi/www/run.py
ModuleNotFoundError: No module named 'mysql'
78.100.22.186 - - [19/Sep/2024 13:40:03] CGI script exit code 1

Т.е. как-будто не установлен пакет. Но он установлен в виртуальном окружении!

У папки www права моего пользователя pi:

pi@server3:~$ ls -l
drwxr-xr-x 5 pi pi 4096 Sep 19 11:35 www

Я пробую запускать Юнит от Root:

[Unit]
Description=my_prog
After=network-online.target nss-user-lookup.target

[Service]
User=root # Имя пользователя, от имени которого будет запускаться команда, указанная в ExecStart
Group=root
WorkingDirectory=/home/pi/www # Директория, в которую будет осуществлён переход перед запуском
Environment="PATH=/home/pi/www/env/bin:/usr/bin:/bin"
ExecStart=/home/pi/www/env/bin/python3 /home/pi/www/run.py
RestartSec=10
Restart=always # Всегда перезапускать скрипт при его падениях
StandardOutput=journal
StandardError=journal

[Install]
WantedBy=multi-user.target

Но снова получаю туже ошибку:

× my_prog.service - my_prog
Loaded: loaded (/etc/systemd/system/my_prog.service; enabled; preset: enabled)
Active: failed (Result: exit-code) since Thu 2024-09-19 13:44:05 MSK; 6s ago
Duration: 12ms
Process: 1518 ExecStart=/home/pi/www/env/bin/python3 /home/pi/www/run.py (code=exited, status=217/USER)
Main PID: 1518 (code=exited, status=217/USER)
CPU: 6ms

[Данила]

Vova316, проверьте, установлен ли пакет mysql.connector внутри виртуального окружения:

source /home/pi/www/env/bin/activate
pip freeze | grep mysql-connector

Если не установлен, то устанавливайте:
pip install mysql-connector-python

[Данила]

Vova316, также проверьте, правильно ли вообще указан путь к виртуальному окружению

[Vova316]

Данила, он был установлен:

pi@server3:~$ source /home/pi/www/env/bin/activate
(env) pi@server3:~$ pip freeze
mysql-connector-python==9.0.0
(env) pi@server3:~$

[Данила]

Vova316, попробуйте явно указать путь к установленным модулям в виртуальном окружении и запустить вручную скрипт для теста:

sudo -u pi PYTHONPATH=/home/pi/www/env/lib/python3.X/site-packages /home/pi/www/env/bin/python3 /home/pi/www/run.py

Только в PYTHONPATH поменяйте версию python на вашу

[Vova316]

Данила, так заработало. Спасибо. Какие мои дальнейшие действия?
Я запускаю из папки /home/pi/www:

sudo -u pi PYTHONPATH=/home/pi/www/env/lib/python3.12/site-packages /home/pi/www/env/bin/python3 /home/pi/www/run.py
78.100.22.186 - - [19/Sep/2024 13:56:15] "GET /cgi-bin/index.py HTTP/1.1" 200

[Данила]

Теперь укажите новый Environment в конфигурации и проверьте службу:

[Unit]
Description=my_prog
After=network-online.target nss-user-lookup.target

[Service]
User=pi
Group=pi
WorkingDirectory=/home/pi/www
Environment="PYTHONPATH=/home/pi/www/env/lib/python3.12/site-packages"
ExecStart=/home/pi/www/env/bin/python3 /home/pi/www/run.py
RestartSec=10
Restart=always
StandardOutput=journal
StandardError=journal

[Install]
WantedBy=multi-user.target

[Vova316]

Данила, Да. Спасибо. Это работает. Но я еще сделал изменения в строке ExecStart:

[Unit]
Description=my_prog
After=network-online.target nss-user-lookup.target

[Service]
User=pi
Group=pi
WorkingDirectory=/home/pi/www
Environment="PYTHONPATH=/home/pi/www/env/lib/python3.12/site-packages"
ExecStart=/home/pi/www/env/bin/python3.12 /home/pi/www/run.py

RestartSec=10
Restart=always
StandardOutput=journal
StandardError=journal

[Install]
WantedBy=multi-user.target

[Данила]

Vova316, отлично!

[Vova316]

Данила, можете объяснить "чайнику" почему оно не запускалось? Спасибо.

[Данила]

Vova316,
Добавление PYTHONPATH в конфигурацию systemd гарантировало, что Python всегда видит путь к модулям в виртуальном окружении, даже при запуске через systemd.
Проще говоря, без этого пути Python "не знал", где искать установленные библиотеки, поэтому и возникала ошибка ModuleNotFoundError.