Share Recce Instance Access

Note

Recce Cloud is currently in private alpha and scheduled for general availability later this year. Sign up to the Recce newsletter to be notified, or email product@datarecce.io to join our design partnership program for early access.

As a Recce Cloud user, you can launch a Recce Instance in Cloud Mode or use GitHub Codespaces. However, both of these methods require a GitHub Access Token, which restricts the usage of Recce to those with GitHub accounts.

For situations in which you would like to share your Recce Instance with non-GitHub users, such as stakeholders or other teams, we currently recommend the use of one of the following third-party utilities:

These services provide an endpoint for your Recce Instance, with optional authentication, that will enable other users to access Recce.

These approaches serve as a workaround to expose a Recce instance to non-GitHub users. We are currently working on official support for enabling this feature without the need for third-party tools.

Provide external access to a Recce Instance

Note

Using these tools requires registering additional accounts, and you may need to subscribe to a paid plan to accommodate your usage and data transfer volume. For details, please refer to the Pricing Plans of ngrok and tailscale.

ngrok

After installing the Ngrok client, you can create an endpoint for the Recce Instance that will allow other users to participate in the dbt PR review process, without any additional tools or setup.

Setup the ngrok agent

ngrok supports multiple platforms, including macOS, Linux, and Windows. Please refer to the official installation guide for details.

Connect your ngrok agent to your ngrok account.
```
ngrok config add-authtoken <TOKEN>
```
Put the Recce Instance online
```
ngrok http <recce-instance-port>
```
Secure access with authentication

ngrok provides a range of authentication options, from basic methods to integration with multiple OAuth providers.
```
# basic auth
ngrok http <recce-instance-port> --basic-auth 'username:password'

# OAuth
ngrok http <recce-instance-port> --oauth=google --oauth-allow-email=user@example.com
```
For the full usage of settings and options, please refer to the ngrok http docs for details.

Tailscale

Tailscale enables you to create your own private network (called a 'Tailnet') and invite members to join it. Once set up, you can easily expose your Recce instance, making it accessible to all devices within the Tailnet.

Setup tailscale

To create a Tailnet, first create an account, then download Tailscale and follow the official guide to continue set-up. Once configured, you can then invite other members to join.

It also supports integration with GitHub Codespaces.
Connect your device to your account
```
tailscale up --authkey <AUTH_KEY>
```
Put the Recce Instance online

The devices within your Tailnet can access the Recce Instance now.
```
tailscale serve <recce-instance-port>
```
If you need a more fine-grained access control policy, please refer to the Tailscale docs.