Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2025-12-24 21:04:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

added documenation

Browse source
This commit is contained in:
Jakub Jezek 2023-02-01 16:25:52 +01:00
parent b2ed65c17a
commit 76ab705e0c
No known key found for this signature in database
GPG key ID: 730D7C02726179A7
1 changed files with 32 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

38
website/docs/admin_settings_system.md
View file

@ -13,18 +13,44 @@ Settings applicable to the full studio.
![general_settings](assets/settings/settings_system_general.png)
**`Studio Name`** - Full name of the studio (can be used as variable on some places)
### Studio Name
- Full name of the studio (can be used as variable on some places)
**`Studio Code`** - Studio acronym or a short code (can be used as variable on some places)
### Studio Code
- Studio acronym or a short code (can be used as variable on some places)
**`Admin Password`** - After setting admin password, normal user won't have access to OpenPype settings
### Admin Password
- After setting admin password, normal user won't have access to OpenPype settings
and Project Manager GUI. Please keep in mind that this is a studio wide password and it is meant purely
as a simple barrier to prevent artists from accidental setting changes.
**`Environment`** - Globally applied environment variables that will be appended to any OpenPype process in the studio.
### Environment
- Globally applied environment variables that will be appended to any OpenPype process in the studio.
- OpenPype is using some keys to configure some tools. Here are some:
**`Disk mapping`** - Platform dependent configuration for mapping of virtual disk(s) on an artist's OpenPype machines before OP starts up.
Uses `subst` command, if configured volume character in `Destination` field already exists, no re-mapping is done for that character(volume).
#### OPENPYPE_TMPDIR:
- Custom staging dir directory
- Supports anatomy keys formating. ex `{root[work]}/{project[name]}/temp`
- supported formating keys:
- root[work]
- project[name | code]
- asset
- hierarchy
- task
- username
- app
#### OPENPYPE_DEBUG
- setting logger to debug mode
- example value: "1" (to activate)
#### OPENPYPE_LOG_LEVEL
- stringified numeric value of log level. [Here for more info](https://docs.python.org/3/library/logging.html#logging-levels)
- example value: "10"
### Disk mapping
- Platform dependent configuration for mapping of virtual disk(s) on an artist's OpenPype machines before OP starts up.
- Uses `subst` command, if configured volume character in `Destination` field already exists, no re-mapping is done for that character(volume).
### FFmpeg and OpenImageIO tools
We bundle FFmpeg tools for all platforms and OpenImageIO tools for Windows and Linux. By default, bundled tools are used, but it is possible to set environment variables `OPENPYPE_FFMPEG_PATHS` and `OPENPYPE_OIIO_PATHS` in system settings environments to look for them in different directory.