> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# cci-labs/site-to-site-connectivity

A CircleCI orb for setting up site to site connectivity via CircleCI tunnels to enable secure access to private repositories and resources


## Commands

### cleanup

Cleanup CircleCI tunnel and remove IP policy rules


| Parameter | Type | Default | Description |
|---|---|---|---|
| `debug` | boolean | false | Enable debug mode |

### setup

Setup CircleCI tunnel for site to site connectivity. Configures HTTPS_PROXY and SSH ProxyCommand so subsequent steps (including the built-in checkout) can reach private infrastructure through the tunnel.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `debug` | boolean | false | Enable debug mode |
| `no-proxy` | string |  | Additional comma-separated hosts to exclude from the proxy |
| `registration-retry-attempts` | integer | 5 | Number of retry attempts for IP registration on 500 errors |
| `registration-retry-delay` | integer | 30 | Seconds to wait between IP registration retry attempts |
| `tunnel-proxy-version` | string | latest | Version of tunnel-proxy to download |
| `verify-tunnel` | boolean | true | Verify the connection before exiting |
| `verify-tunnel-attempts` | integer | 5 | Number of attempts to verify each tunnel is reachable |

## Examples

### site_to_site_workflow

Example workflow demonstrating how to use the site to site connectivity orb to access private repositories via CircleCI tunnel. After setup, use the built-in checkout step — SSH is routed through tunnel-proxy automatically.


```yaml
version: '2.1'
orbs:
  site-to-site-connectivity: your-namespace/site-to-site-connectivity@0.0.1
jobs:
  build-with-private-repo:
    docker:
      - image: cimg/base:current
    steps:
      - site-to-site-connectivity/setup
      - checkout
      - run:
          command: |
            echo "Building application..."
          name: Build application
      - site-to-site-connectivity/cleanup:
          when: always
workflows:
  private-repo-workflow:
    jobs:
      - build-with-private-repo:
          context:
            - site-to-site-tunnel
```