ContextQMD
Back to Daytona

VPN Connections

apps/docs/src/content/docs/en/vpn-connections.mdx

0.179.040.0 KB
Original Source

import { TabItem, Tabs } from '@astrojs/starlight/components'

VPN connections are a way to connect your Daytona sandboxes to private networks. By establishing a VPN connection, your sandbox can access network resources using private IP addresses and can be accessed by other devices on the same VPN network.

This integration enables communication between your development environment and existing infrastructure, allowing you to test applications against services within the private network, access shared development resources, and collaborate with team members.

Daytona supports the following VPN network providers:

:::note For connecting to a VPN network, you need to create or access your Daytona sandbox, have access to your VPN network provider credentials, and be on Tier 3 or higher. :::

Tailscale

Daytona provides multiple ways to connect to a Daytona sandbox with a Tailscale network:

When you connect a Daytona sandbox to a Tailscale network, the sandbox becomes part of your private Tailscale network, allowing you to access resources that are available within the network and enabling other devices on the network to access the sandbox.

This integration makes your sandbox appear as a device within your Tailscale network, with its own Tailscale IP address and access to other devices and services on the network.

Tailscale browser login

The browser login method initiates an interactive authentication flow where Tailscale generates a unique login URL that you visit in your web browser to authenticate the Dayona sandbox.

The process involves installing Tailscale, starting the daemon, initiating the login process, and then polling for the authentication status until the connection is established.

The following snippet demonstrates connecting to a Tailscale network using a browser login.

<Tabs syncKey="language"> <TabItem label="Python" icon="seti:python">
python
from daytona import Daytona, DaytonaConfig
import time
import re

# Configuration
DAYTONA_API_KEY = "YOUR_API_KEY" # Replace with your API key

# Initialize the Daytona client
config = DaytonaConfig(api_key=DAYTONA_API_KEY)
daytona = Daytona(config)

def setup_tailscale_vpn_interactive():
    """
    Connect a Daytona sandbox to a Tailscale network using the Python SDK.
    Uses interactive login via browser URL (no auth key required).
    """
    # Create the sandbox
    print("Creating sandbox...")
    sandbox = daytona.create()
    print(f"Sandbox created: {sandbox.id}")

    # Step 1: Install Tailscale
    print("\nInstalling Tailscale (this may take a few minutes)...")
    response = sandbox.process.exec(
        "curl -fsSL https://tailscale.com/install.sh | sh",
        timeout=300
    )
    if response.exit_code != 0:
        print(f"Error installing Tailscale: {response.result}")
        return sandbox
    print("Tailscale installed successfully.")

    # Step 2: Start tailscaled daemon in background
    print("\nStarting tailscaled daemon...")
    sandbox.process.exec("nohup sudo tailscaled > /dev/null 2>&1 &", timeout=10)

    # Wait for daemon to initialize
    time.sleep(3)

    # Step 3: Run tailscale up in background and capture output to a file
    print("\nInitiating Tailscale login...")
    sandbox.process.exec(
        "sudo tailscale up > /tmp/tailscale-login.txt 2>&1 &",
        timeout=10
    )

    # Wait for the login URL to be written to the file
    time.sleep(3)

    # Read the login URL from the output file
    response = sandbox.process.exec("cat /tmp/tailscale-login.txt", timeout=10)
    output = response.result
    url_match = re.search(r'https://login\.tailscale\.com/a/[^\s]+', output)

    if url_match:
        login_url = url_match.group(0)
        print(f"\n{'='*60}")
        print("To authenticate, visit this URL in your browser:")
        print(f"\n  {login_url}")
        print(f"\n{'='*60}")
        print("\nWaiting for authentication...")

        # Poll for connection status
        max_wait = 300
        poll_interval = 5
        waited = 0

        while waited < max_wait:
            time.sleep(poll_interval)
            waited += poll_interval

            status_response = sandbox.process.exec("tailscale status 2>&1", timeout=30)
            status_output = status_response.result

            # Check if connected
            if status_response.exit_code == 0 and "logged out" not in status_output.lower():
                # Verify IP is assigned
                ip_response = sandbox.process.exec("tailscale ip -4 2>&1", timeout=10)
                if ip_response.exit_code == 0 and ip_response.result.strip():
                    print(f"\nConnected to Tailscale network!")
                    print(f"Tailscale IP: {ip_response.result.strip()}")
                    break

            print(f"  Still waiting... ({waited}s)")
        else:
            print("\nTimeout waiting for authentication. Please try again.")
            return sandbox
    else:
        # Already connected or different output
        print(f"Output from tailscale up:\n{output}")

        # Check if already connected
        status_response = sandbox.process.exec("tailscale status", timeout=30)
        if status_response.exit_code == 0:
            print("\nTailscale status:")
            print(status_response.result)

    # Final status check
    print("\nFinal Tailscale status:")
    response = sandbox.process.exec("tailscale status", timeout=30)
    print(response.result)

    return sandbox

