P4 DAM Docker configuration reference
P4 DAM can be installed using the Docker image. The following tables provide the full list of P4 DAM configurable settings and their details when running P4 DAM in Docker. To learn more about updating the settings, see Update configuration settings.
Deploying P4 DAM using Docker is a Technology Preview. Features offered in Technology Preview are experimental and not guaranteed to always work as expected. If you have feedback and functionality suggestions, email techpreview@perforce.com.
On this page:
General
| Variable | Description |
|---|---|
| HTH_AUTH_METHOD | Authentication type. Allowed: helix. |
| HTH_BACKEND_BACKLOG_SOCKET | Unicorn socket backlog size. |
| HTH_BACKEND_WORKER_PROCESSES | Number of Unicorn worker processes. |
| HTH_BACKEND_WORKER_TIMEOUT | Timeout (seconds) for a Unicorn worker. |
| HTH_BACKUPS | Enables P4 DAM backups. |
| HTH_COMMAND_TIMEOUT | Timeout (seconds) for command execution. |
| HTH_COMPANIES | Path used to store company data. |
| HTH_DEFAULT_COMPANY | Default company short name used for login. |
| HTH_FAILED_LOGIN_INTERVAL | Minimum time between failed login attempts. |
| HTH_FAILED_LOGIN_LIMIT | Maximum failed login attempts allowed in the period. |
| HTH_FAILED_LOGIN_PERIOD | Time frame considered for failed login limits. |
| HTH_IS_DOCKER | Indicates whether the system runs inside Docker. |
| HTH_IS_SSL | Defines whether Nginx runs with SSL/TLS using certificates. |
| HTH_JIRA_WEBHOOKS_QUEUE_DELAY | Delay before processing Jira webhooks. |
| HTH_MULTIPART_FILE_LIMIT | Maximum number of multipart file attachments allowed. |
| HTH_MULTIPART_TOTAL_PART_LIMIT | Maximum total form parts allowed. |
| HTH_PASSWORD_VALIDATION_ENTROPY | Minimum password entropy value. |
| HTH_PASSWORD_VALIDATION_FORMAT | Required password format rules. |
| HTH_PASSWORD_VALIDATION_RANGE | Minimum and maximum password length. |
| HTH_PATH | Base installation path of the P4 DAM instance. |
| HTH_PREVIEW_2D_MAX_BYTES | Maximum preview size (MB) for 2D files. |
| HTH_PREVIEW_3D_MAX_BYTES | Maximum preview size (MB) for 3D files. |
| HTH_PREVIEW_AUDIO_MAX_BYTES | Maximum preview size (MB) for audio files. |
| HTH_PREVIEW_VIDEO_MAX_BYTES | Maximum preview size (MB) for video files. |
| HTH_SEARCH_ENGINE | Search engine used by P4 DAM. Allowed: p4search. |
| HTH_SECRET_KEY_BASE | Secret key used for signing and encryption. |
| HTH_SITE_PEPPER | Additional secret used to strengthen password hashing. |
| HTH_TAG_FILES_LIMIT | Maximum number of files that can be tagged or untagged at once. |
| HTH_TIMEZONE | System timezone for scheduled jobs. |
| HTH_URL | P4 DAM application URL. |
| HTH_WORKERS_COMPANY_DISK_USAGE_CALCULATOR_QUEUE_SIZE | Workers for disk‑usage calculation jobs. |
| HTH_WORKERS_EVENTS_QUEUE_SIZE | Workers for event jobs. |
| HTH_WORKERS_HOOKS_QUEUE_SIZE | Workers for repository event jobs. |
| HTH_WORKERS_MERGE_QUEUE_SIZE | Workers for merge jobs. |
| HTH_WORKERS_WEBHOOKS_QUEUE_SIZE | Workers for webhook jobs. |
| LC_ALL | System locale and encoding. |
P4 Server
| Variable | Description |
|---|---|
| HTH_HELIX_CHARSET | Character set encoding for the P4 Server. For example, utf8or none. |
| HTH_HELIX_FINGERPRINT | Fingerprint used to verify the P4 Server identity. |
| HTH_HELIX_GROUPS_EXCLUDE_REGEX | Regex pattern for groups to exclude. |
| HTH_HELIX_GROUPS_INCLUDE_REGEX | Regex pattern for groups to include. |
| HTH_HELIX_HAS_STATUS | Controls whether P4 Authentication Service is enabled. |
| HTH_HELIX_HAS_TIMEOUT | Timeout (seconds) for P4 Authentication Service requests. |
| HTH_HELIX_P4PORT | Hostname or IP address and port for the P4 Server in the form host:port. |
| HTH_HELIX_PASSWORD | Password or ticket for the P4 Server super user. |
| HTH_HELIX_SYNC_ENABLED | Enables synchronization with the P4 Server. |
| HTH_HELIX_SYNC_INTERVAL | Cron-formatted interval for P4 Server sync operations. The default is every five seconds. |
| HTH_HELIX_TIMEOUT | Timeout (seconds) for P4 Server requests. |
| HTH_HELIX_TRUST_FILE | Path to the P4 trust file. |
| HTH_HELIX_USER | P4 Server user with super privileges and unlimited ticket timeout. Ensure that the names of P4 Server users that need access to P4 DAM do not exceed 100 characters. P4 DAM only supports usernames up to 100 characters. |
| HTH_HELIX_USERS_EXCLUDE_REGEX | Names of users exclude from mirroring between P4 Server and TeamHub. |
| HTH_HELIX_USERS_FROM_GROUPS_EXCLUDE_REGEX | Names of groups to exclude users from when mirroring between P4 Server and TeamHub. |
| HTH_HELIX_USERS_FROM_GROUPS_INCLUDE_REGEX | Names of groups to include users from when mirroring between P4 Server and TeamHub. |
| HTH_HELIX_USERS_INCLUDE_REGEX | Names of users to include when mirroring between P4 Server and TeamHub. |
P4 Search/Elasticsearch
| Variable | Description |
|---|---|
| HTH_P4SEARCH_ES_HOSTS | List of Elasticsearch host objects, including host, port, scheme, user, and password. |
| HTH_P4SEARCH_ES_INDEX | Elasticsearch index name used by P4 Search. |
| HTH_P4SEARCH_ES_SSL_VERIFY | Whether to validate the Elasticsearch host certificate. |
| HTH_P4SEARCH_ES_TIMEOUT | Timeout (in seconds) for Elasticsearch requests. |
| HTH_P4SEARCH_SSL_VERIFY | Whether to validate the P4 Search host certificate. |
MongoDB
| Variable | Description |
|---|---|
| HTH_DB_NAME | MongoDB database name. |
| HTH_DB_PASSWORD | MongoDB password. |
| HTH_DB_POOL_SIZE | MongoDB connection pool size. |
| HTH_DB_URI | MongoDB connection string used by the application. |
| HTH_DB_USERNAME | MongoDB username. |
Redis
| Variable | Description |
|---|---|
| HTH_REDIS_HOST | Redis hostname. |
| HTH_REDIS_PASSWORD | Redis password. |
| HTH_REDIS_PORT | Redis port number. |
| HTH_REDIS_RECONNECT_ATTEMPTS | Number of attempts to reconnect to Redis. |
| HTH_REDIS_TIMEOUT | Redis request timeout. |
Mailing
| Variable | Description |
|---|---|
| HTH_BACKUPS_EMAIL | Receiver for backup‑related email notifications. |
| HTH_EMAIL | Sender address used for all outgoing emails and Support links. |
| HTH_LICENSE_EXPIRE_NOTIFY | Number of days before license expiration to notify instance administrators. |
| HTH_MAIL_DELIVERY_METHOD |
Method used for email delivery (allowed: smtp).
|
| HTH_NOTIFICATIONS_EMAIL | Override sender for notification‑related emails. |
| HTH_REGISTRATIONS_EMAIL | Override sender for registration‑related emails. |
| HTH_SMTP_ADDRESS | SMTP server address. |
| HTH_SMTP_AUTHENTICATION |
SMTP authentication method (default: plain).
|
| HTH_SMTP_PASSWORD | SMTP password. |
| HTH_SMTP_PORT | SMTP server port. |
| HTH_SMTP_TLS | Whether TLS is used for SMTP communications. |
| HTH_SMTP_USERNAME | SMTP username (default: default). |
| HTH_SUPPORT_EMAIL | Override address for support‑related communications. |
Streamer
| Variable | Description |
|---|---|
| HTH_STREAMER_URL | URL of the Streamer component. |
| HTH_STREAMER_MAX_CHUNK_SIZE | Maximum chunk size for streaming data. |
Websockets
| Variable | Description |
|---|---|
| ANYCABLE_BROADCAST_ADAPTER | Broadcast adapter used (allowed: redis). |
| ANYCABLE_DEBUG | Enables debug mode. |
| ANYCABLE_DISABLE_TELEMETRY | Disables telemetry collection. |
| ANYCABLE_HOST | AnyCableGo hostname. |
| ANYCABLE_PATH | URL path for AnyCableGo endpoint. |
| ANYCABLE_PORT | AnyCableGo port. |
| ANYCABLE_REDIS_CHANNEL | Redis channel used for broadcasting. |
| ANYCABLE_REDIS_URL | Redis URL for message broadcasting. |
| ANYCABLE_RPC_HOST | Moonshine endpoint. |
| HTH_MOONSHINE_LOG_LEVEL | Moonshine log level. |
| HTH_MOONSHINE_REDIS_CHANNEL | Redis channel used by Moonshine. |
| HTH_MOONSHINE_RPC_HOST | Moonshine RPC endpoint. |
Initial setup
| Variable | Description |
|---|---|
| HTH_INIT_BOTNAME | Initial bot account name created during system setup. |
| HTH_INIT_COMPANY_NAME | Initial company name created during setup. |
| HTH_INIT_PASSWORD | Initial administrator password generated or provided during setup. |
| HTH_INIT_USERNAME | Initial administrator username created during setup. |
| MONGO_INITDB_ROOT_PASSWORD | Root password used during MongoDB initialization. |
| MONGO_INITDB_ROOT_USERNAME | Root username used during MongoDB initialization. |