DevTunnel DevContainer Feature

A DevContainer Feature for installing the Microsoft DevTunnel CLI.

Features

This repository contains the following DevContainer feature:

• devtunnel: Installs the Microsoft DevTunnel CLI for creating secure tunnels to localhost.

What is DevTunnel?

DevTunnel is a Microsoft service that creates secure, ad-hoc connections from the internet to your local development environment. It allows you to:

• Test Webhooks: Receive webhook callbacks from external services (GitHub, Stripe, etc.)
• Share Development Work: Give team members or clients access to your local application
• Test on Remote Devices: Access your local server from mobile devices or other machines
• Collaborate Remotely: Share your development environment without complex network configuration

Usage

To use this feature in your devcontainer, add it to your devcontainer.json:

{
  "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
  "features": {
    "ghcr.io/abeckDev/devtunnel-devcontainer-feature/devtunnel:1": {}
  }
}

With Options

{
  "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
  "features": {
    "ghcr.io/abeckDev/devtunnel-devcontainer-feature/devtunnel:1": {
      "version": "latest"
    }
  }
}

Quick Start

Once the feature is installed in your devcontainer:

1. Login to DevTunnel:

   devtunnel user login

2. Host a tunnel (e.g., for a service running on port 3000):

   devtunnel host -p 3000

3. Allow anonymous access (optional):

   devtunnel host -p 3000 --allow-anonymous

Examples

Check out the examples directory for sample devcontainer configurations:

• Basic Example - Simple setup with DevTunnel CLI

Documentation

For detailed documentation, see:

• Feature Documentation
• Microsoft DevTunnel Overview
• DevTunnel CLI Commands

Supported Platforms

• OS: Debian/Ubuntu-based Linux distributions
• Architectures:
  • amd64 (x86_64)
  • arm64 (aarch64)

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Based on the DevContainer Features specification
• Microsoft DevTunnel CLI: Dev Tunnels Documentation