if __name__ == "__main__":
    sandbox = setup_tailscale_vpn_interactive()
</TabItem> <TabItem label="TypeScript" icon="seti:typescript">
typescript
import { Daytona } from '@daytona/sdk'

// Configuration
const DAYTONA_API_KEY = 'YOUR_API_KEY' // Replace with your API key

// Initialize the Daytona client
const daytona = new Daytona({
  apiKey: DAYTONA_API_KEY,
})

function sleep(ms: number): Promise<void> {
  return new Promise(resolve => setTimeout(resolve, ms))
}

async function setupTailscaleVpnInteractive(): Promise<void> {
  /**
   * Connect a Daytona sandbox to a Tailscale network using the TypeScript SDK.
   * Uses interactive login via browser URL (no auth key required).
   */

  // Create the sandbox
  console.log('Creating sandbox...')
  const sandbox = await daytona.create()
  console.log(`Sandbox created: ${sandbox.id}`)

  // Step 1: Install Tailscale
  console.log('\nInstalling Tailscale (this may take a few minutes)...')
  let response = await sandbox.process.executeCommand(
    'curl -fsSL https://tailscale.com/install.sh | sh',
    undefined, // cwd
    undefined, // env
    300 // timeout
  )
  if (response.exitCode !== 0) {
    console.log(`Error installing Tailscale: ${response.result}`)
    return
  }
  console.log('Tailscale installed successfully.')

  // Step 2: Start tailscaled daemon in background
  console.log('\nStarting tailscaled daemon...')
  await sandbox.process.executeCommand(
    'nohup sudo tailscaled > /dev/null 2>&1 &',
    undefined, // cwd
    undefined, // env
    10 // timeout
  )

  // Wait for daemon to initialize
  await sleep(3000)

  // Step 3: Run tailscale up in background and capture output to a file
  console.log('\nInitiating Tailscale login...')
  await sandbox.process.executeCommand(
    'sudo tailscale up > /tmp/tailscale-login.txt 2>&1 &',
    undefined, // cwd
    undefined, // env
    10 // timeout
  )

  // Wait for the login URL to be written to the file
  await sleep(3000)

  // Read the login URL from the output file
  response = await sandbox.process.executeCommand(
    'cat /tmp/tailscale-login.txt',
    undefined, // cwd
    undefined, // env
    10 // timeout
  )
  const output = response.result || ''
  const urlMatch = output.match(/https:\/\/login\.tailscale\.com\/a\/[^\s]+/)

  if (urlMatch) {
    const loginUrl = urlMatch[0]
    console.log('\n' + '='.repeat(60))
    console.log('To authenticate, visit this URL in your browser:')
    console.log(`\n  ${loginUrl}`)
    console.log('\n' + '='.repeat(60))
    console.log('\nWaiting for authentication...')

    // Poll for connection status
    const maxWait = 300 // 5 minutes max wait
    const pollInterval = 5
    let waited = 0

    while (waited < maxWait) {
      await sleep(pollInterval * 1000)
      waited += pollInterval

      const statusResponse = await sandbox.process.executeCommand(
        'tailscale status 2>&1',
        undefined, // cwd
        undefined, // env
        30 // timeout
      )
      const statusOutput = statusResponse.result || ''

      // Check if we're connected (status shows our machine without login prompt)
      if (
        statusResponse.exitCode === 0 &&
        !statusOutput.toLowerCase().includes('logged out')
      ) {
        // Verify we have an IP assigned
        const ipResponse = await sandbox.process.executeCommand(
          'tailscale ip -4 2>&1',
          undefined, // cwd
          undefined, // env
          10 // timeout
        )
        if (ipResponse.exitCode === 0 && ipResponse.result?.trim()) {
          console.log('\nConnected to Tailscale network!')
          console.log(`Tailscale IP: ${ipResponse.result.trim()}`)
          break
        }
      }

      console.log(`  Still waiting... (${waited}s)`)
    }

    if (waited >= maxWait) {
      console.log('\nTimeout waiting for authentication. Please try again.')
      return
    }
  } else {
    // Maybe already connected or different output
    console.log(`Output from tailscale up:\n${output}`)

    // Check if already connected
    const statusResponse = await sandbox.process.executeCommand(
      'tailscale status',
      undefined, // cwd
      undefined, // env
      30 // timeout
    )
    if (statusResponse.exitCode === 0) {
      console.log('\nTailscale status:')
      console.log(statusResponse.result)
    }
  }

  // Final status check
  console.log('\nFinal Tailscale status:')
  response = await sandbox.process.executeCommand(
    'tailscale status',
    undefined, // cwd
    undefined, // env
    30 // timeout
  )
  console.log(response.result)
}

// Run the main function
setupTailscaleVpnInteractive().catch(console.error)
</TabItem> </Tabs>

Once the connection is established and authentication is complete, the sandbox will maintain its connection as long as the service is running.

Tailscale auth key

