Configuring shadow folders

A shadow folder contains a reference copy of the current files in a repository. Files are automatically updated when changes are checked in. Use shadow folders to provide read-only access to non-Surround SCM users or to provide a central location to build releases from.

For example, WysiCorp wants to create a shadow folder for their existing web server directory. The existing directory, which is not empty, is at C:\Inetpub\wwwroot.

  • First, the administrator renames wwwroot to wwwroot2 in the C:\Inetpub directory. The administrator also archives wwwroot2 in case a file was not checked in.
  • Next, a new empty directory named wwwroot is created in the C:\Inetpub directory. A shadow folder is created for wwwroot.
  • After waiting for Surround SCM to copy the files into the new directory, the administrator manually copies any files that were not checked in from wwwroot2 to the new wwwroot directory. The files also need to be added to Surround SCM.
Surround SCM does not automatically create shadow folders because of security concerns. This also gives the administrator greater control over where shadow folders are created. If Surround SCM automatically created shadow folders, a hacker could fill up the hard drive with unnecessary files. A hacker could also specify the Windows system folder as the shadow folder and then check in DLLs that contain a virus.

1. Choose Tools > Administration > Shadow Folders.

The Shadow Folders dialog box opens. Icons indicate the type and status of the branch associated with a shadow folder, which can help you troubleshoot any issues with updating folders. See Branch status icons.

2. Click Add to create a shadow folder. See Adding shadow folders.

3. Select a folder and click Edit to change it. See Editing shadow folders.

4. Select a folder and click Force Update to update it. See Refreshing shadow folder contents.

5. Select a folder and click Delete to delete it. See Deleting shadow folders.

6. Click Close when you finish.

You can also use triggers to perform the same functionality as shadow folders, but triggers are more complicated to use. For a trigger to update files on a network share, you must create a script using the CLI or a programming language. Shadow folders automatically update files regardless of any action performed on them, but triggers run based on actions. You must select the action to perform when you create a trigger. For example, you could create a trigger that updates files on a network share when a changelist is committed.