How to enable a virtualenv in a systemd service unit?
While the path for libraries is indeed baked into the python interpreter of the virtualenv, I've had issues with python tools that were using binaries installed in that virtualenv. For instance, my apache airflow service wouldn't work because it couldn't find the gunicorn
binary. To work around this, here's my ExecStart
instruction, with an Environment
instruction (which sets an environment variable for the service alone).
ExecStart={{ virtualenv }}/bin/python {{ virtualenv }}/bin/airflow webserver
Environment="PATH={{ virtualenv }}/bin:{{ ansible_env.PATH }}"
ExecStart
explicitly uses the python interpreter of the virtualenv. I'm also adding a PATH
variable, which adds the binary folder of the virtualenv before the system PATH
. That way, I get the desired python libraries as well as binaries.
Note that I'm using ansible to build this service, ergo the curly braces of jinja2.
I'm not using virtualenv but pyenv: here is it just to use the real .pyenv path in the shebang and make sure it is in the PATH
Ex: pyenv activate flask-prod for user mortenb which is running in prod
/home/mortenb/.pyenv/versions/flask-prod/bin/python --version
Python 3.6.2
Then to my flask scripts starting in systemd *.service I add the following shebang:
#!/home/mortenb/.pyenv/versions/flask-prod/bin/python3
The virtualenv is "baked into the Python interpreter in the virtualenv". This means you can launch python
or console_scripts
directly in that virtualenv and don't need to activate the virtualenv first or manage PATH
yourself.:
ExecStart={{ venv_home }}/bin/fooservice --serve-in-foreground
or
ExecStart={{ venv_home }}/bin/python {{ venv_home }}/fooservice.py --serve-in-foreground
and remove the EnvironmentFile
entry.
To verify that it is indeed correct you can check sys.path
by running
{{ venv_home }}/bin/python -m site
and comparing the output to
python -m site
In my case I just tried to add environment variables required for Flask, for instance
[Service]
Environment="PATH=/xx/yy/zz/venv/bin"
Environment="FLASK_ENV=development"
Environment="APP_SETTINGS=config.DevelopmentConfig"
I was using virtualenv so /xx/yy/zz/venv/bin
is the path of virtualenv folder.