From f3e27833062b30bfb82c19f2d9f9f818a508b526 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Samohel?= Date: Wed, 4 Sep 2024 17:22:27 +0200 Subject: [PATCH 1/2] :memo: add documentation for launcher folder env vars --- website/docs/dev_launcher.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/website/docs/dev_launcher.md b/website/docs/dev_launcher.md index 05000163..3b5a1571 100644 --- a/website/docs/dev_launcher.md +++ b/website/docs/dev_launcher.md @@ -90,6 +90,10 @@ Environment variables that are set during startup: - **AYON_HEADLESS_MODE** - Headless mode flag enabled when set to '1'. - **AYON_EXECUTABLE** - Path to executable that is used to run AYON. - **AYON_ROOT** - Root to AYON launcher content. +- **AYON_LAUNCHER_STORAGE_DIR** - Directory where are stored dependency packages, addons and files related to addons. +- **AYON_LAUNCHER_LOCAL_DIR** - Directory where are stored user/machine specific files. This MUST NOT be shared. +- **AYON_ADDONS_DIR** - Path to AYON addons directory - still used but considered as deprecated. Please rather use `AYON_LAUNCHER_STORAGE_DIR` to change location. +- **AYON_DEPENDENCIES_DIR** - Path to AYON dependencies directory - still used but considered as deprecated. Please rather use `AYON_LAUNCHER_STORAGE_DIR` to change location. - **AYON_MENU_LABEL** - Label for AYON menu -> TODO move to openpype addon. - **PYBLISH_GUI** - Default pyblish UI that should be used in pyblish -> TODO move to openpype addon. @@ -107,6 +111,23 @@ Environment variables that are set for backwards compatibility with openpype add - **OPENPYPE_REPOS_ROOT** - Alias to **AYON_ROOT**. - **AVALON_LABEL** - Alias to **AYON_MENU_LABEL**. +:::note +Environment variables **AYON_LAUNCHER_STORAGE_DIR** and **AYON_LAUNCHER_LOCAL_DIR** are by default set to the same folder. Path is based on OS. +- Windows: `%LOCALAPPDATA%\Ynput\AYON` +- Linux: `~/.local/share/AYON` +- macOS: `~/Library/Application Support/AYON` + +It is required to set the environment variables before AYON launcher is started as it is required for bootstrap. +::: + +:::tip +Environment variables **AYON_ADDONS_DIR** and **AYON_DEPENDENCIES_DIR** by default lead relative to **AYON_LAUNCHER_STORAGE_DIR**. + +- **AYON_ADDONS_DIR** -> `{AYON_LAUNCHER_STORAGE_DIR}/addons` +- **AYON_DEPENDENCIES_DIR** -> `{AYON_LAUNCHER_STORAGE_DIR}/dependency_packages` + +Changing their values will change where addons and dependency packages are stored even if you change **AYON_LAUNCHER_STORAGE_DIR**! +::: ## Developer mode [Developer mode](dev_dev_mode) enables to skip the standard distribution process of addons to use local sources of addon code instead. This is useful for development of addon. Developer mode must be enabled and configured on AYON server. From 81963fa115d8ae9b1b6e2ef866e0d68f4b52dba9 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 6 Sep 2024 11:40:41 +0200 Subject: [PATCH 2/2] fix grammar Co-authored-by: Roy Nieterau --- website/docs/dev_launcher.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/dev_launcher.md b/website/docs/dev_launcher.md index 3b5a1571..924780f9 100644 --- a/website/docs/dev_launcher.md +++ b/website/docs/dev_launcher.md @@ -121,7 +121,7 @@ It is required to set the environment variables before AYON launcher is started ::: :::tip -Environment variables **AYON_ADDONS_DIR** and **AYON_DEPENDENCIES_DIR** by default lead relative to **AYON_LAUNCHER_STORAGE_DIR**. +Environment variables **AYON_ADDONS_DIR** and **AYON_DEPENDENCIES_DIR** by default are relative to **AYON_LAUNCHER_STORAGE_DIR**. - **AYON_ADDONS_DIR** -> `{AYON_LAUNCHER_STORAGE_DIR}/addons` - **AYON_DEPENDENCIES_DIR** -> `{AYON_LAUNCHER_STORAGE_DIR}/dependency_packages`