Using an auth key provides a non-interactive way to connect your Daytona sandbox to Tailscale, making it suitable for automated scripts, CI/CD pipelines, or any scenario where manual browser interaction is not available.

  1. Access your Tailscale admin console ↗
  2. Click Add device and select Linux server
  3. Apply the configuration and click Generate install script

This will generate a script that you can use to install Tailscale and connect to the Tailscale network.

bash
curl -fsSL https://tailscale.com/install.sh | sh && sudo tailscale up --auth-key=tskey-auth-<AUTH_KEY>

Copy the auth key from the generated script and use it to connect your Daytona sandbox to Tailscale:

<Tabs syncKey="language"> <TabItem label="Python" icon="seti:python">
python
from daytona import Daytona, DaytonaConfig
import time

# Configuration
DAYTONA_API_KEY = "YOUR_API_KEY" # Replace with your API key
TAILSCALE_AUTH_KEY = "YOUR_AUTH_KEY" # Replace with your auth key

# Initialize the Daytona client
config = DaytonaConfig(api_key=DAYTONA_API_KEY)
daytona = Daytona(config)


def setup_tailscale_vpn(auth_key: str):
"""
Connect a Daytona sandbox to a Tailscale network using the Python SDK.
Uses auth-key for non-interactive authentication.
"""
# Create the sandbox
print("Creating sandbox...")
sandbox = daytona.create()
print(f"Sandbox created: {sandbox.id}")

# Step 1: Install Tailscale
print("\nInstalling Tailscale (this may take a few minutes)...")
response = sandbox.process.exec(
    "curl -fsSL https://tailscale.com/install.sh | sh",
    timeout=300
)
if response.exit_code != 0:
    print(f"Error installing Tailscale: {response.result}")
    return sandbox
print("Tailscale installed successfully.")

# Step 2: Start tailscaled daemon manually (systemd doesn't auto-start in sandboxes)
print("\nStarting tailscaled daemon...")
sandbox.process.exec("nohup sudo tailscaled > /dev/null 2>&1 &", timeout=10)

# Wait for daemon to initialize
time.sleep(3)

  # Step 3: Connect with auth key
  print("\nConnecting to Tailscale network...")
  response = sandbox.process.exec(
      f"sudo tailscale up --auth-key={auth_key}",
      timeout=60
  )

  if response.exit_code != 0:
      print(f"Error connecting: {response.result}")
      return sandbox

  print("Connected to Tailscale network.")

  # Verify connection status
  print("\nChecking Tailscale status...")
  response = sandbox.process.exec("tailscale status", timeout=30)
  print(f"Status:\n{response.result}")

  return sandbox


if __name__ == "__main__":
  sandbox = setup_tailscale_vpn(TAILSCALE_AUTH_KEY)
</TabItem> <TabItem label="TypeScript" icon="seti:typescript">
typescript
import { Daytona } from '@daytona/sdk'

// Configuration
const DAYTONA_API_KEY = 'YOUR_API_KEY' // Replace with your API key
const TAILSCALE_AUTH_KEY = 'YOUR_AUTH_KEY' // Replace with your auth key

// Initialize the Daytona client
const daytona = new Daytona({
  apiKey: DAYTONA_API_KEY,
})

function sleep(ms: number): Promise<void> {
  return new Promise(resolve => setTimeout(resolve, ms))
}

async function setupTailscaleVpn(authKey: string): Promise<void> {
  /**
   * Connect a Daytona sandbox to a Tailscale network using the TypeScript SDK.
   * Uses auth-key for non-interactive authentication.
   */

  // Create the sandbox
  console.log('Creating sandbox...')
  const sandbox = await daytona.create()
  console.log(`Sandbox created: ${sandbox.id}`)

  // Step 1: Install Tailscale
  console.log('\nInstalling Tailscale (this may take a few minutes)...')
  let response = await sandbox.process.executeCommand(
    'curl -fsSL https://tailscale.com/install.sh | sh',
    undefined, // cwd
    undefined, // env
    300 // timeout
  )
  if (response.exitCode !== 0) {
    console.log(`Error installing Tailscale: ${response.result}`)
    return
  }
  console.log('Tailscale installed successfully.')

  // Step 2: Start tailscaled daemon manually (systemd doesn't auto-start in sandboxes)
  console.log('\nStarting tailscaled daemon...')
  await sandbox.process.executeCommand(
    'nohup sudo tailscaled > /dev/null 2>&1 &',
    undefined, // cwd
    undefined, // env
    10 // timeout
  )

  // Wait for daemon to initialize
  await sleep(3000)

  // Step 3: Connect with auth key
  console.log('\nConnecting to Tailscale network...')
  response = await sandbox.process.executeCommand(
    `sudo tailscale up --auth-key=${authKey}`,
    undefined, // cwd
    undefined, // env
    60 // timeout
  )

  if (response.exitCode !== 0) {
    console.log(`Error connecting: ${response.result}`)
    return
  }

  console.log('Connected to Tailscale network.')

  // Verify connection status
  console.log('\nChecking Tailscale status...')
  response = await sandbox.process.executeCommand(
    'tailscale status',
    undefined, // cwd
    undefined, // env
    30 // timeout
  )
  console.log(`Status:\n${response.result}`)
}

