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

document system settings

Browse source
This commit is contained in:
Milan Kolar 2021-06-02 09:57:14 +02:00
parent 76aeffb816
commit fae1861785
2 changed files with 26 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

43
website/docs/admin_settings_system.md
View file

@ -7,15 +7,24 @@ sidebar_label: System settings
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Global
## General
Settings applicable to the full studio.
`Studio Name`
**`Studio Name`** - Full name of the studio (can be used as variable on some places)
`Studio Code`
**`Studio Code`** - Studio acronym or a short code (can be used as variable on some places)
`Environment`
**`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 naive barier to prevent artists from accidental setting changes.
**`Environment`** - Globally applied environment variables that will be appended to any OpenPype process in the studio.
**`Versions Repository`** - Location where automatic update mechanism searches for zip files with
OpenPype update packages. To read more about preparing OpenPype for automatic updates go to [Admin Distribute docs](admin_distribute#2-openpype-codebase)
![general_settings](assets/settings/settings_system_general.png)
## Modules
@ -24,25 +33,25 @@ their own attributes that need to be set, before they become fully functional.
### Avalon
`Avalon Mongo Timeout` - You might need to change this if your mongo connection is a bit slow. Making the
**`Avalon Mongo Timeout`** - You might need to change this if your mongo connection is a bit slow. Making the
timeout longer will give Avalon better chance to connect.
`Thumbnail Storage Location` - simple disk storage path, where all thumbnails will be stored.
**`Thumbnail Storage Location`** - simple disk storage path, where all thumbnails will be stored.
### Ftrack
`Server` - URL of your ftrack server.
**`Server`** - URL of your ftrack server.
Additional Action paths
`Action paths` - Directories containing your custom ftrack actions.
**`Action paths`** - Directories containing your custom ftrack actions.
`Event paths` - Directories containing your custom ftrack event plugins.
**`Event paths`** - Directories containing your custom ftrack event plugins.
`Intent` - Special ftrack attribute that mark the intention of individual publishes. This setting will be reflected
**`Intent`** - Special ftrack attribute that mark the intention of individual publishes. This setting will be reflected
in publisher as well as ftrack custom attributes
`Custom Attributes` - Write and Read permissions for all OpenPype required ftrack custom attributes. The values should be
**`Custom Attributes`** - Write and Read permissions for all OpenPype required ftrack custom attributes. The values should be
ftrack roles names.
### Sync Server
@ -55,25 +64,25 @@ Disable/Enable Standalone Publisher option
### Deadline
`Deadline Rest URL` - URL to deadline webservice that. This URL must be reachable from every
**`Deadline Rest URL`** - URL to deadline webservice that. This URL must be reachable from every
workstation that should be submitting render jobs to deadline via OpenPype.
### Muster
`Muster Rest URL` - URL to Muster webservice that. This URL must be reachable from every
**`Muster Rest URL`** - URL to Muster webservice that. This URL must be reachable from every
workstation that should be submitting render jobs to muster via OpenPype.
`templates mapping` - you can customize Muster templates to match your existing setup here.
**`templates mapping`** - you can customize Muster templates to match your existing setup here.
### Clockify
`Workspace Name` - name of the clockify workspace where you would like to be sending all the timelogs.
**`Workspace Name`** - name of the clockify workspace where you would like to be sending all the timelogs.
### Timers Manager
`Max Idle Time` - Duration (minutes) of inactivity, after which currently running timer will be stopped.
**`Max Idle Time`** - Duration (minutes) of inactivity, after which currently running timer will be stopped.
`Dialog popup time` - Time in minutes, before the end of Max Idle ti, when a notification will alert
**`Dialog popup time`** - Time in minutes, before the end of Max Idle ti, when a notification will alert
the user that their timer is about to be stopped.
### Idle Manager

BIN
website/docs/assets/settings/settings_system_general.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 17 KiB