add support for pip packages

This commit is contained in:
aptalca 2022-09-26 16:55:56 -04:00
parent 3a2d1eb34f
commit c0e9fe3117
2 changed files with 33 additions and 7 deletions

View File

@ -1,12 +1,22 @@
# Package Install - Universal Docker mod
Using this mod you can install any package during starup by providing it through the environment variable `INSTALL_PACKAGES`. This is then passed into the installation command as such: `apt install -y --no-install-recommends ...` or `apk add --no-cache ...` for Alpine based images.
Using this mod you can install any OS or Python packages during startup by providing them through the environment variables `INSTALL_PACKAGES` and `INSTALL_PIP_PACKAGES`. These are then passed into the installation commands as such: `apt-get install -y --no-install-recommends ...` in Ubuntu and `apk add --no-cache ...` in Alpine based images for OS packages and `pip install ...` for python packages.
In any docker container arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:universal-package-install`
To enable, in docker container arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:universal-package-install` and env vars `INSTALL_PACKAGES` and/or `INSTALL_PIP_PACKAGES`
If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:universal-package-install|linuxserver/mods:universal-stdout-logs`. Similarly, for installing multiple packages separate them by `|`.
E.g., to install `rsync`, `git` and `nginx` add the following lines to your docker compose service:
If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:universal-package-install|linuxserver/mods:universal-stdout-logs`.
Similarly, for installing multiple packages separate them by `|`.
E.g., to install `rsync`, `git` and `nginx` OS packages and `apprise` python package, add the following lines to your docker compose service:
```yaml
- DOCKER_MODS=linuxserver/mods:universal-package-install
- INSTALL_PACKAGES=rsync|git|nginx
```
- INSTALL_PIP_PACKAGES=apprise
```
## Notes:
- Package names entered should match the names in the relevant distro repo: https://pkgs.alpinelinux.org/packages or https://packages.ubuntu.com/
- Setting the env var `INSTALL_PIP_PACKAGES` will result in automatic install of the `python3-dev` and `python3-pip` OS packages, updating of `pip` to the latest version and installation of the latest `setuptools` and `wheel` packages to set up the necessary environment.
- Any other OS dependency such as `make` or `git`, which may be needed by the pip install process, should be manually added to `INSTALL_PACKAGES`.
- The OS packages defined will be installed first, followed by the pip packages.
- Pip will also use the relevant linuxserver wheel repo as an additional index to pull prebuilt wheels for common packages (ie. https://wheel-index.linuxserver.io/ubuntu/ and https://wheel-index.linuxserver.io/alpine-3.16/).

View File

@ -1,16 +1,32 @@
#!/usr/bin/with-contenv bash
# Exit if no installable packages are provided
if [ -z ${INSTALL_PACKAGES+x} ]; then
if [ -z "${INSTALL_PACKAGES+x}" ] && [ -z "${INSTALL_PIP_PACKAGES+x}" ]; then
echo "**** No packages to install ****"
exit 0
fi
if [ -n "${INSTALL_PIP_PACKAGES}" ] && [ -f /usr/bin/apt ]; then
echo "\
python3-dev \
python3-pip" >> /mod-repo-packages-to-install.list
elif [ -n "${INSTALL_PIP_PACKAGES}" ] && [ -f /sbin/apk ]; then
echo "\
python3-dev \
py3-pip" >> /mod-repo-packages-to-install.list
fi
#Split list of packages on delimiter '|'
IFS='|'
INSTALL_PACKAGES=(${INSTALL_PACKAGES})
for PKG in "${INSTALL_PACKAGES[@]}"; do
echo "**** Adding ${PKG} to install list ****"
echo "**** Adding ${PKG} to OS package install list ****"
echo "${PKG}" >> /mod-repo-packages-to-install.list
done
INSTALL_PIP_PACKAGES=(${INSTALL_PIP_PACKAGES})
for PKG in "${INSTALL_PIP_PACKAGES[@]}"; do
echo "**** Adding ${PKG} to pip install list ****"
echo "${PKG}" >> /mod-pip-packages-to-install.list
done