// Run the main function
setupTailscaleVpn(TAILSCALE_AUTH_KEY).catch(console.error)
</TabItem> </Tabs>

Once the connection is established and authentication is complete, the sandbox will maintain its connection as long as the service is running.

Tailscale web terminal

For working directly in the terminal or for more control over the Tailscale connection process, you can set up Tailscale manually through the Daytona web terminal or SSH.

This approach provides visibility into each step of the installation and connection process, and allows you to customize the setup if needed. The process involves installing Tailscale, starting the daemon in a persistent session using tmux, and then authenticating through the interactive login flow.

  1. Navigate to your sandbox web terminal in Daytona Dashboard ↗, or access it via SSH
  2. Install Tailscale using the official installation script:
bash
curl -fsSL https://tailscale.com/install.sh | sh

This begins the Tailscale installation process and initializes the Tailscale CLI inside the sandbox. Daytona requires the Tailscale daemon to be running in the background to connect the sandbox to the Tailscale network.

The recommended approach is to run it in a detached tmux (or similar) session to ensure the daemon is running in the background:

  1. Install tmux
bash
sudo apt install tmux
  1. Start the Tailscale daemon in a detached tmux session
bash
tmux new -d -s tailscale 'sudo tailscaled'
  1. Connect and authenticate your sandbox with the Tailscale network
bash
sudo tailscale up
  1. Visit the authentication URL in the web browser and follow the instructions to authenticate
txt
To authenticate, visit:
https://login.tailscale.com/a/<id>

Once authenticated, you will see the following confirmation message:

txt
Your device <id> is logged in to the <address> tailnet.

You've now successfully connected your Daytona sandbox to your Tailscale network. The sandbox should appear in your Tailscale dashboard.

OpenVPN

Daytona provides multiple ways to connect to a Daytona sandbox with an OpenVPN network:

OpenVPN uses a client-server model where your Daytona sandbox acts as a client connecting to an OpenVPN server. This approach is suitable for connecting to existing corporate VPNs, accessing resources behind firewalls, or integrating with infrastructure that already uses OpenVPN.

:::note Connecting a Daytona sandbox to OpenVPN network requires a client configuration file. :::

OpenVPN client configuration file

Client configuration file contains the connection parameters, certificates, and keys required to establish a secure connection to your OpenVPN server. This file is typically provided by your network administrator or generated from your OpenVPN server setup.

The configuration file should be named client.ovpn or similar, and it must contain all the required connection settings, including server address, port, protocol, encryption settings, and authentication credentials. To create this file, you can use a text editor such as nano or vim, or upload it to your sandbox if you have it prepared elsewhere.

The following snippet is an example of a client configuration file. Replace the placeholders with the actual values provided by your OpenVPN server.

bash
client
proto udp
explicit-exit-notify
remote <YOUR_OPENVPN_SERVER_IP> <YOUR_OPENVPN_SERVER_PORT>
dev tun
resolv-retry infinite
nobind
persist-key
persist-tun
remote-cert-tls server
verify-x509-name <YOUR_OPENVPN_SERVER_NAME> name
auth SHA256
auth-nocache
cipher AES-128-GCM
ignore-unknown-option data-ciphers
data-ciphers AES-128-GCM
ncp-ciphers AES-128-GCM
tls-client
tls-version-min 1.2
tls-cipher TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256
tls-ciphersuites TLS_AES_256_GCM_SHA384:TLS_AES_128_GCM_SHA256:TLS_CHACHA20_POLY1305_SHA256
ignore-unknown-option block-outside-dns
setenv opt block-outside-dns # Prevent Windows 10 DNS leak
verb 3
<ca>
-----BEGIN CERTIFICATE-----
<YOUR_OPENVPN_SERVER_CERTIFICATE>
-----END CERTIFICATE-----
</ca>
<cert>
-----BEGIN CERTIFICATE-----
<YOUR_OPENVPN_CLIENT_CERTIFICATE>
-----END CERTIFICATE-----
</cert>
<key>
-----BEGIN PRIVATE KEY-----
<YOUR_OPENVPN_CLIENT_PRIVATE_KEY>
-----END PRIVATE KEY-----
</key>
<tls-crypt-v2>
-----BEGIN OpenVPN tls-crypt-v2 client key-----
<YOUR_OPENVPN_TLS_CRYPT_V2_CLIENT_KEY>
-----END OpenVPN tls-crypt-v2 client key-----
</tls-crypt-v2>

OpenVPN client configuration

The following snippets demonstrate connecting to an OpenVPN network using a client configuration file.

