All blocks in config.php
This section shows all the possible configuration blocks in the SWARM_ROOT/data/config.php file.
On this page:
Overview
To prevent unintentional whitespace in the output, the configuration file does not include PHP's standard closing tag (?>). Unintentional whitespace interferes with P4 Code Review's control of HTTP headers, and can cause unexpected behavior and misleading error messages.
A configuration change only takes effect when the configuration cache has been reloaded. You must be an admin or super user to reload the P4 Code Review config cache.
To reload the configuration:
Open the user menu (top-right corner of P4 Code Review).
Select System Information.
Open the Cache Info tab.
Click Reload Configuration.
If changes to the config.php file might have caused the P4 Code Review web interface to become unresponsive, remove the problematic changes from the config.php file, then clear the configuration cache by running this command: rm -f /opt/perforce/swarm/data/cache/module-config-cache.php
Example of correct syntax
Although the syntax of this example is correct, it includes configuration values that cannot work. Before using the example in testing or production, adjust the configuration for your P4 Code Review installation .
If a comment is not fully visible, use the horizontal scrollbar below that section of the example:
To see a detailed description of a configurable, such as 'activity', click the link.
<?php
return array(
'activity' => array(
'ignored_users' => array(
'p4dtguser',
'system',
),
'cleanup' => (
'retention_lifetime' => null, // e.g. "30 days", "6 months", "1 year". null = disabled (default)
'max_delete_per_run' => 50000, // max records removed per sweep
'batch_size' => 1000, // page size used internally
'sweep_interval' => 86400, // seconds between sweeps (24h)
'drain_interval' => 300, // seconds; shorter interval while backlog remains
),
),
'archives' => array(
'max_input_size' => 512 * 1024 * 1024, // 512M (in bytes)
'archive_timeout' => 1800, // 30 minutes
'compression_level' => 1, // 0-9
'cache_lifetime' => 60 * 60 * 24, // 1 day
),
'avatars' => array(
'http_url' => 'http://www.gravatar.com/avatar/{hash}?s={size}&d={default}',
'https_url' => 'https://secure.gravatar.com/avatar/{hash}?s={size}&d={default}',
),
'Checklists' => array(
'add_admin_only' => false, // if enabled, only admin users can create checklist
'add_groups_only' => false, // if set, only members of given groups can create checklists
'edit_name_admin_only' => false, // if enabled, only admin users can edit checklist name
'edit_items_admin_only' => false, // if enabled, only admin users can add/edit/remove checklist items
),
'comments' => array(
'notification_delay_time' => 1800, // Default to 30 minutes 1800 seconds
'threading' => array(
'max_depth' => 4, // default value 4, set to 0 to disable replies
),
'email' => array(
'hide_file_content' => false, // default to false but set to true will hide file
// content and show message of "file content removed"
),
),
'depot_storage' => array(
'base_path' => '//depot_name',
),
'diffs' => array(
'max_diffs' => 1500, // maximum number of lines displayed in a diff
// From 2025.2 onwards, this is only available in
// the classic view of the review page.
'max_total_diff_size' => 200000, // maximum size of the total diffs of a file in bytes, defaults to 0.2 MB
// From 2025.2 onwards, this is only available in
// the new view of the review page.
),
'environment' => array(
'mode' => 'production',
'hostname' => 'myswarm.hostname',
'external_url' => null,
'base_url' => null,
'logout_url' => null, // defaults to null
'vendor' => array(
'emoji_path' => 'vendor/gemoji/images',
),
),
'files' => array(
'max_size' => 1000 * 1024, //1MB (in bytes),
'download_timeout' => 1800,
'allow_edits' => true, // default is true
),
'groups' => array(
'super_only' => true, // default value is false
),
'http_client_options' => array(
'timeout' => 10, // default value is 10 seconds
'sslcapath' => '', // path to the SSL certificate directory
'sslcert' => '', // the path to a PEM-encoded SSL certificate
'sslpassphrase' => '', // the passphrase for the SSL certificate file
'hosts' => array(), // optional, per-host overrides. Host as key, array options as values
),
'jira' => array(
'host' => '', // URL for your installed Jira web interface (start with https:// or http://)
'api_host' => '', // URL for Jira API access, 'host' is used for Jira API access if 'api_host' is not set
'user' => '', // Jira Cloud: the username used to connect to your Atlassian account
// Jira on-premises: the username required for Jira API access
// Jira on-premises with Personal Access Tokens (PATs): the username must be blank
'password' => '', // Jira Cloud: a special API token, obtained from https://id.atlassian.com/manage/api-tokens
// Jira on-premises: the password required for Jira API access
// Jira on-premises with Personal Access Tokens (PATs): the Personal Access Token (PAT) obtained from Jira On-premises.
'job_field' => '', // optional, if P4DTG is replicating Jira issue IDs to a job field, list that field here
'link_to_jobs' => false, // set to true to enable Perforce job links in Jira, P4DTG, and job_field required
'delay_job_links' => 60, // delay in seconds, defaults to 60 seconds
'relationship' => '', // Jira subsection name links are added to defaults to empty, links added to the "links to" subsection
'ignored_users' => array(), // Reviews or changes by users specified here are not linked to any Jira issue.
'title_summary' => true, // set to True if user wants the title/description of review/job/commit in jira card. default is true.
),
'libreoffice' => array(
'path' => 'soffice', // LibreOffice executable.
'timeout' => 120, // Preview conversion timeout (seconds, 0 disables).
'content_check' => true, // Validate file content before preview generation.
),
'linkify' => array(
'word_length_limit' => 2048, // limit on the number of characters which a text to be linkified can have
'target' => '_self', // opens the URL in the same tab or a new tab, defaults to '_self'. To open the URL in a new tab, set to '_blank'
'markdown' => array(
array(
'id' => 'jobs',
'regex' => '', // the regular expression used to match the job keyword, default is empty
'url' => '', // url that matching job numbers are appended to, default is empty
),
),
),
'log' => array(
'priority' => 3, // 7 for max, defaults to 3
'reference_id' => false // defaults to false
),
'mail' => array(
// Crop subject lines of Review and Commit email notifications to 80 characters by default, trim the rest with ...
// can be any positive integer up to 260 and if 0 disable cropping to show full length of subject with no trimming.
'subject_crop_length' => 80,
// 'recipients' => array('user@my.domain'),
'notify_self' => false,
'transport' => array(
'host' => 'my.mx.host',
),
),
'markdown' => array(
'markdown' => 'safe', // default is 'safe' 'disabled'|'safe'|'unsafe'
),
'mentions' => array(
'mode' => 'global',
'user_exclude_list' => array('super', 'swarm-admin'),
'group_exclude_list' => array('testers', 'writers'), // defaults to empty
),
'menu_helpers' => array(
'MyMenu01' => array( // A short recognizable name for the menu item
'id' => 'custom01', // A unique id for the menu item. If not included in the array, parent array name is used.
'enabled' => true, // When set to true, the menu item is visible. Defaults to true if not included in the array.
'target' => '/module/MyMenuItem/', // The URL or custom module route a menu click takes you to.
// If not included in array, id is used. If id not included, parent array name is used.
'cssClass' => 'custom_menu', // The custom CSS class name added to the menu item, appended to h2.menu- in P4 Code Review CSS
'title' => 'MyMenuItem', // The text that will be shown on the button.
// If not included in array, id is used. If id not included, parent array name is used.
'class' => '', // If not included in array or empty, the menu item is added to the main menu.
// To add the menu item to the project menu for all of the projects, set to '\Projects\Menu\Helper\ProjectContextMenuHelper'
'priority' => 155, // The position the menu item is displayed at in the menu.
// If not included in the array, the menu item is placed at the bottom of the menu.
'roles' => null, // null|'authenticated'|'admin'|'super'
// If not included in the array, null is the default.
// Specifies the minimum level of Perforce user that can see the menu item.
// 'authenticated' = any authorized user, null = unauthenticated users
),
),
'notifications' => array(
'honor_p4_reviews' => false, // defaults to false
'opt_in_review_path' => '', // required if honor_p4_reviews is true; defaults to ''
'disable_change_emails' => false, // optional; defaults to false
'websocket' => (
'enabled' => true,
),
),
'p4' => array(
'port' => 'my-helix-core-server:1666',
'user' => 'admin_userid',
'password' => 'admin user ticket or password',
'sso' => 'disabled', // 'disabled'|'optional'|'enabled'
// default value is 'disabled'
'proxy_mode' => true, // defaults to true
'slow_command_logging' => array(
3,
10 => array('print', 'shelve', 'submit', 'sync', 'unshelve'),
),
'max_changelist_files' => 1000,
'auto_register_url' => true,
),
'projects' => array(
'mainlines' => array(
'stable', 'release', // 'main', 'mainline', 'master', and 'trunk' are hardcoded, there is no need to add them to the array
),
'add_admin_only' => false,
'add_groups_only' => array(),
'edit_name_admin_only' => false,
'edit_branches_admin_only' => false,
'permission_check' => false,
'readme_mode' => 'enabled',
'fetch' => array('maximum' => 0), // defaults to 0 (disabled)
'allow_view_settings' => true, // defaults to true
'max_cache_value_size' => '8M',
'max_branch_paths' => 10000,
'reject_oversized' => false,
),
'queue' => array(
'workers' => 3, // defaults to 3
'worker_lifetime' => 595, // defaults to 10 minutes (less 5 seconds)
'worker_task_timeout' => 1800, // defaults to 30 minutes
'worker_memory_limit' => '1G', // defaults to 1 gigabyte
),
'redis' => array(
'options' => array(
'password' => null, // defaults to null
'namespace' => 'Swarm',
'server' => array(
'host' => 'localhost', // defaults to 'localhost'
'port' => '7379', // defaults to '7379'
),
),
'items_batch_size' => 100000, // write batching (MSET)
'items_read_batch_size' => 1000, // read batching (MGET)
'items_read_batch_bytes' => '16M', // byte-based read batching
'check_integrity' => '03:00',// defaults to '03:00'
'population_lock_timeout' => 300, // defaults to 300 seconds
'project_read_memo_ttl' => 30, // project reuse lifetime
'project_read_memo_max_memory' => '256M', // project reuse memory limit
'project_summary_key' => true, // project summaries
'compress_threshold' => '0', // compression disabled
'compress_algorithm' => 'auto', // compression algorithm
'project_l1_cache' => false, // host-wide project cache
),
'reviews' => array(
'patterns' => array(
'octothorpe' => array( // #review or #review-1234 with surrounding whitespace/eol
'regex' => '/(?P<pre>(?:\s|^)\(?)\#(?P<keyword>review|append|replace)(?:-(?P<id>[0-9]+))?(?P<post>[.,!?:;)]*(?=\s|$))/i',
'spec' => '%pre%#%keyword%-%id%%post%',
'insert' => "%description%\n\n#review-%id%",
'strip' => '/^\s*\#(review|append|replace)(-[0-9]+)?(\s+|$)|(\s+|^)\#(review|append|replace)(-[0-9]+)?\s*$/i',
),
'leading-square' => array( // [review] or [review-1234] at start
'regex' => '/^(?P<pre>\s*)\[(?P<keyword>review|append|replace)(?:-(?P<id>[0-9]+))?\](?P<post>\s*)/i',
'spec' => '%pre%[%keyword%-%id%]%post%',
),
'trailing-square' => array( // [review] or [review-1234] at end
'regex' => '/(?P<pre>\s*)\[(?P<keyword>review|append|replace)(?:-(?P<id>[0-9]+))?\](?P<post>\s*)?$/i',
'spec' => '%pre%[%keyword%-%id%]%post%',
),
),
'filters' => array(
'filter-max' => 15,
'result_sorting' => true,
'date_field' => 'updated', // 'created' displays and sorts by created date, 'updated' displays and sorts by last updated
),
'cleanup' => array(
'mode' => 'user', // auto - follow default, user - present checkbox(with default)
'default' => false, // clean up pending changelists on commit
'reopenFiles' => false, // re-open any opened files into the default changelist
),
'statistics' => array(
'complexity' => array(
'calculation' => 'default', // 'default|disabled'
'high' => 300,
'low' => 30
),
),
'allow_author_change' => true,
'allow_author_obliterate' => false,
'commit_credit_author' => true,
'commit_timeout' => 1800, // 30 minutes
'disable_approve_when_tasks_open' => false,
'disable_commit' => true,
'disable_self_approve' => false,
'disable_state_change_after_commit' => false,
'end_states' => array('archived', 'rejected', 'approved:commit'),
'expand_all_file_limit' => 10,
'expand_group_reviewers' => false,
'ignored_users' => array(),
'max_secondary_navigation_items' => 6, // defaults to 6
'max_files' => 0, // defaults to 0
'auto_resolve' => false // defaults to false
'moderator_approval' => 'any', // 'any|each'
'more_context_lines' => 10, // defaults to 10 lines
'process_shelf_delete_when' => array(),
'sync_descriptions' => true,
'unapprove_modified' => true,
), 'search' => array(
'maxlocktime' => 5000, // 5 seconds, in milliseconds
'max_scan_rows' => 250000, // maximum rows scanned by fallback file search
'p4_search_host' => 'http://myhelixsearch.mydomain.com:4567',
// optional URL to the P4 Search host
),
'security' => array(
'disable_system_info' => false,
'email_restricted_changes' => false,
'emulate_ip_protections' => false, // defaults to false
'https_port' => null,
'https_strict' => false,
'https_strict_redirect' => true,
'x_frame_options' => 'SAMEORIGIN', // X-Frame-Options header to send - set false to disable
'x_xss_protection' => '1; mode=block', // X-XSS-Protection header to send - set 0 to disable
'x_content_type_options' => 'nosniff', // X-Content-Type-Options header to send
'referrer_policy' => 'strict-origin-when-cross-origin', // Referrer-Policy header to send
'strict_transport_security_policy' => 'max-age=15724800', // Strict-Transport-Security header to send
'subresource_integrity' => '', // Subresource-Integrity header to send - pattern: script-src `hashValue`
'content_security_policy'=> '', // Content-Security-Policy header to send
'restrict_review_comments' => true, // defaults to true
'permissions_policy' => '', // Permissions-Policy header to send - pattern: geolocation=(self 'https://ex.com'), camera=(), microphone=()
'forwarded_address' => false // X-Forwarded-For header used for systems that are running load balancers or proxies in front of Helix P4 Code Review
'auto_create_user' => '', // By default, no value is set, which means no auto-creation of users will happen.
// To allow auto-creation of users, set to true.
'require_login' => true,
'prevent_login' => array(
'service_user1',
'service_user2',
),
),
'session' => array(
'cookie_lifetime' => 0, // lifetime in seconds, default value is 0=expire when browser closed
'remembered_cookie_lifetime' => 60*60*24*30, // lifetime in seconds, default value is 30 days
'cookie_samesite' => 'lax' // SameSite attribute to prevent the web browser from sending the cookie in cross-site requests
// default is 'lax' 'strict'|'lax'|'none'
'user_login_status_cache' => 10, // Set in seconds, default value is 10 seconds.
// Set to 0 to disable the cache and make P4 Code Review
// check the user login status for every call to Helix Server.
'gc_maxlifetime' => 60*60*24*30, // lifetime in seconds, default value is 30 days
'gc_divisor' => 100, // 100 user requests
),
'short_links' => array(
'hostname' => 'myho.st',
'external_url' => 'https://myho.st:port/sub-folder',
),
'slack' => array(
'token' => 'TOKEN',
'project_channels' => array(
'myproject' => array('myproject-channel',), // The P4 Code Review project ID must be in lower case letters.
// For project 'myproject' the slack notification
// will go into the Slack channel 'myproject-channel'.
),
'summary_file_names' => false, // Attaches the file to the original notification message sent to a Slack channel.
'bypass_restricted_changelist' => false, // Allows P4 Code Review to post notification messages to a Slack channel when a change is committed
// or a review is created for a restricted changelist, default value is false.
'summary_file_limit' => 10, // Limits the number of files shown in the original notification message sent to a Slack channel, default value is 10.
'user' => array(
'enabled' => true, // Forces the Swarm app to use the custom username, overrides the P4 Code Review app details.
'name' => 'Helix Swarm', // This is the username shown in the Slack channel when a notification is posted.
'icon' => 'URL', // This is the avatar icon shown in the Slack channel
// when a notification is posted, overrides the avatar set in the P4 Code Review app.
'force_user_header' => false, // The Slack notification shows the username and avatar only for the first post by a user, default value is false.
),
),
'tag_processor' => array(
'tags' => array(
'wip' => '/(^|\s)+#wip($|\s)+/i'
),
),
'test_definitions' => array(
'project_and_branch_separator' => ':',
),
'translator' => array(
'detect_locale' => true,
'locale' => array("en_GB", "en_US"),
'translation_file_patterns' => array(),
'non_utf8_encodings' => array('sjis', 'euc-jp', 'windows-1252'),
'utf8_convert' => true,
),
'upgrade' => array(
'status_refresh_interval' => 10, // Refresh page every 10 seconds
'batch_size' => 1000, // Fetch 1000 reviews to lower memory usage
),
'users' => array(
'dashboard_refresh_interval' => 300000, // Default 300000 milliseconds
'display_fullname' => true,
'settings' => array(
'review_preferences' => array(
'show_comments_in_files' => true,
'view_diffs_side_by_side' => true,
'show_space_and_new_line_characters' => false,
'ignore_whitespace' => false,
),
'time_preferences' => array(
'display' => 'Timeago', // Default to 'Timeago' but can be set to 'Timestamp'
),
),
),
'webhooks' => array(
'retry_schedule' => (30, 60, 180), // Retry delays in seconds.
'timeout' => 10, // Delivery timeout in seconds.
'failure_threshold' => 25, // Disable webhook after this many consecutive failures.
'ssrf_allowlist' => (), // Hosts/IPs allowed to bypass SSRF protection.
'delivery_retention_count' => 200, // Maximum delivery records retained per webhook.
'rate_limit' => null, // Reserved for future use.
'delivery_retention_lifetime' => '30 days', // Remove delivery records older than this age.
),
'workflow' => array(
'enabled' => true, // Switches the workflow feature on. Default is true
),
'xhprof' => array(
'slow_time' => 3,
'ignored_routes' => array('download', 'imagick', 'libreoffice', 'worker'),
),
'saml' => array(...), // This configurable will be removed from P4 Code Review in a later release.
);