Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: tunnel support via unjs/untun and cloudflared (experimental) #102

Merged
merged 14 commits into from
Aug 13, 2023

Conversation

pi0
Copy link
Member

@pi0 pi0 commented Aug 12, 2023

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

This PR supports out-of-the-box tunnel support using Cloudflare Tunnel.

Since the cloudflared is a native binary, I have used fantastic work by @JacobLinCool JacobLinCool/cloudflared as base of a fork (main change is that we have no post-install script and only download binary on demand). License added and I hope sometime we can collaborate to move the main package to the mainstream.

Comparing current free tunnel services, Cloudflare has currently the most generous offer. However, I am fully open to supporting other drivers later on via configuration (and set default with the most reliable option).

Update: Moved to newborn unjs/untun

image

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@pi0 pi0 changed the title feat/cloudflare tunnel feat: tunnel support via cloudflared (experimental) Aug 12, 2023
@codecov
Copy link

codecov bot commented Aug 12, 2023

Codecov Report

Merging #102 (b7b3ff0) into main (bd2b5d6) will increase coverage by 0.99%.
Report is 1 commits behind head on main.
The diff coverage is 75.82%.

❗ Current head b7b3ff0 differs from pull request most recent head b05b6ad. Consider uploading reports for the commit b05b6ad to get more accurate results

@@            Coverage Diff             @@
##             main     #102      +/-   ##
==========================================
+ Coverage   49.93%   50.93%   +0.99%     
==========================================
  Files          10       10              
  Lines        1568     1608      +40     
  Branches      108      115       +7     
==========================================
+ Hits          783      819      +36     
- Misses        785      789       +4     
Files Changed Coverage Ξ”
src/_utils.ts 55.42% <66.66%> (-0.68%) ⬇️
src/listen.ts 84.25% <71.62%> (+0.91%) ⬆️
src/lib/open/index.ts 17.83% <100.00%> (+0.18%) ⬆️
src/types.ts 100.00% <100.00%> (ΓΈ)

@pi0 pi0 changed the title feat: tunnel support via cloudflared (experimental) feat: tunnel support via unjs/untun and cloudflared (experimental) Aug 13, 2023
@pi0 pi0 marked this pull request as ready for review August 13, 2023 18:19
@pi0 pi0 merged commit 4592174 into main Aug 13, 2023
2 checks passed
@pi0 pi0 deleted the feat/cloudflare-tunnel branch August 13, 2023 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant