https://github.com/mashkovtsevlx/serverless-cloudflare-tunnel

This Serverless plugin creates a Cloudflare tunnel for your serverless offline endpoints.
https://github.com/mashkovtsevlx/serverless-cloudflare-tunnel

cloudflare serverless serverless-offline serverless-offline-plugin serverless-plugin

Last synced: about 1 month ago
JSON representation

This Serverless plugin creates a Cloudflare tunnel for your serverless offline endpoints.

• Host: GitHub
• URL: https://github.com/mashkovtsevlx/serverless-cloudflare-tunnel
• Owner: mashkovtsevlx
• License: mit
• Created: 2024-05-01T12:51:40.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-08T04:43:36.000Z (about 2 years ago)
• Last Synced: 2025-06-09T12:12:53.393Z (about 1 year ago)
• Topics: cloudflare, serverless, serverless-offline, serverless-offline-plugin, serverless-plugin
• Language: JavaScript
• Homepage:
• Size: 3.91 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Serverless Cloudflare Tunnel

[![serverless](http://public.serverless.com/badges/v3.svg)](https://www.serverless.com)

[![npm version](https://img.shields.io/npm/v/serverless-cloudflare-tunnel?color=brightgreen&label=npm%20package)](https://www.npmjs.com/package/serverless-cloudflare-tunnel)

[![npm downloads](https://img.shields.io/npm/dm/serverless-cloudflare-tunnel)](https://www.npmjs.com/package/serverless-cloudflare-tunnel)

This [Serverless](https://github.com/serverless/serverless) plugin creates a Cloudflare tunnel for your serverless offline endpoints.

## Installation

First, add Serverless Offline to your project:

`npm install serverless-offline --save-dev`

Add serverless-cloudflare-tunnel to your project:

`npm install --save-dev serverless-cloudflare-tunnel`

Add serverless-cloudflare-tunnel to serverless.yml BEFORE serverless-offline:

```

plugins:

  - serverless-cloudflare-tunnel

  - serverless-offline

```

Make sure you have your serverless-offline port set in serverless.yml:

```

custom:

  serverless-offline:

    httpPort: 3005

```

**Usage**

You will be able to see the tunnel URL when you start serverless offline:

```

Cloudflare Tunnel URL set: https://tile-wins-that-tex.trycloudflare.com

```

Also, you'll be able to access CLOUDFLARE_TUNNEL_URL environment variable in your code: `process.env.CLOUDFLARE_TUNNEL_URL`