<Tabs> <TabItem label="Python" icon="seti:python"> ```python from daytona import Daytona, DaytonaConfig import time

Configuration

DAYTONA_API_KEY = "YOUR_API_KEY" # Replace with your API key

OpenVPN client configuration (paste your .ovpn config here)

OPENVPN_CONFIG = """ """.strip()

Initialize the Daytona client

config = DaytonaConfig(api_key=DAYTONA_API_KEY) daytona = Daytona(config)

def setup_openvpn(ovpn_config: str): """ Connect a Daytona sandbox to an OpenVPN network using the Python SDK. """ # Create the sandbox print("Creating sandbox...") sandbox = daytona.create() print(f"Sandbox created: {sandbox.id}")

# Step 1: Install OpenVPN
print("\nInstalling OpenVPN...")
response = sandbox.process.exec(
    "sudo apt update && sudo apt install -y openvpn",
    timeout=120
)
if response.exit_code != 0:
    print(f"Error installing OpenVPN: {response.result}")
    return sandbox
print("OpenVPN installed successfully.")

# Step 2: Write the OpenVPN config file
print("\nWriting OpenVPN configuration...")
sandbox.fs.upload_file(ovpn_config.encode(), "/home/daytona/client.ovpn")
print("Configuration written to /home/daytona/client.ovpn")

# Step 3: Start OpenVPN in background
print("\nStarting OpenVPN tunnel...")
sandbox.process.exec(
    "nohup sudo openvpn /home/daytona/client.ovpn > /tmp/openvpn.log 2>&1 &",
    timeout=10
)

# Wait for connection to establish
print("Waiting for VPN connection to establish...")
time.sleep(10)

# Step 4: Verify connection
print("\nVerifying OpenVPN connection...")

# Check if tun interface exists
response = sandbox.process.exec("ip addr show tun0", timeout=10)
if response.exit_code == 0:
    print("VPN tunnel interface (tun0) is up:")
    print(response.result)
else:
    print("Warning: tun0 interface not found. Checking OpenVPN logs...")
    log_response = sandbox.process.exec("cat /tmp/openvpn.log", timeout=10)
    print(f"OpenVPN log:\n{log_response.result}")
    return sandbox

# Get public IP through VPN
print("\nChecking public IP (should be VPN server IP)...")
response = sandbox.process.exec("curl -s ifconfig.me", timeout=30)
if response.exit_code == 0:
    print(f"Public IP: {response.result}")
else:
    print(f"Could not determine public IP: {response.result}")

print("\nOpenVPN connection established successfully.")
return sandbox

if name == "main": sandbox = setup_openvpn(OPENVPN_CONFIG)

```
</TabItem> <TabItem label="TypeScript" icon="seti:typescript"> ```typescript import { Daytona } from '@daytona/sdk';

// Configuration const DAYTONA_API_KEY = "YOUR_API_KEY"; // Replace with your API key

// OpenVPN client configuration (paste your .ovpn config here) const OPENVPN_CONFIG = .trim();

// Initialize the Daytona client const daytona = new Daytona({ apiKey: DAYTONA_API_KEY, });

function sleep(ms: number): Promise<void> { return new Promise(resolve => setTimeout(resolve, ms)); }

async function setupOpenvpn(ovpnConfig: string): Promise<void> { /**

  • Connect a Daytona sandbox to an OpenVPN network using the TypeScript SDK. */

// Create the sandbox console.log("Creating sandbox..."); const sandbox = await daytona.create(); console.log(Sandbox created: ${sandbox.id});

// Step 1: Install OpenVPN console.log("\nInstalling OpenVPN..."); let response = await sandbox.process.executeCommand( "sudo apt update && sudo apt install -y openvpn", undefined, // cwd undefined, // env 120 // timeout ); if (response.exitCode !== 0) { console.log(Error installing OpenVPN: ${response.result}); return; } console.log("OpenVPN installed successfully.");

// Step 2: Write the OpenVPN config file console.log("\nWriting OpenVPN configuration..."); // Use heredoc to write the config file await sandbox.process.executeCommand( cat << 'OVPNEOF' > /home/daytona/client.ovpn ${ovpnConfig} OVPNEOF, undefined, undefined, 30 ); console.log("Configuration written to /home/daytona/client.ovpn");

// Step 3: Start OpenVPN in background console.log("\nStarting OpenVPN tunnel..."); await sandbox.process.executeCommand( "nohup sudo openvpn /home/daytona/client.ovpn > /tmp/openvpn.log 2>&1 &", undefined, // cwd undefined, // env 10 // timeout );

// Wait for connection to establish console.log("Waiting for VPN connection to establish..."); await sleep(10000);

// Step 4: Verify connection console.log("\nVerifying OpenVPN connection...");

// Check if tun interface exists response = await sandbox.process.executeCommand( "ip addr show tun0", undefined, // cwd undefined, // env 10 // timeout ); if (response.exitCode === 0) { console.log("VPN tunnel interface (tun0) is up:"); console.log(response.result); } else { console.log("Warning: tun0 interface not found. Checking OpenVPN logs..."); const logResponse = await sandbox.process.executeCommand( "cat /tmp/openvpn.log", undefined, // cwd undefined, // env 10 // timeout ); console.log(OpenVPN log:\n${logResponse.result}); return; }

// Get public IP through VPN console.log("\nChecking public IP (should be VPN server IP)..."); response = await sandbox.process.executeCommand( "curl -s ifconfig.me", undefined, // cwd undefined, // env 30 // timeout ); if (response.exitCode === 0) { console.log(Public IP: ${response.result}); } else { console.log(Could not determine public IP: ${response.result}); }

console.log("\nOpenVPN connection established successfully."); }

// Run the main function setupOpenvpn(OPENVPN_CONFIG).catch(console.error);

```
</TabItem> </Tabs>

