Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add reference to env variables & tokens #177

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions content/docs/Reference/env-variables.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: "Environment variables"
linkTitle: "Environment variables"
date: 2025-01-01
weight: 4
description: >
Configure common environment variables

---

This page lists some of the most common environment variables used in OpenCue.

## Outline

Environment variables related to pyOutline.

### OL_BASE_SESSION_PATH


### OL_LAYER_SESSION_PATH


### OL_LAYER_RANGE


### OL_VERSION


### OL_OS


### OL_TAG_OVERRIDE


### OL_CONFIG

## Cuebot

Environment variables related to Cuebot.

### CUEBOT_HOSTS


### CUEBOT_GRPC_CUE_PORT


### CUEBOT_GRPC_RQD_SERVER_PORT


## Others


### CUEGUI_DEFAULT_INI_PATH


### OPENCUE_CONF


### CUESUBMIT_CONFIG_FILE


### CUE_FRAME_LOG_DIR


### CUE_FS_ROOT


### CUE_PYTHON_BIN


### CUE_PYTHONPATH
36 changes: 36 additions & 0 deletions content/docs/Reference/tokens.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: "Tokens"
linkTitle: "Tokens"
date: 2020-04-03
weight: 5
description: >
Specify dynamic tokens in OpenCue jobs
---

This page describes tokens you can use in commands when submitting OpenCue jobs, either in the
graphical Cuesubmit client, or using the PyOutline API.

##### #ZFRAME#
The frame number zero-padded to four places.

##### #IFRAME#
The number of the current frame.

##### #FRAME_START#
The number of the final frame in the current chunk.

##### #FRAME_END#
The number of the final frame in the current chunk.

##### #FRAME_CHUNK#
The value of the current chunk.

##### #LAYER#
The name of the current layer.

##### #JOB#
The name of the current job.

##### #FRAMESPEC#
The value of the current frame spec.