From ea060a65d5a1dba81371ba4e34fd159e0e58914d Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Sat, 29 Apr 2023 10:45:42 +0200 Subject: [PATCH] install & systemd: Mention how to setup with a virtualenv --- use/install.rst | 12 ++++++++++++ use/supybot-botchk.rst | 10 ++++++++++ 2 files changed, 22 insertions(+) diff --git a/use/install.rst b/use/install.rst index ae1c195..9364885 100644 --- a/use/install.rst +++ b/use/install.rst @@ -89,6 +89,12 @@ Then Limnoria itself:: If you have an error saying ``No module named pip``, install ``pip`` using your package manager (the package is usually named ``python3-pip``). +If you have an error about ``externally-managed-environment``, you need to setup +a virtualenv first, then re-run the commands above:: + + python3 -m venv /opt/venvs/limnoria # creates a virtualenv at the given path + . /opt/venvs/limnoria/bin/activate # enables the virtualenv in the current shell + Local installation (without root access) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -109,6 +115,12 @@ You might need to add $HOME/.local/bin to your PATH.:: If you have an error saying ``No module named pip``, install ``pip`` using this guide: https://pip.pypa.io/en/stable/installing/ +If you have an error about ``externally-managed-environment``, you need to setup +a virtualenv first, then re-run the commands above:: + + python3 -m venv ~/.venvs/limnoria # creates a virtualenv at the given path + . ~/.venvs/limnoria/bin/activate # enables the virtualenv in the current shell + .. _initial-configuration: Configuration diff --git a/use/supybot-botchk.rst b/use/supybot-botchk.rst index e1e40bb..d87dc4e 100644 --- a/use/supybot-botchk.rst +++ b/use/supybot-botchk.rst @@ -39,6 +39,16 @@ following content replacing things were suitable:: [Install] WantedBy=multi-user.target +:file:`/usr/local/bin/supybot` should be the path where you installed Limnoria. +Typically, this is: + +* :file:`/usr/local/bin/supybot` if installed as root without a virtualenv +* :file:`/opt/venvs/limnoria/bin/supybot` if installed as root with a virtualenv + as :file:`/opt/venvs/limnoria/` +* :file:`/home/BOTUSERNAME/.local/bin/supybot` if installed as non-root without a virtualenv +* :file:`/home/BOTUSERNAME/.venvs/limnoria/bin/supybot` if installed as non-root with a virtualenv + as :file:`~/.venvs/limnoria/` + Now you should run ``systemctl daemon-reload`` to make systemd aware of changed files and ``systemctl enable .service`` to make the bot start on boot etc. and ``systemctl start .service`` to start