Installation

  1. Download the plugin ZIP package.

  2. Go to Administration → Plugin → + Upload Plugin zip to upload the plugin.

  3. Restart the TeamCity server to load the plugin.

  4. After restarting, the VisionByte VCS root type will be available in the Add VCS Root dialog.

System Requirements

Server

  • TeamCity Server Requirements: TeamCity System Requirements.

  • TeamCity Version Compatibility: TeamCity 2022.04.6 (build 109057) or later.

  • TeamCity Plugin API version: 2025.03 (build 186049)

  • OpenJDK Version: OpenJDK 8 or later

  • Support platforms:

    • Ubuntu 18.04 or later for Intel(x86_64)

    • Windows 10 for Intel(x64)

    • Windows 11 for Intel(x64)

    • Windows Server 2012 R2 for Intel(x64)

    • Windows Server 2016 for Intel(x64)

    • Windows Server 2019 for Intel(x64)

    • Windows Server 2022 for Intel(x64)

    • macOS 15+ for Apple silicon (arm64)

Agent

  • Support platforms:

    • Ubuntu 18.04 or later for Intel(x86_64)

    • Windows 10 for Intel(x64)

    • Windows 11 for Intel(x64)

    • Windows Server 2012 R2 for Intel(x64)

    • Windows Server 2016 for Intel(x64)

    • Windows Server 2019 for Intel(x64)

    • Windows Server 2022 for Intel(x64)

    • macOS 15+ for Apple silicon (arm64)

Authentication

The plugin currently supports the following authentication method:

  • Username / Password - Basic HTTP/HTTPS authentication

When creating a project using From a repository URL, the connection to the remote repository can only be established using a username/password combination.

Configuring VCS Roots

  1. Navigate to your project settings → Version Control Settings → + Add VCS Root.

  2. You can add a VCS root via <Guess from repository URL>. However, in this mode:

    • The Default branch is set to trunk by default.

    • The Branch specification is set to +*.

    For more configuration options, select Type of VCS: VisionByte when adding the VCS root.

  3. Configure the following fields:

    • Repository URL - Full VisionByte repository URL (e.g. http://your-server/repo)

    • Default branch - Main branch to monitor (usually trunk)

    • Branch specification - Branch matching rules

    • Username / Password - For HTTP/HTTPS authentication

    • Proxy (optional) - HTTP/HTTPS proxy configuration

    • Minimum polling interval - Interval for collecting changes. Setting this value below 1 minute is not recommended, as frequent polling may cause instability.

    • Clean before update - Removes build-script generated files during checkout

    • Revert before update - Restores modified files during checkout

    • Clone private branches - Enables checkout of private branches

    • Clone unversioned files - Includes unversioned content in the checkout

  4. Click Test Connection to verify repository access.

  5. Save and attach the VCS root to your build configuration.

Refer to the official TeamCity documentation for syntax and usage details.

VCS Checkout Rules

Only server-side checkout supports checkout rules, which can be used to specify the exact files to be checked out. Anget-side checkout does not support checkout rules.