christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-17 18:45:15 +00:00
Code Issues Releases Activity

docs: improve all available values from ENV_TEMPLATE_VARIABLES

Browse Source
This commit is contained in:
Régis Behmo 2023-04-28 12:02:04 +02:00
parent 18ce1f2fe4
commit cbe32cbc15
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
tutor/hooks/catalog.py
View File

@ -367,6 +367,16 @@ class Filters:
#: List of extra variables to be included in all templates. #: List of extra variables to be included in all templates.
#: #:
#: Out of the box, this filter will include all configuration settings, but also the following:
#:
#: - `HOST_USER_ID`: the numerical ID of the user on the host.
#: - `TUTOR_APP`: the app name ("tutor" by default), used to determine the dev/local project names.
#: - `TUTOR_VERSION`: the current version of Tutor.
#: - `is_buildkit_enabled`: a boolean function that indicates whether BuildKit is available on the host.
#: - `iter_values_named`: a function to iterate on variables that start or end with a given string.
#: - `iter_mounts`: a function that yields compose-compatible bind-mounts for any given service.
#: - `patch`: a function to incorporate extra content into a template.
#:
#: :parameter filters: list of (name, value) tuples. #: :parameter filters: list of (name, value) tuples.
ENV_TEMPLATE_VARIABLES: Filter[list[tuple[str, Any]], []] = filters.get( ENV_TEMPLATE_VARIABLES: Filter[list[tuple[str, Any]], []] = filters.get(
"env:templates:variables" "env:templates:variables"