OpenVPN web terminal

Daytona provides a web terminal for interacting with your sandboxes, allowing you to install OpenVPN and connect to your OpenVPN network.

  1. Navigate to your sandbox web terminal in Daytona Dashboard ↗ by clicking on the Terminal icon >_, or access it via SSH

  2. Install OpenVPN and tmux

bash
sudo apt update && sudo apt install -y openvpn tmux
  1. Create the OpenVPN client configuration file for your Daytona sandbox
bash
sudo nano client.ovpn
  1. Save the file by pressing Ctrl+O, then Enter, and exit by pressing Ctrl+X

Daytona requires the OpenVPN tunnel to be running in the background to connect the sandbox to the OpenVPN network. The recommended approach is to run it in a detached tmux (or similar) session:

  1. Start OpenVPN tunnel in a background tmux session
bash
tmux new -d -s openvpn 'sudo openvpn client.ovpn'

This starts the OpenVPN tunnel in a background tmux session that persists even if you disconnect from the sandbox.

  1. Verify the OpenVPN connection by running the following command
bash
curl ifconfig.me

This will return the IP address of the sandbox connected to the OpenVPN network.

You've now successfully connected your Daytona sandbox to your OpenVPN network.

Netbird

Daytona provides multiple ways to connect to a Daytona sandbox with a Netbird network:

When you connect a Daytona sandbox to a Netbird network, the sandbox becomes part of your private Netbird network, allowing you to access resources that are available within the network and enabling other devices on the network to access the sandbox.

This integration makes your sandbox appear as a device within your Netbird network, with its own Netbird IP address and access to other devices and services on the network.

Netbird setup key

Using a Netbird setup key provides a non-interactive way to connect your Daytona sandbox to Netbird, making it suitable for automated scripts, CI/CD pipelines, or any scenario where manual browser interaction is not available.

  1. Access your Netbird dashboard ↗
  2. Click Setup Keys
  3. Create a new setup key or use an existing one

The following snippets demonstrate connecting to a Netbird network using a setup key.

<Tabs syncKey="language"> <TabItem label="Python" icon="seti:python">
python
from daytona import Daytona, DaytonaConfig

# Configuration
DAYTONA_API_KEY = "YOUR_API_KEY"
NETBIRD_SETUP_KEY = "YOUR_SETUP_KEY"

# Initialize the Daytona client
config = DaytonaConfig(api_key=DAYTONA_API_KEY)
daytona = Daytona(config)


def setup_netbird():
    """
    Connect a Daytona sandbox to a NetBird network using the Python SDK.
    Uses the official NetBird install script and a Setup Key for non-interactive auth.
    See: https://docs.netbird.io/manage/peers/access-infrastructure/setup-keys-add-servers-to-network
    """
    if NETBIRD_SETUP_KEY == "YOUR_SETUP_KEY":
        print("Error: please set NETBIRD_SETUP_KEY to a valid setup key.")
        return None

    # Create the sandbox
    print("Creating sandbox...")
    sandbox = daytona.create()
    print(f"Sandbox created: {sandbox.id}")
    print("\nInstalling NetBird via the official install script...")
    install_cmd = (
        "sudo rm -f /etc/apt/sources.list.d/yarn.list && "
        "curl -fsSL https://pkgs.netbird.io/install.sh | sudo sh"
    )
    response = sandbox.process.exec(install_cmd, timeout=300)
    if response.exit_code != 0:
        print(f"Error installing NetBird: {response.result}")
        return sandbox
    print("NetBird installed successfully.")

    # Connect to the NetBird network using the setup key
    print("\nConnecting to NetBird network with setup key...")
    up_cmd = f"sudo netbird up --setup-key {NETBIRD_SETUP_KEY}"
    response = sandbox.process.exec(up_cmd, timeout=120)
    if response.exit_code != 0:
        print(f"Error running 'netbird up': {response.result}")
        return sandbox
    print(response.result)

    # Final status check
    print("\nFinal NetBird status:")
    response = sandbox.process.exec("netbird status", timeout=30)
    print(response.result)

    return sandbox


if __name__ == "__main__":
    sandbox = setup_netbird()
