Open topic with navigation

Comment attachments

Swarm supports attaching arbitrary files to comments in code reviews and jobs.

To store files attached to comments, Swarm looks for a depot named //.swarm. As Swarm does not create this depot, you need to create it, or specify another depot that the Swarm admin user can write to.

To create a //.swarm depot, run the following as a user with admin-level privileges:

$ p4 depot .swarm

Ensure that the Swarm admin user can write to the //.swarm depot.

For information on creating depots, see Working with depots in Helix Core Server Administrator Guide: Fundamentals.

Specifying a depot path for comment attachments, if you prefer not to use the default //.swarm depot, is done with the depot_storage configuration block in the SWARM_ROOT/data/config.php file:

<?php
    // this block should be a peer of 'p4'
    'depot_storage' => array(
        'base_path'  => '//depot_name',
    ),

Replace depot_name with the depot where comment attachments should be stored. The Swarm admin needs to be able to write to this depot.

You can limit the size of comment attachments with the attachments configuration block in the SWARM_ROOT/data/config.php file:

<?php
    // this block should be a peer of 'p4'
    'attachments' => array(
        'max_file_size'  => 0, // the maximum file size to accept in bytes
),

Replace the 0 with the maximum file size in bytes that you want Swarm to accept for a comment attachment. If the file size is exceeded, users will see an error.