From a1c08eb2465f4f2c5f75ff3bac7cad318780174b Mon Sep 17 00:00:00 2001 From: Caspar van Leeuwen Date: Thu, 21 May 2026 16:15:34 +0200 Subject: [PATCH] Provide minimal documentation on EESSI_SITE_SOFTWARE_PREFIX --- docs/using_eessi/building_on_eessi.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/using_eessi/building_on_eessi.md b/docs/using_eessi/building_on_eessi.md index 21ba72cc43..96a616cb77 100644 --- a/docs/using_eessi/building_on_eessi.md +++ b/docs/using_eessi/building_on_eessi.md @@ -22,7 +22,7 @@ module help EESSI-extend/2023.06-easybuild The installation prefix is determined by `EESSI-extend` through the following logic: 1. If `$EESSI_CVMFS_INSTALL` is set, software is installed in `$EESSI_SOFTWARE_PATH`. This variable shouldn't be used by users and would only be used by CVMFS administrators of the EESSI repository. -2. If `$EESSI_SITE_INSTALL` is set, the EESSI site installation prefix (`$EESSI_SITE_SOFTWARE_PATH`) will be used. This is typically where sites hosting a system that has EESSI deployed would install additional software on top of EESSI and make it available to all their users. +2. If `$EESSI_SITE_INSTALL` is set, the EESSI site installation prefix (`$EESSI_SITE_SOFTWARE_PATH`) will be used. This is typically where sites hosting a system that has EESSI deployed would install additional software on top of EESSI and make it available to all their users. Note that `$EESSI_SITE_SOFTWARE_PATH` is set by the `EESSI` module. The location it points to can be changed by setting the `$EESSI_SITE_SOFTWARE_PREFIX` _before_ loading the `EESSI` module. 3. If `$EESSI_PROJECT_INSTALL` is set (and `$EESSI_USER_INSTALL` is not set), this prefix will be used. You should use this if you want to install additional software on top of EESSI that should also be usable by your project partners on the same system. For example, if you have a project space at `/project/my_project` that all your project partners can access, you could set `export EESSI_PROJECT_INSTALL=/project/my_project/eessi`. Make sure that this directory has the SGID permission set (`chmod g+s $EESSI_PROJECT_INSTALL`). This way, all the additional installations done with `EESSI-extend` will be put in that prefix, and will get the correct UNIX file permissions so that all your project partners can access it. 4. If `$EESSI_USER_INSTALL` is set, this prefix will be used. You should use this if you want to install additional software on top of EESSI just for your own user. For example, you could set `export EESSI_USER_INSTALL=$HOME/my/eessi/extend/prefix`, and `EESSI-extend` will install all software in this prefix. Unix file permissions will be set such that these installations will be readable only to the user.