</TabItem> <TabItem label="TypeScript" icon="seti:typescript">
typescript
import { Daytona } from '@daytonaio/sdk';

// Configuration
const DAYTONA_API_KEY = "YOUR_API_KEY";
const NETBIRD_SETUP_KEY = "YOUR_SETUP_KEY";

// Initialize the Daytona client
const daytona = new Daytona({
  apiKey: DAYTONA_API_KEY,
});

async function setupNetbird(): Promise<void> {
  /**
   * Connect a Daytona sandbox to a NetBird network using the TypeScript SDK.
   * Uses the official NetBird install script and a Setup Key for non-interactive auth.
   * See: https://docs.netbird.io/manage/peers/access-infrastructure/setup-keys-add-servers-to-network
   */

  // Create the sandbox
  console.log("Creating sandbox...");
  const sandbox = await daytona.create();
  console.log(`Sandbox created: ${sandbox.id}`);

  // Install NetBird via the official install script
  console.log("\nInstalling NetBird via the official install script...");
  const installCmd = [
    "sudo rm -f /etc/apt/sources.list.d/yarn.list",
    "curl -fsSL https://pkgs.netbird.io/install.sh | sudo sh",
  ].join(" && ");
  let response = await sandbox.process.executeCommand(
    installCmd,
    undefined,  // cwd
    undefined,  // env
    300         // timeout
  );
  if (response.exitCode !== 0) {
    console.log(`Error installing NetBird: ${response.result}`);
    return;
  }
  console.log("NetBird installed successfully.");

  // Connect to the NetBird network using the setup key
  console.log("\nConnecting to NetBird network with setup key...");
  const upCmd = `sudo netbird up --setup-key ${NETBIRD_SETUP_KEY}`;
  response = await sandbox.process.executeCommand(
    upCmd,
    undefined,  // cwd
    undefined,  // env
    120         // timeout
  );
  if (response.exitCode !== 0) {
    console.log(`Error running 'netbird up': ${response.result}`);
    return;
  }
  console.log(response.result);

  // Final status check
  console.log("\nFinal NetBird status:");
  response = await sandbox.process.executeCommand(
    "netbird status",
    undefined,  // cwd
    undefined,  // env
    30          // timeout
  );
  console.log(response.result);
}

// Run the main function
setupNetbird().catch(console.error);
</TabItem> </Tabs>

Netbird browser login

The browser login method initiates an interactive authentication flow where Netbird generates a unique login URL that you visit in your web browser to authenticate the Daytona sandbox.

The following snippets demonstrate connecting to a Netbird network using a browser login.

<Tabs syncKey="language"> <TabItem label="Python" icon="seti:python">
python
from daytona import Daytona, DaytonaConfig
import time
import re

# Configuration
DAYTONA_API_KEY = "YOUR_API_KEY"

# Initialize the Daytona client
config = DaytonaConfig(api_key=DAYTONA_API_KEY)
daytona = Daytona(config)


def setup_netbird():
    """
    Connect a Daytona sandbox to a NetBird network using the Python SDK.
    Uses the official NetBird install script and interactive browser login.
    """
    # Create the sandbox
    print("Creating sandbox...")
    sandbox = daytona.create()
    print(f"Sandbox created: {sandbox.id}")
    # Install NetBird via the official install script
    print("\nInstalling NetBird via the official install script...")
    install_cmd = (
        "sudo rm -f /etc/apt/sources.list.d/yarn.list && "
        "curl -fsSL https://pkgs.netbird.io/install.sh | sudo sh"
    )
    response = sandbox.process.exec(install_cmd, timeout=300)
    if response.exit_code != 0:
        print(f"Error installing NetBird: {response.result}")
        return sandbox
    print("NetBird installed successfully.")

    # Run netbird up in background and capture output to a file
    print("\nInitiating NetBird login...")
    sandbox.process.exec(
        "netbird up > /tmp/netbird-login.txt 2>&1 &",
        timeout=10
    )

    # Wait for the login URL to be written to the file
    time.sleep(5)

    # Read the login URL from the output file
    response = sandbox.process.exec("cat /tmp/netbird-login.txt", timeout=10)
    output = response.result
    url_match = re.search(r'https?://[^\s]+', output)

    if url_match:
        login_url = url_match.group(0)
        print(f"\n{'='*60}")
        print("To authenticate, visit this URL in your browser:")
        print(f"\n  {login_url}")
        print(f"\n{'='*60}")
        print("\nWaiting for authentication...")

        # Poll for connection status
        max_wait = 300  # 5 minutes max wait
        poll_interval = 5
        waited = 0

        while waited < max_wait:
            time.sleep(poll_interval)
            waited += poll_interval

            status_response = sandbox.process.exec("netbird status 2>&1", timeout=30)
            status_output = status_response.result

            # Check if we're connected
            if status_response.exit_code == 0 and "connected" in status_output.lower():
                print(f"\nConnected to NetBird network!")
                print(f"NetBird status:\n{status_output}")
                break

            print(f"  Still waiting... ({waited}s)")
        else:
            print("\nTimeout waiting for authentication. Please try again.")
            return sandbox
    else:
        # Maybe already connected or different output
        print(f"Output from netbird up:\n{output}")

        # Check if already connected
        status_response = sandbox.process.exec("netbird status", timeout=30)
        if status_response.exit_code == 0:
            print("\nNetBird status:")
            print(status_response.result)

    # Final status check
    print("\nFinal NetBird status:")
    response = sandbox.process.exec("netbird status", timeout=30)
    print(response.result)

    return sandbox


