[GH-ISSUE #2777] [Feature Request] include it in npm. done #2221

Closed
opened 2026-05-05 13:25:48 -06:00 by gitea-mirror · 2 comments
Owner

Originally created by @penguine on GitHub (Jan 24, 2022).
Original GitHub issue: https://github.com/fatedier/frp/issues/2777

Describe the feature request

the first version of the embedding in nodejs is available. more detailed APIs are missing for managing via REST.

Originally created by @penguine on GitHub (Jan 24, 2022). Original GitHub issue: https://github.com/fatedier/frp/issues/2777 ### Describe the feature request the first version of the embedding in nodejs is available. more detailed APIs are missing for managing via REST.
gitea-mirror 2026-05-05 13:25:48 -06:00
Author
Owner

@penguine commented on GitHub (Jan 24, 2022):

options we support in the npm version:

s, ngrok documentation for usefull tunnel definition
https://ngrok.com/docs#tunnel-definitions

proto: 'http', // http|tcp|tls, defaults to http
addr: 8080, // port or network address, defaults to 80
auth: 'user:pwd', // http basic authentication for tunnel
subdomain: 'fred', // reserved tunnel name https://fred.ccc.com
authtoken: '12345', // your authtoken from ngrok.com
region: 'us', // one of ngrok regions (us, eu, au, ap, sa, jp, in), defaults to us
configPath: '~/git/project/ngrok.yml', // custom path for ngrok config file
binPath: path => path.replace('app.asar', 'app.asar.unpacked'), // custom binary path, eg for prod in electron
onStatusChange: status => {}, // 'closed' - connection is lost, 'connected' - reconnected
onLogEvent: data => {}, // returns stdout messages from ngrok process
autoReload: true, // reload when init-file was changed

name, inspect, host_header, bind_tls, hostname, crt, key, client_cas, remote_addr.

<!-- gh-comment-id:1020436788 --> @penguine commented on GitHub (Jan 24, 2022): options we support in the npm version: s, ngrok documentation for usefull tunnel definition https://ngrok.com/docs#tunnel-definitions proto: 'http', // http|tcp|tls, defaults to http addr: 8080, // port or network address, defaults to 80 auth: 'user:pwd', // http basic authentication for tunnel subdomain: 'fred', // reserved tunnel name https://fred.ccc.com authtoken: '12345', // your authtoken from ngrok.com region: 'us', // one of ngrok regions (us, eu, au, ap, sa, jp, in), defaults to us configPath: '~/git/project/ngrok.yml', // custom path for ngrok config file binPath: path => path.replace('app.asar', 'app.asar.unpacked'), // custom binary path, eg for prod in electron onStatusChange: status => {}, // 'closed' - connection is lost, 'connected' - reconnected onLogEvent: data => {}, // returns stdout messages from ngrok process autoReload: true, // reload when init-file was changed name, inspect, host_header, bind_tls, hostname, crt, key, client_cas, remote_addr.
Author
Owner

@github-actions[bot] commented on GitHub (Feb 24, 2022):

Issues go stale after 30d of inactivity. Stale issues rot after an additional 7d of inactivity and eventually close.

<!-- gh-comment-id:1049363733 --> @github-actions[bot] commented on GitHub (Feb 24, 2022): Issues go stale after 30d of inactivity. Stale issues rot after an additional 7d of inactivity and eventually close.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/frp#2221
No description provided.