if __name__ == "__main__":
    sandbox = setup_netbird()
</TabItem> <TabItem label="TypeScript" icon="seti:typescript">
typescript
import { Daytona } from '@daytonaio/sdk';

// Configuration
const DAYTONA_API_KEY = "YOUR_API_KEY";

// Initialize the Daytona client
const daytona = new Daytona({
  apiKey: DAYTONA_API_KEY,
});

function sleep(ms: number): Promise<void> {
  return new Promise(resolve => setTimeout(resolve, ms));
}

async function setupNetbirdVpnInteractive(): Promise<void> {
  /**
   * Connect a Daytona sandbox to a NetBird network using the TypeScript SDK.
   * Uses the official NetBird install script and interactive browser login.
   */

  // Create the sandbox
  console.log("Creating sandbox...");
  const sandbox = await daytona.create();
  console.log(`Sandbox created: ${sandbox.id}`);

  // Remove the broken Yarn list so apt-get update inside the installer succeeds,
  // then run the official NetBird install script. The script adds the NetBird
  // APT repo, imports the signing key, installs the package, and registers the
  // systemd service.
  console.log("\nInstalling NetBird via the official install script...");
  const installCmd = [
    "sudo rm -f /etc/apt/sources.list.d/yarn.list",
    "curl -fsSL https://pkgs.netbird.io/install.sh | sudo sh",
  ].join(" && ");
  let response = await sandbox.process.executeCommand(
    installCmd,
    undefined,  // cwd
    undefined,  // env
    300         // timeout
  );
  if (response.exitCode !== 0) {
    console.log(`Error installing NetBird: ${response.result}`);
    return;
  }
  console.log("NetBird installed successfully.");

  // Run netbird up in background and capture output to a file
  console.log("\nInitiating NetBird login...");
  await sandbox.process.executeCommand(
    "netbird up > /tmp/netbird-login.txt 2>&1 &",
    undefined,  // cwd
    undefined,  // env
    10          // timeout
  );

  // Wait for the login URL to be written to the file
  await sleep(5000);

  // Read the login URL from the output file
  response = await sandbox.process.executeCommand(
    "cat /tmp/netbird-login.txt",
    undefined,  // cwd
    undefined,  // env
    10          // timeout
  );
  const output = response.result || "";
  const urlMatch = output.match(/https?:\/\/[^\s]+/);

  if (urlMatch) {
    const loginUrl = urlMatch[0];
    console.log("\n" + "=".repeat(60));
    console.log("To authenticate, visit this URL in your browser:");
    console.log(`\n  ${loginUrl}`);
    console.log("\n" + "=".repeat(60));
    console.log("\nWaiting for authentication...");

    // Poll for connection status
    const maxWait = 300; // 5 minutes max wait
    const pollInterval = 5;
    let waited = 0;

    while (waited < maxWait) {
      await sleep(pollInterval * 1000);
      waited += pollInterval;

      const statusResponse = await sandbox.process.executeCommand(
        "netbird status 2>&1",
        undefined,  // cwd
        undefined,  // env
        30          // timeout
      );
      const statusOutput = statusResponse.result || "";

      // Check if we're connected
      if (statusResponse.exitCode === 0 && statusOutput.toLowerCase().includes("connected")) {
        console.log("\nConnected to NetBird network!");
        console.log(`NetBird status:\n${statusOutput}`);
        break;
      }

      console.log(`  Still waiting... (${waited}s)`);
    }

    if (waited >= maxWait) {
      console.log("\nTimeout waiting for authentication. Please try again.");
      return;
    }
  } else {
    // Maybe already connected or different output
    console.log(`Output from netbird up:\n${output}`);

    // Check if already connected
    const statusResponse = await sandbox.process.executeCommand(
      "netbird status",
      undefined,  // cwd
      undefined,  // env
      30          // timeout
    );
    if (statusResponse.exitCode === 0) {
      console.log("\nNetBird status:");
      console.log(statusResponse.result);
    }
  }

  // Final status check
  console.log("\nFinal NetBird status:");
  response = await sandbox.process.executeCommand(
    "netbird status",
    undefined,  // cwd
    undefined,  // env
    30          // timeout
  );
  console.log(response.result);
}

// Run the main function
setupNetbirdVpnInteractive().catch(console.error);
</TabItem> </Tabs>